public interface UnlistenEvent extends Event
EventService
when unlisten is called for a user. It will also be returned as an
event (from the listen method) and will be added to the UnlistenDomain DomainFactory.UNLISTEN_DOMAIN
.EventService.unlisten()
,
EventService.unlisten(Domain)
,
EventService.unlisten(java.util.Set)
Modifier and Type | Method and Description |
---|---|
Set<Domain> |
getDomains()
Returns the domain for which isn't listening anymore.
|
String |
getUserId()
Returns the unlistened user id for the UnlistenEvent.
|
boolean |
isLocal()
Returns true when the UnlistenEvent is triggered from the client side.
|
boolean |
isTimeout()
Returns true when the UnlistenEvent is a timeout, otherwise false (for example a domain specific UnlistenEvent).
|
void |
setDomains(Set<Domain> aDomains)
A
Domain can be set to the UnlistenEvent when the unlisten event
is domain specific. |
void |
setLocal(boolean isLocal)
Sets the local flag.
|
void |
setTimeout(boolean aTimeout)
Sets the timeout flag.
|
void |
setUserId(String aUserId)
Sets the unlistened user id for the UnlistenEvent.
|
void setDomains(Set<Domain> aDomains)
Domain
can be set to the UnlistenEvent when the unlisten event
is domain specific.aDomains
- unlistened domainsSet<Domain> getDomains()
void setUserId(String aUserId)
aUserId
- unlistened user idString getUserId()
boolean isTimeout()
void setTimeout(boolean aTimeout)
aTimeout
- true when the UnlistenEvent marks a timeout, otherwise false (for example a domain specific UnlistenEvent)boolean isLocal()
void setLocal(boolean isLocal)
isLocal
- true when triggered from client side, otherwise falseCopyright © 2012. All Rights Reserved.