Platform SDK Java 8.5 API Reference

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

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

public abstract class EventInteractionsFound
extends Message

The event is used to respond to the request RequestFindInteractions.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventInteractionsFound create()
          Creates instance of EventInteractionsFound with no parameters set.
static EventInteractionsFound create(java.lang.Integer proxyClientId, KeyValueCollection extension, KeyValueCollection interactions, java.lang.Boolean haveMoreInteractions)
          Creates instance of EventInteractionsFound 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  KeyValueCollection getInteractions()
          List containing interaction data.
abstract  java.lang.Integer getProxyClientId()
          Proxy client identifier.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
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 setInteractions(KeyValueCollection interactions)
          List containing interaction data.
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.
 
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 EventInteractionsFound create()
Creates instance of EventInteractionsFound with no parameters set.

Returns:
instance of EventInteractionsFound

create

public static EventInteractionsFound create(java.lang.Integer proxyClientId,
                                            KeyValueCollection extension,
                                            KeyValueCollection interactions,
                                            java.lang.Boolean haveMoreInteractions)
Creates instance of EventInteractionsFound with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
extension - Extensions.
interactions - Key-value list that contains interaction data. Each key in the list is an interaction identifier. Values are key-value lists that contain interaction properties.
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 EventInteractionsFound

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:


getInteractions

public abstract KeyValueCollection getInteractions()
List containing interaction data. Each key in the list is an interaction identifier. Values are key-value lists that contain interaction properties.


setInteractions

public abstract void setInteractions(KeyValueCollection interactions)
List containing interaction data. Each key in the list is an interaction identifier. Values are key-value lists that contain interaction properties.


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.