Platform SDK Java 8.5 API Reference

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

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.RequestMoveInteractions
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestMoveInteractions
extends Message

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

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 RequestMoveInteractions create()
Creates instance of RequestMoveInteractions with no parameters set.

Returns:
instance of RequestMoveInteractions

create

public 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.

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

create

public static RequestMoveInteractions create(java.lang.Integer snapshotId,
                                             java.lang.String queue)
Creates instance of RequestMoveInteractions with required parameters set.

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

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.


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.


getQueue

public abstract java.lang.String getQueue()
Name of the queue that the interaction was in previously. If this attribute has the same value as the Interaction attribute InteractionQueue, this indicates that the interaction has been returned to the same queue as before.


setQueue

public abstract void setQueue(java.lang.String queue)
Name of the queue that the interaction was in previously. If this attribute has the same value as the Interaction attribute InteractionQueue, this indicates that the interaction has been returned to the same queue as before.


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:


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.