Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestGetSnapshotInteractions
extends Message

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

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

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

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

create

public static RequestGetSnapshotInteractions create(java.lang.Integer snapshotId,
                                                    java.lang.Integer startFrom,
                                                    java.lang.Integer numberOfInteractions)
Creates instance of RequestGetSnapshotInteractions 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.
startFrom - Zero based index of the first interaction that clients want to be returned.
numberOfInteractions - Number of interactions to be included.
Returns:
instance of RequestGetSnapshotInteractions

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:


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.


getStartFrom

public abstract java.lang.Integer getStartFrom()
Zero-based index of the first interaction that clients want to be returned.


setStartFrom

public abstract void setStartFrom(java.lang.Integer startFrom)
Zero-based index of the first interaction that clients want to be returned.


setStartFrom

public abstract void setStartFrom(int startFrom)
Zero-based index of the first interaction that clients want to be returned.


getNumberOfInteractions

public abstract java.lang.Integer getNumberOfInteractions()
Number of interactions included in the snapshot.


setNumberOfInteractions

public abstract void setNumberOfInteractions(java.lang.Integer numberOfInteractions)
Number of interactions included in the snapshot.


setNumberOfInteractions

public abstract void setNumberOfInteractions(int numberOfInteractions)
Number of interactions included in the snapshot.


getGetIdentifierOnly

public abstract java.lang.Boolean getGetIdentifierOnly()

setGetIdentifierOnly

public abstract void setGetIdentifierOnly(java.lang.Boolean getIdentifierOnly)

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.