Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestChangeProperties
extends Message

With this request, a media server, agent application, or URS can change the properties of an interaction. There are the following restrictions:

Direction: From client to Interaction Server.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestChangeProperties create()
          Creates instance of RequestChangeProperties with no parameters set.
static RequestChangeProperties create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String interactionId, KeyValueCollection addedProperties, KeyValueCollection changedProperties, KeyValueCollection deletedProperties, java.lang.String queue)
          Creates instance of RequestChangeProperties with all parameters set.
static RequestChangeProperties create(java.lang.String interactionId)
          Creates instance of RequestChangeProperties with required parameters set.
abstract  KeyValueCollection getAddedProperties()
          List of properties added.
abstract  KeyValueCollection getChangedProperties()
          List of properties changed.
abstract  KeyValueCollection getDeletedProperties()
          List of properties deleted.
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.String getQueue()
          Name of the queue that the interaction was in previously.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  void setAddedProperties(KeyValueCollection addedProperties)
          List of properties added.
abstract  void setChangedProperties(KeyValueCollection changedProperties)
          List of properties changed.
abstract  void setDeletedProperties(KeyValueCollection deletedProperties)
          List of properties deleted.
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 setQueue(java.lang.String queue)
          Name of the queue that the interaction was in previously.
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 RequestChangeProperties create()
Creates instance of RequestChangeProperties with no parameters set.

Returns:
instance of RequestChangeProperties

create

public static RequestChangeProperties create(java.lang.Integer proxyClientId,
                                             KeyValueCollection extension,
                                             java.lang.String interactionId,
                                             KeyValueCollection addedProperties,
                                             KeyValueCollection changedProperties,
                                             KeyValueCollection deletedProperties,
                                             java.lang.String queue)
Creates instance of RequestChangeProperties with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
extension - Extensions.
interactionId - Interaction identifier.
addedProperties - List of properties to change.
changedProperties - List of properties to change. Note that since Interaction Server does not allow duplicated properties, the lists of added and changed are treated the same way.
deletedProperties - List of properties to delete.
queue - Queue name to submit interaction into. The queue should be configured for the tenant.
Returns:
instance of RequestChangeProperties

create

public static RequestChangeProperties create(java.lang.String interactionId)
Creates instance of RequestChangeProperties with required parameters set.

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

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:


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.


getAddedProperties

public abstract KeyValueCollection getAddedProperties()
List of properties added.


setAddedProperties

public abstract void setAddedProperties(KeyValueCollection addedProperties)
List of properties added.


getChangedProperties

public abstract KeyValueCollection getChangedProperties()
List of properties changed.


setChangedProperties

public abstract void setChangedProperties(KeyValueCollection changedProperties)
List of properties changed.


getDeletedProperties

public abstract KeyValueCollection getDeletedProperties()
List of properties deleted.


setDeletedProperties

public abstract void setDeletedProperties(KeyValueCollection deletedProperties)
List of properties deleted.


getQueue

public abstract java.lang.String getQueue()
Name of the queue that the interaction was in previously. If this attribute has the same value as the Interaction attribute InteractionQueue, this indicates that the interaction has been returned to the same queue as before.


setQueue

public abstract void setQueue(java.lang.String queue)
Name of the queue that the interaction was in previously. If this attribute has the same value as the Interaction attribute InteractionQueue, this indicates that the interaction has been returned to the same queue as before.


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.