Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestPlaceInQueue
extends Message

With this request, an agent application or URS can place an interaction into a specified queue. The queue must be defined for the tenant that the interaction belongs to.

Direction: From URS or agent application to Interaction Server.

The following properties have been deprecated: AddedProperties, ChangedProperties, and DeletedProperties.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestPlaceInQueue create()
          Creates instance of RequestPlaceInQueue with no parameters set.
static RequestPlaceInQueue create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String interactionId, java.lang.String queue, java.lang.Boolean hold, ReasonInfo reason)
          Creates instance of RequestPlaceInQueue.
static RequestPlaceInQueue create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String interactionId, java.lang.String queue, KeyValueCollection addedProperties, KeyValueCollection changedProperties, KeyValueCollection deletedProperties, ReasonInfo reason)
          Deprecated. use other create methods. (Obsolete since 8.0.0)
static RequestPlaceInQueue create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String interactionId, java.lang.String queue, ReasonInfo reason)
          Deprecated. use other create methods. (Obsolete since 8.0.1)
static RequestPlaceInQueue create(java.lang.String interactionId, java.lang.String queue, ReasonInfo reason)
          Creates instance of RequestPlaceInQueue.
abstract  KeyValueCollection getAddedProperties()
          Deprecated. 
abstract  KeyValueCollection getChangedProperties()
          Deprecated. 
abstract  KeyValueCollection getDeletedProperties()
          Deprecated. 
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  java.lang.Boolean getHold()
           
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  ReasonInfo getReason()
          This property has been deprecated in all events.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  void setAddedProperties(KeyValueCollection addedProperties)
          Deprecated. 
abstract  void setChangedProperties(KeyValueCollection changedProperties)
          Deprecated. 
abstract  void setDeletedProperties(KeyValueCollection deletedProperties)
          Deprecated. 
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setHold(java.lang.Boolean hold)
           
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 setReason(ReasonInfo reason)
          This property has been deprecated in all events.
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 RequestPlaceInQueue create()
Creates instance of RequestPlaceInQueue with no parameters set.

Returns:
instance of RequestPlaceInQueue

create

public static RequestPlaceInQueue create(java.lang.Integer proxyClientId,
                                         KeyValueCollection extension,
                                         java.lang.String interactionId,
                                         java.lang.String queue,
                                         KeyValueCollection addedProperties,
                                         KeyValueCollection changedProperties,
                                         KeyValueCollection deletedProperties,
                                         ReasonInfo reason)
Deprecated. use other create methods. (Obsolete since 8.0.0)

Creates instance of RequestPlaceInQueue.

Parameters:
proxyClientId - The identifier of the client of proxy.
extension - Extensions.
interactionId - Interaction identifier.
queue - Queue name to submit interaction into. The queue should be configured for the tenant.
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.
reason - Reason.
Returns:
instance of RequestPlaceInQueue

create

public static RequestPlaceInQueue create(java.lang.Integer proxyClientId,
                                         KeyValueCollection extension,
                                         java.lang.String interactionId,
                                         java.lang.String queue,
                                         ReasonInfo reason)
Deprecated. use other create methods. (Obsolete since 8.0.1)

Creates instance of RequestPlaceInQueue.

Parameters:
proxyClientId - The identifier of the client of proxy.
extension - Extensions.
interactionId - Interaction identifier.
queue - Queue name to submit interaction into. The queue should be configured for the tenant.
reason - Reason.
Returns:
instance of RequestPlaceInQueue

create

public static RequestPlaceInQueue create(java.lang.Integer proxyClientId,
                                         KeyValueCollection extension,
                                         java.lang.String interactionId,
                                         java.lang.String queue,
                                         java.lang.Boolean hold,
                                         ReasonInfo reason)
Creates instance of RequestPlaceInQueue.

Parameters:
proxyClientId - The identifier of the client of proxy.
extension - Extensions.
interactionId - Interaction identifier.
queue - Queue name to submit interaction into. The queue should be configured for the tenant.
hold -
reason - Reason.
Returns:
instance of RequestPlaceInQueue

create

public static RequestPlaceInQueue create(java.lang.String interactionId,
                                         java.lang.String queue,
                                         ReasonInfo reason)
Creates instance of RequestPlaceInQueue.

Parameters:
interactionId - Interaction identifier.
queue - Queue name to submit interaction into. The queue should be configured for the tenant.
reason - Reason.
Returns:
instance of RequestPlaceInQueue

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.


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.


getAddedProperties

@Deprecated
public abstract KeyValueCollection getAddedProperties()
Deprecated. 

List of properties added.


setAddedProperties

@Deprecated
public abstract void setAddedProperties(KeyValueCollection addedProperties)
Deprecated. 

List of properties added.


getChangedProperties

@Deprecated
public abstract KeyValueCollection getChangedProperties()
Deprecated. 

List of properties changed.


setChangedProperties

@Deprecated
public abstract void setChangedProperties(KeyValueCollection changedProperties)
Deprecated. 

List of properties changed.


getDeletedProperties

@Deprecated
public abstract KeyValueCollection getDeletedProperties()
Deprecated. 

List of properties deleted.


setDeletedProperties

@Deprecated
public abstract void setDeletedProperties(KeyValueCollection deletedProperties)
Deprecated. 

List of properties deleted.


getHold

public abstract java.lang.Boolean getHold()
Returns:
property value

setHold

public abstract void setHold(java.lang.Boolean hold)
Parameters:
hold - new value of the property

getReason

public abstract ReasonInfo getReason()
This property has been deprecated in all events. In any messages sent to Interaction Server, this value must be left as 0 (the default value).


setReason

public abstract void setReason(ReasonInfo reason)
This property has been deprecated in all events. In any messages sent to Interaction Server, this value must be left as 0 (the default value).


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.