|
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.RequestTakeSnapshot
public abstract class RequestTakeSnapshot
With this request, an agent application asks Interaction Server to take
a snapshot; that is, to capture a list of all interactions that meet certain conditions.
To do this, it generates an SQL SELECT statement that retrieves data from the interactions
table. The maximum number of interactions in a snapshot is specified by the Interaction
Server max-interactions-per-snapshot option, or by setting the optional SnapshotMaxInteractions parameter.
Direction: From agent application to Interaction Server.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestTakeSnapshot |
create()
Creates instance of RequestTakeSnapshot with no parameters set. |
static RequestTakeSnapshot |
create(java.lang.Boolean lock)
Creates instance of RequestTakeSnapshot with required parameters set. |
static RequestTakeSnapshot |
create(java.lang.Integer proxyClientId,
KeyValueCollection extension,
java.lang.String viewId,
java.lang.String condition,
java.lang.String order,
java.lang.Boolean lock,
java.lang.Boolean checkInteractionsState,
java.lang.Integer snapshotId,
java.lang.Integer snapshotMaxInteractions)
Creates instance of RequestTakeSnapshot with all parameters set. |
abstract java.lang.Boolean |
getCheckInteractionsState()
Default value is 1. |
abstract java.lang.String |
getCondition()
Specifies conditions for the snapshot. |
abstract KeyValueCollection |
getExtension()
A key-value list of extensions. |
abstract java.lang.Boolean |
getLock()
Possible values: 0 (zero)-Interactions in this snapshot are not locked. Any nonzero value-Interactions in this snapshot are locked. While an interaction is locked, it cannot be submitted to a routing strategy and therefore it cannot move to any other queue or workbin. |
abstract java.lang.String |
getOrder()
Specifies the order of interactions 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 |
getSnapshotMaxInteractions()
Specifies the maximum number of interactions in a snapshot |
abstract java.lang.String |
getViewId()
Identifier of the view to pull interactions from. |
abstract void |
setCheckInteractionsState(java.lang.Boolean checkInteractionsState)
Default value is 1. |
abstract void |
setCondition(java.lang.String condition)
Specifies conditions for the snapshot. |
abstract void |
setExtension(KeyValueCollection extension)
A key-value list of extensions. |
abstract void |
setLock(java.lang.Boolean lock)
Possible values: 0 (zero)-Interactions in this snapshot are not locked. Any nonzero value-Interactions in this snapshot are locked. While an interaction is locked, it cannot be submitted to a routing strategy and therefore it cannot move to any other queue or workbin. |
abstract void |
setOrder(java.lang.String order)
Specifies the order of interactions 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 |
setSnapshotMaxInteractions(int snapshotMaxInteractions)
Specifies the maximum number of interactions in a snapshot |
abstract void |
setSnapshotMaxInteractions(java.lang.Integer snapshotMaxInteractions)
Specifies the maximum number of interactions in a snapshot |
abstract void |
setViewId(java.lang.String viewId)
Identifier of the view to pull interactions from. |
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 RequestTakeSnapshot create()
public static RequestTakeSnapshot create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String viewId, java.lang.String condition, java.lang.String order, java.lang.Boolean lock, java.lang.Boolean checkInteractionsState, java.lang.Integer snapshotId, java.lang.Integer snapshotMaxInteractions)
proxyClientId
- The identifier of the client of proxy.extension
- Extensions.viewId
- Existing view name. Instead of specifying custom condition for the snapshot, it is possible to instruct Interaction Server to use the same condition as the specified view has.condition
- Specifies condition for the snapshot. Snapshot conditions are added to 'where' clause of the SQL 'select' statement generated by Interaction Server. It is possible to use Interaction Server database filed names, interaction property names, custom property names and functions provided by Interaction Server in condition. Property names are automatically translated to correspondent field names.order
- Specifies order of interactions in the snapshot. If not specified, default order is 'received_at, id'. Snapshot orders are added to 'order by' clause of the SQL 'select' statement generated by Interaction Server. It is possible to use interaction property names and custom property names in order. Property names are automatically translated to field names.lock
- Non-zero value indicates to Interaction Server that interactions that are selected into the snapshot should be locked. Only queued interactions can be locked. If interaction can not be locked by Interaction Server it is still included in snapshot, but the lock is not placed on the interaction. If interaction is locked, it is not submitted into strategy as it would in the normal course of workflow processing.checkInteractionsState
- Zero value indicates that Interaction Server should include interactions in any states into the snapshot. Non-zero value indicates that only queued interactions should be included. Default value is 1.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.snapshotMaxInteractions
- [optional] specifies the maximum number of interactions that will be included in the snapshot.
public static RequestTakeSnapshot create(java.lang.Boolean lock)
lock
- Non-zero value indicates to Interaction Server that interactions that are selected into the snapshot should be locked. Only queued interactions can be locked. If interaction can not be locked by Interaction Server it is still included in snapshot, but the lock is not placed on the interaction. If interaction is locked, it is not submitted into strategy as it would in the normal course of workflow processing.
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.String getViewId()
public abstract void setViewId(java.lang.String viewId)
public abstract java.lang.String getCondition()
public abstract void setCondition(java.lang.String condition)
public abstract java.lang.String getOrder()
public abstract void setOrder(java.lang.String order)
public abstract java.lang.Boolean getLock()
public abstract void setLock(java.lang.Boolean lock)
public abstract java.lang.Boolean getCheckInteractionsState()
public abstract void setCheckInteractionsState(java.lang.Boolean checkInteractionsState)
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 getSnapshotMaxInteractions()
public abstract void setSnapshotMaxInteractions(java.lang.Integer snapshotMaxInteractions)
public abstract void setSnapshotMaxInteractions(int snapshotMaxInteractions)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |