|
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.EventMessagePing
public abstract class EventMessagePing
Uses for testing purpose.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static EventMessagePing |
create()
Creates instance of EventMessagePing with no parameters set. |
static EventMessagePing |
create(java.util.Date eventTime)
Creates instance of EventMessagePing with required parameters set. |
static EventMessagePing |
create(java.lang.Integer proxyClientId,
java.util.Date eventTime,
KeyValueCollection userData,
KeyValueCollection pingInfo,
KeyValueCollection extension)
Creates instance of EventMessagePing with all parameters set. |
abstract java.util.Date |
getEventTime()
Date and time of the event. |
abstract KeyValueCollection |
getExtension()
A key-value list of extensions. |
abstract KeyValueCollection |
getPingInfo()
Uses for testing purpose. |
abstract java.lang.Integer |
getProxyClientId()
Proxy client identifier. |
abstract java.lang.Integer |
getReferenceId()
Reference identifier of the request. |
abstract KeyValueCollection |
getUserData()
Pointer to any user data that should be attached to the interaction. |
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 |
setPingInfo(KeyValueCollection pingInfo)
Uses for testing purpose. |
abstract void |
setProxyClientId(int proxyClientId)
Proxy client identifier. |
abstract void |
setProxyClientId(java.lang.Integer proxyClientId)
Proxy client identifier. |
abstract void |
setReferenceId(int referenceId)
Reference identifier of the request. |
abstract void |
setReferenceId(java.lang.Integer referenceId)
Reference identifier of the request. |
abstract void |
setUserData(KeyValueCollection userData)
Pointer to any user data that should be attached to the interaction. |
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 EventMessagePing create()
public static EventMessagePing create(java.lang.Integer proxyClientId, java.util.Date eventTime, KeyValueCollection userData, KeyValueCollection pingInfo, KeyValueCollection extension)
proxyClientId
- The identifier of the client of proxy.eventTime
- Date and time of the event.userData
- Any interaction related data.pingInfo
- Uses for testing purpose.extension
- Extensions.
public static EventMessagePing create(java.util.Date eventTime)
eventTime
- Date and time of the event.
public abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract java.lang.Integer getProxyClientId()
public abstract void setProxyClientId(java.lang.Integer proxyClientId)
public abstract void setProxyClientId(int proxyClientId)
public abstract java.util.Date getEventTime()
public abstract void setEventTime(java.util.Date eventTime)
public abstract KeyValueCollection getUserData()
public abstract void setUserData(KeyValueCollection userData)
public abstract KeyValueCollection getPingInfo()
public abstract void setPingInfo(KeyValueCollection pingInfo)
pingInfo
- new value of the propertypublic abstract KeyValueCollection getExtension()
public abstract void setExtension(KeyValueCollection extension)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |