Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.interactionserver.events
Class EventSnapshotTaken

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

public abstract class EventSnapshotTaken
extends Message

With this event, Interaction Server sends an agent application a list of attributes that describe the interactions in a specified snapshot.

Direction: From Interaction Server to agent application.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventSnapshotTaken create()
          Creates instance of EventSnapshotTaken with no parameters set.
static EventSnapshotTaken create(java.lang.Integer snapshotId, java.lang.Integer numberOfInteractions)
          Creates instance of EventSnapshotTaken with required parameters set.
static EventSnapshotTaken create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.Integer snapshotId, java.lang.Integer numberOfInteractions, java.lang.Boolean haveMoreInteractions)
          Creates instance of EventSnapshotTaken with all parameters set.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  java.lang.Boolean getHaveMoreInteractions()
          If absent, the default value is false.
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  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setHaveMoreInteractions(java.lang.Boolean haveMoreInteractions)
          If absent, the default value is false.
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.
 
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 EventSnapshotTaken create()
Creates instance of EventSnapshotTaken with no parameters set.

Returns:
instance of EventSnapshotTaken

create

public static EventSnapshotTaken create(java.lang.Integer proxyClientId,
                                        KeyValueCollection extension,
                                        java.lang.Integer snapshotId,
                                        java.lang.Integer numberOfInteractions,
                                        java.lang.Boolean haveMoreInteractions)
Creates instance of EventSnapshotTaken 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.
numberOfInteractions - Number of interactions to be included.
haveMoreInteractions - Non-zero value indicates that not all the interactions that satisfy snapshot conditions have been included in the snapshot. Interaction Server has a limit on the number of interactions a single snapshot may include. If absent, default value is zero.
Returns:
instance of EventSnapshotTaken

create

public static EventSnapshotTaken create(java.lang.Integer snapshotId,
                                        java.lang.Integer numberOfInteractions)
Creates instance of EventSnapshotTaken 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.
numberOfInteractions - Number of interactions to be included.
Returns:
instance of EventSnapshotTaken

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.


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.


getHaveMoreInteractions

public abstract java.lang.Boolean getHaveMoreInteractions()
If absent, the default value is false. A true value indicates that not all the interactions that satisfy the snapshot's conditions have been included in the snapshot. The number of interactions that a single snapshot can include is limited by Interaction Server's max-interactions-per-snapshot option.


setHaveMoreInteractions

public abstract void setHaveMoreInteractions(java.lang.Boolean haveMoreInteractions)
If absent, the default value is false. A true value indicates that not all the interactions that satisfy the snapshot's conditions have been included in the snapshot. The number of interactions that a single snapshot can include is limited by Interaction Server's max-interactions-per-snapshot option.


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.