Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestGetInteractionProperties
extends Message

The purpose is to provide the ability for the client to get interaction properties by external id instead of interaction id.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestGetInteractionProperties create()
          Creates instance of RequestGetInteractionProperties with no parameters set.
static RequestGetInteractionProperties create(java.lang.String interactionId)
          Creates instance of RequestGetInteractionProperties.
static RequestGetInteractionProperties create(java.lang.String interactionId, java.lang.Integer proxyClientId, java.lang.Boolean searchByExternalId)
          Deprecated. use other create methods
static RequestGetInteractionProperties create(java.lang.String interactionId, java.lang.Integer proxyClientId, java.lang.Boolean searchByExternalId, KeyValueCollection extension)
          Creates instance of RequestGetInteractionProperties.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  java.lang.String getInteractionId()
          Identifier of the interaction being accepted.
abstract  java.lang.Integer getProxyClientId()
          Proxy client identifier.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  java.lang.Boolean getSearchByExternalId()
          [optional; default is 'false'] 'true' value indicates that attr_itx_id of the request should be interpreted as external id instead of interaction id.
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setInteractionId(java.lang.String interactionId)
          Identifier of the interaction being accepted.
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 setSearchByExternalId(java.lang.Boolean searchByExternalId)
          [optional; default is 'false'] 'true' value indicates that attr_itx_id of the request should be interpreted as external id instead of interaction id.
 
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 RequestGetInteractionProperties create()
Creates instance of RequestGetInteractionProperties with no parameters set.

Returns:
instance of RequestGetInteractionProperties

create

public static RequestGetInteractionProperties create(java.lang.String interactionId,
                                                     java.lang.Integer proxyClientId,
                                                     java.lang.Boolean searchByExternalId)
Deprecated. use other create methods

Creates instance of RequestGetInteractionProperties.

Parameters:
interactionId - Interaction identifier.
proxyClientId - The identifier of the client of proxy.
searchByExternalId - [optional; default is 'false'] 'true' value indicates that attr_itx_id of the request should be interpreted as external id instead of interaction id.
Returns:
instance of RequestGetInteractionProperties

create

public static RequestGetInteractionProperties create(java.lang.String interactionId)
Creates instance of RequestGetInteractionProperties.

Parameters:
interactionId - Interaction identifier.
Returns:
instance of RequestGetInteractionProperties

create

public static RequestGetInteractionProperties create(java.lang.String interactionId,
                                                     java.lang.Integer proxyClientId,
                                                     java.lang.Boolean searchByExternalId,
                                                     KeyValueCollection extension)
Creates instance of RequestGetInteractionProperties.

Parameters:
interactionId - Interaction identifier.
proxyClientId - The identifier of the client of proxy.
searchByExternalId - [optional; default is 'false'] 'true' value indicates that attr_itx_id of the request should be interpreted as external id instead of interaction id.
extension - Extensions.
Returns:
instance of RequestGetInteractionProperties

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.


getInteractionId

public abstract java.lang.String getInteractionId()
Identifier of the interaction being accepted.


setInteractionId

public abstract void setInteractionId(java.lang.String interactionId)
Identifier of the interaction being accepted.


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.


getSearchByExternalId

public abstract java.lang.Boolean getSearchByExternalId()
[optional; default is 'false'] 'true' value indicates that attr_itx_id of the request should be interpreted as external id instead of interaction id.

Returns:
property value

setSearchByExternalId

public abstract void setSearchByExternalId(java.lang.Boolean searchByExternalId)
[optional; default is 'false'] 'true' value indicates that attr_itx_id of the request should be interpreted as external id instead of interaction id.

Parameters:
searchByExternalId - new value of the property

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.