Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.interactionserver.events.interactionmanagement
Class EventInteractionsMoved

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

public abstract class EventInteractionsMoved
extends Message

This event provides notification to agent applications that one or more interactions have been moved (or stopped) from a snapshot. A key-value list is returned in the MovedInteractions property, where each key represents an interaction ID with a value of 0 if the move failed (either because of state, or because the interaction was already stopped) or 1 if the move was successful.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventInteractionsMoved create()
          Creates instance of EventInteractionsMoved with no parameters set.
static EventInteractionsMoved create(java.lang.Integer snapshotId)
          Creates instance of EventInteractionsMoved with required parameters set.
static EventInteractionsMoved create(java.lang.Integer proxyClientId, java.lang.Integer snapshotId, KeyValueCollection movedInteractions, KeyValueCollection extension)
          Creates instance of EventInteractionsMoved with all parameters set.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  KeyValueCollection getMovedInteractions()
          Contains list of interaction identifiers (as keys) with specification of the result of the operation: 0 - failed, either because of state or because it's already stopped; 1 - moved (or stopped).
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 setMovedInteractions(KeyValueCollection movedInteractions)
          Contains list of interaction identifiers (as keys) with specification of the result of the operation: 0 - failed, either because of state or because it's already stopped; 1 - moved (or stopped).
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 EventInteractionsMoved create()
Creates instance of EventInteractionsMoved with no parameters set.

Returns:
instance of EventInteractionsMoved

create

public static EventInteractionsMoved create(java.lang.Integer proxyClientId,
                                            java.lang.Integer snapshotId,
                                            KeyValueCollection movedInteractions,
                                            KeyValueCollection extension)
Creates instance of EventInteractionsMoved 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.
movedInteractions - Contains list of interaction identifiers (as keys) with specification of the result of the operation: 0 - failed (either because of state or because it's already stopped), 1 - moved (or stopped). If this attribute is absent, the list is empty.
extension - Extensions.
Returns:
instance of EventInteractionsMoved

create

public static EventInteractionsMoved create(java.lang.Integer snapshotId)
Creates instance of EventInteractionsMoved 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.
Returns:
instance of EventInteractionsMoved

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.


getMovedInteractions

public abstract KeyValueCollection getMovedInteractions()
Contains list of interaction identifiers (as keys) with specification of the result of the operation: 0 - failed, either because of state or because it's already stopped; 1 - moved (or stopped). If this attribute is absent, the list is empty.


setMovedInteractions

public abstract void setMovedInteractions(KeyValueCollection movedInteractions)
Contains list of interaction identifiers (as keys) with specification of the result of the operation: 0 - failed, either because of state or because it's already stopped; 1 - moved (or stopped). If this attribute is absent, the list is empty.


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.