Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestDeliver
extends Message

With this request, the routing engine instructs Interaction Server to deliver an interaction to an agent. The routing engine must be handling the interaction in order to issue this request.

Direction: From routing engine to Interaction Server


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestDeliver create()
          Creates instance of RequestDeliver with no parameters set.
static RequestDeliver create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String interactionId, java.lang.String agentId, java.lang.String placeId, KeyValueCollection inQueues, KeyValueCollection outQueues, ReasonInfo reason)
          Creates instance of RequestDeliver with all parameters set.
static RequestDeliver create(java.lang.String interactionId, ReasonInfo reason)
          Creates instance of RequestDeliver with required parameters set.
abstract  java.lang.String getAgentId()
          Agent identifier of the resource, if the Party is a resource and if the resource logged in with its agent identifier specified.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  KeyValueCollection getInQueues()
          List of queues supplied by interaction workflow as suggested places for the agent to place the original interaction.
abstract  java.lang.String getInteractionId()
          Identifier of the interaction being accepted.
abstract  KeyValueCollection getOutQueues()
          List of queues supplied by interaction workflow as suggested places for the agent to place the reply interaction.
abstract  java.lang.String getPlaceId()
          Place identifier of the resource, if the Party is a resource.
abstract  java.lang.Integer getProxyClientId()
          Proxy client identifier.
abstract  ReasonInfo getReason()
          This property has been deprecated in all events.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  void setAgentId(java.lang.String agentId)
          Agent identifier of the resource, if the Party is a resource and if the resource logged in with its agent identifier specified.
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setInQueues(KeyValueCollection inQueues)
          List of queues supplied by interaction workflow as suggested places for the agent to place the original interaction.
abstract  void setInteractionId(java.lang.String interactionId)
          Identifier of the interaction being accepted.
abstract  void setOutQueues(KeyValueCollection outQueues)
          List of queues supplied by interaction workflow as suggested places for the agent to place the reply interaction.
abstract  void setPlaceId(java.lang.String placeId)
          Place identifier of the resource, if the Party is a resource.
abstract  void setProxyClientId(int proxyClientId)
          Proxy client identifier.
abstract  void setProxyClientId(java.lang.Integer proxyClientId)
          Proxy client identifier.
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 RequestDeliver create()
Creates instance of RequestDeliver with no parameters set.

Returns:
instance of RequestDeliver

create

public static RequestDeliver create(java.lang.Integer proxyClientId,
                                    KeyValueCollection extension,
                                    java.lang.String interactionId,
                                    java.lang.String agentId,
                                    java.lang.String placeId,
                                    KeyValueCollection inQueues,
                                    KeyValueCollection outQueues,
                                    ReasonInfo reason)
Creates instance of RequestDeliver with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
extension - Extensions.
interactionId - Interaction identifier.
agentId - Agent identifier of the resource, if party is a resource and if resource logged in with agent identifier specified.
placeId - Place identifier of the resource, if party is a resource.
inQueues - List of queue names to place the original interaction to. Suggested to agent by workflow definition.
outQueues - List of queue names to place the reply interaction to. Suggested to agent by workflow definition.
reason - Reason.
Returns:
instance of RequestDeliver

create

public static RequestDeliver create(java.lang.String interactionId,
                                    ReasonInfo reason)
Creates instance of RequestDeliver with required parameters set.

Parameters:
interactionId - Interaction identifier.
reason - Reason.
Returns:
instance of RequestDeliver

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.


getAgentId

public abstract java.lang.String getAgentId()
Agent identifier of the resource, if the Party is a resource and if the resource logged in with its agent identifier specified.


setAgentId

public abstract void setAgentId(java.lang.String agentId)
Agent identifier of the resource, if the Party is a resource and if the resource logged in with its agent identifier specified.


getPlaceId

public abstract java.lang.String getPlaceId()
Place identifier of the resource, if the Party is a resource.


setPlaceId

public abstract void setPlaceId(java.lang.String placeId)
Place identifier of the resource, if the Party is a resource.


getInQueues

public abstract KeyValueCollection getInQueues()
List of queues supplied by interaction workflow as suggested places for the agent to place the original interaction.


setInQueues

public abstract void setInQueues(KeyValueCollection inQueues)
List of queues supplied by interaction workflow as suggested places for the agent to place the original interaction.


getOutQueues

public abstract KeyValueCollection getOutQueues()
List of queues supplied by interaction workflow as suggested places for the agent to place the reply interaction.


setOutQueues

public abstract void setOutQueues(KeyValueCollection outQueues)
List of queues supplied by interaction workflow as suggested places for the agent to place the reply interaction.


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.