|
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.requests.interactionmanagement.RequestGetSnapshotInteractions
public abstract class RequestGetSnapshotInteractions
With this request, an agent application asks for a list of the interactions
in a previously-taken snapshot. The request can specify how many interactions to include in
the list. This list can be used by the agent (or supervisor) application to scroll through
the interactions included in the snapshot.
Direction: From agent application to Interaction Server
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestGetSnapshotInteractions |
create()
Creates instance of RequestGetSnapshotInteractions with no parameters set. |
static RequestGetSnapshotInteractions |
create(java.lang.Integer snapshotId,
java.lang.Integer startFrom,
java.lang.Integer numberOfInteractions)
Creates instance of RequestGetSnapshotInteractions with required parameters set. |
static RequestGetSnapshotInteractions |
create(java.lang.Integer proxyClientId,
KeyValueCollection extension,
java.lang.Integer snapshotId,
java.lang.Integer startFrom,
java.lang.Integer numberOfInteractions,
java.lang.Boolean getIdentifierOnly)
Creates instance of RequestGetSnapshotInteractions with all parameters set. |
abstract KeyValueCollection |
getExtension()
A key-value list of extensions. |
abstract java.lang.Boolean |
getGetIdentifierOnly()
|
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 java.lang.Integer |
getStartFrom()
Zero-based index of the first interaction that clients want to be returned. |
abstract void |
setExtension(KeyValueCollection extension)
A key-value list of extensions. |
abstract void |
setGetIdentifierOnly(java.lang.Boolean getIdentifierOnly)
|
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. |
abstract void |
setStartFrom(int startFrom)
Zero-based index of the first interaction that clients want to be returned. |
abstract void |
setStartFrom(java.lang.Integer startFrom)
Zero-based index of the first interaction that clients want to be returned. |
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 RequestGetSnapshotInteractions create()
public static RequestGetSnapshotInteractions create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.Integer snapshotId, java.lang.Integer startFrom, java.lang.Integer numberOfInteractions, java.lang.Boolean getIdentifierOnly)
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.startFrom
- Zero based index of the first interaction that clients want to be returned.numberOfInteractions
- Number of interactions to be included.getIdentifierOnly
- GetIdentifierOnly
public static RequestGetSnapshotInteractions create(java.lang.Integer snapshotId, java.lang.Integer startFrom, 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.startFrom
- Zero based index of the first interaction that clients want to be returned.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 getStartFrom()
public abstract void setStartFrom(java.lang.Integer startFrom)
public abstract void setStartFrom(int startFrom)
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 getGetIdentifierOnly()
public abstract void setGetIdentifierOnly(java.lang.Boolean getIdentifierOnly)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |