@RemoteServiceRelativePath(value="gwteventservice") public interface EventService extends RemoteService
Modifier and Type | Method and Description |
---|---|
void |
addEvent(Domain aDomain,
Event anEvent)
Adds an event for all users in the domain.
|
void |
addEventUserSpecific(Event anEvent)
Adds an event only for the current user.
|
void |
deregisterEventFilter(Domain aDomain)
Deregisters the
EventFilter of the domain. |
Set<Domain> |
getActiveListenDomains()
Returns the domain names, where the user is listening to
|
EventFilter |
getEventFilter(Domain aDomain)
Returns the EventFilter for the user domain combination.
|
EventServiceConfigurationTransferable |
initEventService()
Initializes the
EventService . |
boolean |
isUserRegistered(Domain aDomain)
Checks if the user is registered for event listening.
|
List<DomainEvent> |
listen()
The listen method returns all events for the user (events for all domains where the user is registered and user
specific events).
|
void |
register(Domain aDomain)
Register listen for a domain.
|
void |
register(Domain aDomain,
EventFilter anEventFilter)
Register listen for a domain.
|
void |
register(Set<Domain> aDomains)
Register listen for a domain.
|
void |
register(Set<Domain> aDomains,
EventFilter anEventFilter)
Register listen for domains.
|
void |
registerEventFilter(Domain aDomain,
EventFilter anEventFilter)
Registers an
EventFilter for the domain. |
void |
registerUnlistenEvent(UnlistenEventListener.Scope anUnlistenScope,
UnlistenEvent anUnlistenEvent)
Registers an
UnlistenEvent which is triggered on a
timeout or when a user/client leaves a Domain . |
void |
unlisten()
Unlisten for events (for the current user) in all domains (deregisters the user from all domains).
|
void |
unlisten(Domain aDomain)
Unlisten for events
|
void |
unlisten(Set<Domain> aDomains)
Unlisten for events (for the current user) in the domains and deregisters the user from the domains.
|
EventServiceConfigurationTransferable initEventService()
EventService
.void register(Domain aDomain)
aDomain
- domain to listen tovoid register(Domain aDomain, EventFilter anEventFilter)
aDomain
- domain to listen toanEventFilter
- EventFilter to filter eventsvoid register(Set<Domain> aDomains)
aDomains
- domains to listen tovoid register(Set<Domain> aDomains, EventFilter anEventFilter)
aDomains
- domains to listen toanEventFilter
- EventFilter to filter events (applied to all domains)void registerUnlistenEvent(UnlistenEventListener.Scope anUnlistenScope, UnlistenEvent anUnlistenEvent)
UnlistenEvent
which is triggered on a
timeout or when a user/client leaves a Domain
. An
UnlistenEvent
is hold at the server side and can
contain custom data. Other users/clients can use the custom data when the event is for example triggered by a timeout.anUnlistenScope
- scope of the unlisten events to receiveanUnlistenEvent
- UnlistenEvent
which should
be transferred to other users/clients when a timeout occurs or a domain is leaved.void registerEventFilter(Domain aDomain, EventFilter anEventFilter)
EventFilter
for the domain.aDomain
- domain to register the EventFilter toanEventFilter
- EventFilter to filter events for the domainvoid deregisterEventFilter(Domain aDomain)
EventFilter
of the domain.aDomain
- domain to drop the EventFilters fromEventFilter getEventFilter(Domain aDomain)
aDomain
- domainList<DomainEvent> listen()
void unlisten()
void unlisten(Domain aDomain)
aDomain
- the domain to unlistenvoid unlisten(Set<Domain> aDomains)
aDomains
- set of domains to unlistenboolean isUserRegistered(Domain aDomain)
aDomain
- domain to checkvoid addEvent(Domain aDomain, Event anEvent)
aDomain
- domain to add the eventanEvent
- event to addvoid addEventUserSpecific(Event anEvent)
anEvent
- event to add to the userSet<Domain> getActiveListenDomains()
Copyright © 2012. All Rights Reserved.