Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.interactionserver.requests.interactionmanagement
Class RequestTakeSnapshot

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.openmedia.protocol.interactionserver.requests.interactionmanagement.RequestTakeSnapshot
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestTakeSnapshot
extends Message

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

ID

public static final int ID
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values
Method Detail

create

public static RequestTakeSnapshot create()
Creates instance of RequestTakeSnapshot with no parameters set.

Returns:
instance of 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)
Creates instance of RequestTakeSnapshot with all parameters set.

Parameters:
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.
Returns:
instance of RequestTakeSnapshot

create

public static RequestTakeSnapshot create(java.lang.Boolean lock)
Creates instance of RequestTakeSnapshot with required parameters set.

Parameters:
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.
Returns:
instance of RequestTakeSnapshot

getReferenceId

public abstract java.lang.Integer getReferenceId()
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


setReferenceId

public abstract void setReferenceId(int referenceId)
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


getProxyClientId

public abstract java.lang.Integer getProxyClientId()
Proxy client identifier. Mandatory if client connects via proxy.


setProxyClientId

public abstract void setProxyClientId(java.lang.Integer proxyClientId)
Proxy client identifier. Mandatory if client connects via proxy.


setProxyClientId

public abstract void setProxyClientId(int proxyClientId)
Proxy client identifier. Mandatory if client connects via proxy.


getExtension

public abstract KeyValueCollection getExtension()
A key-value list of extensions. For media servers the following extensions are defined, with values of type integer:


setExtension

public abstract void setExtension(KeyValueCollection extension)
A key-value list of extensions. For media servers the following extensions are defined, with values of type integer:


getViewId

public abstract java.lang.String getViewId()
Identifier of the view to pull interactions from. The view should be defined for the tenant. The special _system_ view allows pulling of the specific interaction by its identifier.


setViewId

public abstract void setViewId(java.lang.String viewId)
Identifier of the view to pull interactions from. The view should be defined for the tenant. The special _system_ view allows pulling of the specific interaction by its identifier.


getCondition

public abstract java.lang.String getCondition()
Specifies conditions for the snapshot. These conditions are added to the WHERE clause of the SQL SELECT statement that Interaction Server generates. Conditions can use Interaction Server database field names, interaction property names, custom property names, and translation functions. Interaction property names are converted to field names; for some explanation of the relations among these, see the chapter on interaction properties in the Multimedia 7.6 User's Guide.

Ordinarily, either this attribute or ViewId is present. If both are absent, the snapshot lists all interactions in the Interaction Server database.


setCondition

public abstract void setCondition(java.lang.String condition)
Specifies conditions for the snapshot. These conditions are added to the WHERE clause of the SQL SELECT statement that Interaction Server generates. Conditions can use Interaction Server database field names, interaction property names, custom property names, and translation functions. Interaction property names are converted to field names; for some explanation of the relations among these, see the chapter on interaction properties in the Multimedia 7.6 User's Guide.

Ordinarily, either this attribute or ViewId is present. If both are absent, the snapshot lists all interactions in the Interaction Server database.


getOrder

public abstract java.lang.String getOrder()
Specifies the order of interactions in the snapshot. This ordering specification is added to the ORDER BY clause of the SQL SELECT statement that Interaction Server generates. Ordering can use interaction property names and custom property names. Property names are converted to field names.

If no order is specified, the default order is first by ReceivedAt, then by InteractionId.


setOrder

public abstract void setOrder(java.lang.String order)
Specifies the order of interactions in the snapshot. This ordering specification is added to the ORDER BY clause of the SQL SELECT statement that Interaction Server generates. Ordering can use interaction property names and custom property names. Property names are converted to field names.

If no order is specified, the default order is first by ReceivedAt, then by InteractionId.


getLock

public abstract java.lang.Boolean getLock()
Possible values: While an interaction is locked, it cannot be submitted to a routing strategy and therefore it cannot move to any other queue or workbin. Only queued interactions can be locked. If an interaction cannot be locked, it is still included in the snapshot (but it remains unlocked).


setLock

public abstract void setLock(java.lang.Boolean lock)
Possible values: While an interaction is locked, it cannot be submitted to a routing strategy and therefore it cannot move to any other queue or workbin. Only queued interactions can be locked. If an interaction cannot be locked, it is still included in the snapshot (but it remains unlocked).


getCheckInteractionsState

public abstract java.lang.Boolean getCheckInteractionsState()
Default value is 1. Possible values:


setCheckInteractionsState

public abstract void setCheckInteractionsState(java.lang.Boolean checkInteractionsState)
Default value is 1. Possible values:


getSnapshotId

public abstract java.lang.Integer getSnapshotId()
If specified, must be the identifier of a snapshot that the client has taken previously. The new snapshot inherits all the locks that the older snapshot held. The new snapshot takes on the identifier of the old snapshot, and the old snapshot is released.


setSnapshotId

public abstract void setSnapshotId(java.lang.Integer snapshotId)
If specified, must be the identifier of a snapshot that the client has taken previously. The new snapshot inherits all the locks that the older snapshot held. The new snapshot takes on the identifier of the old snapshot, and the old snapshot is released.


setSnapshotId

public abstract void setSnapshotId(int snapshotId)
If specified, must be the identifier of a snapshot that the client has taken previously. The new snapshot inherits all the locks that the older snapshot held. The new snapshot takes on the identifier of the old snapshot, and the old snapshot is released.


getSnapshotMaxInteractions

public abstract java.lang.Integer getSnapshotMaxInteractions()
Specifies the maximum number of interactions in a snapshot


setSnapshotMaxInteractions

public abstract void setSnapshotMaxInteractions(java.lang.Integer snapshotMaxInteractions)
Specifies the maximum number of interactions in a snapshot


setSnapshotMaxInteractions

public abstract void setSnapshotMaxInteractions(int snapshotMaxInteractions)
Specifies the maximum number of interactions in a snapshot


Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.