|
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.EventSnapshotTaken
public abstract class EventSnapshotTaken
With this event, Interaction Server sends an agent application a list of
attributes that describe the interactions in a specified snapshot.
Direction: From Interaction Server to agent application.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static EventSnapshotTaken |
create()
Creates instance of EventSnapshotTaken with no parameters set. |
static EventSnapshotTaken |
create(java.lang.Integer snapshotId,
java.lang.Integer numberOfInteractions)
Creates instance of EventSnapshotTaken with required parameters set. |
static EventSnapshotTaken |
create(java.lang.Integer proxyClientId,
KeyValueCollection extension,
java.lang.Integer snapshotId,
java.lang.Integer numberOfInteractions,
java.lang.Boolean haveMoreInteractions)
Creates instance of EventSnapshotTaken with all parameters set. |
abstract KeyValueCollection |
getExtension()
A key-value list of extensions. |
abstract java.lang.Boolean |
getHaveMoreInteractions()
If absent, the default value is false. |
abstract java.lang.Integer |
getNumberOfInteractions()
Number of interactions included in the snapshot. |
abstract java.lang.Integer |
getProxyClientId()
Proxy client identifier. |
abstract java.lang.Integer |
getReferenceId()
Reference identifier of the request. |
abstract java.lang.Integer |
getSnapshotId()
If specified, must be the identifier of a snapshot that the client has taken previously. |
abstract void |
setExtension(KeyValueCollection extension)
A key-value list of extensions. |
abstract void |
setHaveMoreInteractions(java.lang.Boolean haveMoreInteractions)
If absent, the default value is false. |
abstract void |
setNumberOfInteractions(int numberOfInteractions)
Number of interactions included in the snapshot. |
abstract void |
setNumberOfInteractions(java.lang.Integer numberOfInteractions)
Number of interactions included in the snapshot. |
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 |
setSnapshotId(int snapshotId)
If specified, must be the identifier of a snapshot that the client has taken previously. |
abstract void |
setSnapshotId(java.lang.Integer snapshotId)
If specified, must be the identifier of a snapshot that the client has taken previously. |
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 EventSnapshotTaken create()
public static EventSnapshotTaken create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.Integer snapshotId, java.lang.Integer numberOfInteractions, java.lang.Boolean haveMoreInteractions)
proxyClientId
- The identifier of the client of proxy.extension
- Extensions.snapshotId
- If specified, should represent an identifier of the snapshot that client has taken before. The new snapshot will inherit all the locks that the older snapshot held. The identifier of the new snapshot is the same as the old snapshot. Old snapshot is automatically released.numberOfInteractions
- Number of interactions to be included.haveMoreInteractions
- Non-zero value indicates that not all the interactions that satisfy snapshot conditions have been included in the snapshot. Interaction Server has a limit on the number of interactions a single snapshot may include. If absent, default value is zero.
public static EventSnapshotTaken create(java.lang.Integer snapshotId, java.lang.Integer numberOfInteractions)
snapshotId
- If specified, should represent an identifier of the snapshot that client has taken before. The new snapshot will inherit all the locks that the older snapshot held. The identifier of the new snapshot is the same as the old snapshot. Old snapshot is automatically released.numberOfInteractions
- Number of interactions to be included.
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 KeyValueCollection getExtension()
public abstract void setExtension(KeyValueCollection extension)
public abstract java.lang.Integer getSnapshotId()
public abstract void setSnapshotId(java.lang.Integer snapshotId)
public abstract void setSnapshotId(int snapshotId)
public abstract java.lang.Integer getNumberOfInteractions()
public abstract void setNumberOfInteractions(java.lang.Integer numberOfInteractions)
public abstract void setNumberOfInteractions(int numberOfInteractions)
public abstract java.lang.Boolean getHaveMoreInteractions()
public abstract void setHaveMoreInteractions(java.lang.Boolean haveMoreInteractions)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |