|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.openmedia.protocol.interactionserver.events.EventHint
public abstract class EventHint
The purpose of the event is to advise a client about certain conditions.The client may choose to react or ignore the hint. In particular, this event is used to advise Stat Server about massive logout event due to proxy disconnect.A pair of events indicates the beginning and the end of the condition.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static EventHint |
create()
Creates instance of EventHint with no parameters set. |
static EventHint |
create(java.lang.Integer proxyClientId,
KeyValueCollection extension,
java.util.Date eventTime,
java.lang.String hint,
java.lang.Integer conditionStarting)
Creates instance of EventHint with all parameters set. |
abstract java.lang.Integer |
getConditionStarting()
[optional] 0 - indicates the end of the condition. |
abstract java.util.Date |
getEventTime()
Date and time of the event. |
abstract KeyValueCollection |
getExtension()
A key-value list of extensions. |
abstract java.lang.String |
getHint()
[mandatory] The name (unique identifier) of the condition |
abstract java.lang.Integer |
getProxyClientId()
Proxy client identifier. |
abstract void |
setConditionStarting(int conditionStarting)
[optional] 0 - indicates the end of the condition. |
abstract void |
setConditionStarting(java.lang.Integer conditionStarting)
[optional] 0 - indicates the end of the condition. |
abstract void |
setEventTime(java.util.Date eventTime)
Date and time of the event. |
abstract void |
setExtension(KeyValueCollection extension)
A key-value list of extensions. |
abstract void |
setHint(java.lang.String hint)
[mandatory] The name (unique identifier) of the condition |
abstract void |
setProxyClientId(int proxyClientId)
Proxy client identifier. |
abstract void |
setProxyClientId(java.lang.Integer proxyClientId)
Proxy client identifier. |
Methods inherited from class com.genesyslab.platform.commons.protocol.Message |
---|
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName, setProtocolDescription |
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject |
---|
equals, hashCode, toString, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static EventHint create()
public static EventHint create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.util.Date eventTime, java.lang.String hint, java.lang.Integer conditionStarting)
proxyClientId
- The identifier of the client of proxy.extension
- Extensions.eventTime
- Date and time of the event.hint
- [mandatory] The name (unique identifier) of the conditionconditionStarting
- [optional] 0 - indicates the end of the condition. 1 indicates the beginning of the condition. Default 0.
public abstract java.lang.Integer getProxyClientId()
public abstract void setProxyClientId(java.lang.Integer proxyClientId)
public abstract void setProxyClientId(int proxyClientId)
public abstract KeyValueCollection getExtension()
public abstract void setExtension(KeyValueCollection extension)
public abstract java.util.Date getEventTime()
public abstract void setEventTime(java.util.Date eventTime)
public abstract java.lang.String getHint()
public abstract void setHint(java.lang.String hint)
hint
- new value of the propertypublic abstract java.lang.Integer getConditionStarting()
public abstract void setConditionStarting(java.lang.Integer conditionStarting)
conditionStarting
- new value of the propertypublic abstract void setConditionStarting(int conditionStarting)
conditionStarting
- new value of the property
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |