|
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.RequestMoveInteractions
public abstract class RequestMoveInteractions
Note: This request is only designed for use with RequestTakeSnapshot, and will only
work in the context of an existing snapshot.
This request should be used to move interactions from a snapshot, because it prevents any problems from occurring if the interaction
had changed state since the snapshot was taken. While moving or stopping interactions, Interaction Server will distribute all the
usual reporting events such as EventTakenFromQueue or EventPlacedInQueue.
The expected response for this request is either EventInteractionMoved if the request was successful, or EventError if
any problem occurred.
Direction: From agent application to Interaction Server
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestMoveInteractions |
create()
Creates instance of RequestMoveInteractions with no parameters set. |
static RequestMoveInteractions |
create(java.lang.Integer proxyClientId,
java.lang.Integer snapshotId,
java.lang.String queue,
KeyValueCollection extension)
Creates instance of RequestMoveInteractions with all parameters set. |
static RequestMoveInteractions |
create(java.lang.Integer snapshotId,
java.lang.String queue)
Creates instance of RequestMoveInteractions with required parameters set. |
abstract KeyValueCollection |
getExtension()
A key-value list of extensions. |
abstract java.lang.Integer |
getProxyClientId()
Proxy client identifier. |
abstract java.lang.String |
getQueue()
Name of the queue that the interaction was in previously. |
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 |
setProxyClientId(int proxyClientId)
Proxy client identifier. |
abstract void |
setProxyClientId(java.lang.Integer proxyClientId)
Proxy client identifier. |
abstract void |
setQueue(java.lang.String queue)
Name of the queue that the interaction was in previously. |
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 RequestMoveInteractions create()
public static RequestMoveInteractions create(java.lang.Integer proxyClientId, java.lang.Integer snapshotId, java.lang.String queue, KeyValueCollection extension)
proxyClientId
- The identifier of the client of proxy.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.queue
- Queue name to submit interaction into. The queue should be configured for the tenant.extension
- Extensions.
public static RequestMoveInteractions create(java.lang.Integer snapshotId, java.lang.String queue)
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.queue
- Queue name to submit interaction into. The queue should be configured for the tenant.
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.lang.Integer getSnapshotId()
public abstract void setSnapshotId(java.lang.Integer snapshotId)
public abstract void setSnapshotId(int snapshotId)
public abstract java.lang.String getQueue()
public abstract void setQueue(java.lang.String queue)
public 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 |