Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestSubmit
extends Message

With this request, either a media server or an agent application can submit a new interaction for processing.

Important note: the state of the newly submitted interaction is 'queued' if interaction is submitted by media server. The state is 'handling' if interaction is submitted by an agent. The agent should later issue an explicit instruction to place the interaction into a queue or workbin or to stop the interaction.

Direction: From media server or agent application to Interaction Server.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestSubmit create()
          Creates instance of RequestSubmit with no parameters set.
static RequestSubmit create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String interactionId, java.lang.String queue, java.lang.Integer tenantId, java.lang.String mediaType, java.lang.String interactionType, java.lang.String interactionSubtype, java.lang.Boolean isOnline, java.util.Date receivedAt, KeyValueCollection userData, java.lang.String parentInteractionId, KeyValueCollection inQueues, KeyValueCollection outQueues, java.lang.String workbinTypeId, java.lang.String workbinAgentId, java.lang.String workbinGroupId, java.lang.String workbinPlaceId, java.lang.String workbinPlaceGroupId)
          Deprecated. use other create methods
static RequestSubmit create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String interactionId, java.lang.String queue, java.lang.Integer tenantId, java.lang.String mediaType, java.lang.String interactionType, java.lang.String interactionSubtype, java.lang.Boolean isOnline, java.util.Date receivedAt, KeyValueCollection userData, java.lang.String parentInteractionId, KeyValueCollection inQueues, KeyValueCollection outQueues, java.lang.String workbinTypeId, java.lang.String workbinAgentId, java.lang.String workbinGroupId, java.lang.String workbinPlaceId, java.lang.String workbinPlaceGroupId, java.lang.Boolean hold)
          Creates instance of RequestSubmit.
static RequestSubmit create(java.lang.String mediaType, java.lang.String interactionType)
          Creates instance of RequestSubmit.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  java.lang.Boolean getHold()
           
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  java.lang.String getInteractionSubtype()
          Interaction subtype, from Interaction Subtype Business Attribute.
abstract  java.lang.String getInteractionType()
          Interaction type, from Interaction Type Business Attribute.
abstract  java.lang.Boolean getIsOnline()
          Values: 0: offline 1: online
abstract  java.lang.String getMediaType()
          Intended for media server to specify the primary media type of the interaction it will submit to Interaction Server.
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 getParentInteractionId()
          Parent interaction identifier.
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.util.Date getReceivedAt()
          Date and time that the interaction was first received by the media server or created by the agent application.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  java.lang.Integer getTenantId()
          Tenant identifier of the Party (database ID from the configuration).
abstract  KeyValueCollection getUserData()
          Pointer to any user data that should be attached to the interaction.
abstract  java.lang.String getWorkbinAgentId()
          Employee identifier of the agent who is the owner of the workbin instance.
abstract  java.lang.String getWorkbinGroupId()
          Name of the agent group that is the owner of the workbin instance.
abstract  java.lang.String getWorkbinPlaceGroupId()
          Name of the place group that is the owner of the workbin instance.
abstract  java.lang.String getWorkbinPlaceId()
          Name of the place that is the owner of the workbin instance.
abstract  java.lang.String getWorkbinTypeId()
          Name of the workbin type.
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setHold(java.lang.Boolean hold)
           
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 setInteractionSubtype(java.lang.String interactionSubtype)
          Interaction subtype, from Interaction Subtype Business Attribute.
abstract  void setInteractionType(java.lang.String interactionType)
          Interaction type, from Interaction Type Business Attribute.
abstract  void setIsOnline(java.lang.Boolean isOnline)
          Values: 0: offline 1: online
abstract  void setMediaType(java.lang.String mediaType)
          Intended for media server to specify the primary media type of the interaction it will submit to Interaction Server.
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 setParentInteractionId(java.lang.String parentInteractionId)
          Parent interaction identifier.
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 setReceivedAt(java.util.Date receivedAt)
          Date and time that the interaction was first received by the media server or created by the agent application.
abstract  void setReferenceId(int referenceId)
          Reference identifier of the request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference identifier of the request.
abstract  void setTenantId(int tenantId)
          Tenant identifier of the Party (database ID from the configuration).
abstract  void setTenantId(java.lang.Integer tenantId)
          Tenant identifier of the Party (database ID from the configuration).
abstract  void setUserData(KeyValueCollection userData)
          Pointer to any user data that should be attached to the interaction.
abstract  void setWorkbinAgentId(java.lang.String workbinAgentId)
          Employee identifier of the agent who is the owner of the workbin instance.
abstract  void setWorkbinGroupId(java.lang.String workbinGroupId)
          Name of the agent group that is the owner of the workbin instance.
abstract  void setWorkbinPlaceGroupId(java.lang.String workbinPlaceGroupId)
          Name of the place group that is the owner of the workbin instance.
abstract  void setWorkbinPlaceId(java.lang.String workbinPlaceId)
          Name of the place that is the owner of the workbin instance.
abstract  void setWorkbinTypeId(java.lang.String workbinTypeId)
          Name of the workbin type.
 
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 RequestSubmit create()
Creates instance of RequestSubmit with no parameters set.

Returns:
instance of RequestSubmit

create

public static RequestSubmit create(java.lang.Integer proxyClientId,
                                   KeyValueCollection extension,
                                   java.lang.String interactionId,
                                   java.lang.String queue,
                                   java.lang.Integer tenantId,
                                   java.lang.String mediaType,
                                   java.lang.String interactionType,
                                   java.lang.String interactionSubtype,
                                   java.lang.Boolean isOnline,
                                   java.util.Date receivedAt,
                                   KeyValueCollection userData,
                                   java.lang.String parentInteractionId,
                                   KeyValueCollection inQueues,
                                   KeyValueCollection outQueues,
                                   java.lang.String workbinTypeId,
                                   java.lang.String workbinAgentId,
                                   java.lang.String workbinGroupId,
                                   java.lang.String workbinPlaceId,
                                   java.lang.String workbinPlaceGroupId)
Deprecated. use other create methods

Creates instance of RequestSubmit.

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.
tenantId - Tenant identifier of the party (dbid from the configuration).
mediaType - Interaction media type as defined in media types enumerator (system name of enumerator).
interactionType - Interaction type as defined in interaction types enumerator (system name of enumerator).
interactionSubtype - Interaction subtype as defined in interaction subtypes enumerator (system name of enumerator).
isOnline - Default value is 0. Non-zero value indicates that interaction is an online interaction (Chat for example as opposite to e-mail). An online interaction is treated differently by Interaction Server. If media server that submitted online interaction shuts down, interaction is stopped automatically. Note that media server is allowed to change this attribute after it has submitted an interaction.
receivedAt - The time interaction has been received by media server or created by agent application. If not specified, the current time at the moment of processing of RequestSubmit is set to this attribute.
userData - Any interaction related data.
parentInteractionId - Parent interaction identifier .
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.
workbinTypeId - Name of the workbin.
workbinAgentId - Employee identifier of the agent who is the owner of the workbin instance. Must be specified for agent workbin.
workbinGroupId - Agent group name of the agent group that is the owner of the workbin instance. Must be specified for agent group workbin.
workbinPlaceId - Place name of the place that is the owner of the workbin instance. Must be specified for place workbin
workbinPlaceGroupId - Place group name of the place group that is the owner of the workbin instance. Must be specified for place group workbin.
Returns:
instance of RequestSubmit

create

public static RequestSubmit create(java.lang.String mediaType,
                                   java.lang.String interactionType)
Creates instance of RequestSubmit.

Parameters:
mediaType - Interaction media type as defined in media types enumerator (system name of enumerator).
interactionType - Interaction type as defined in interaction types enumerator (system name of enumerator).
Returns:
instance of RequestSubmit

create

public static RequestSubmit create(java.lang.Integer proxyClientId,
                                   KeyValueCollection extension,
                                   java.lang.String interactionId,
                                   java.lang.String queue,
                                   java.lang.Integer tenantId,
                                   java.lang.String mediaType,
                                   java.lang.String interactionType,
                                   java.lang.String interactionSubtype,
                                   java.lang.Boolean isOnline,
                                   java.util.Date receivedAt,
                                   KeyValueCollection userData,
                                   java.lang.String parentInteractionId,
                                   KeyValueCollection inQueues,
                                   KeyValueCollection outQueues,
                                   java.lang.String workbinTypeId,
                                   java.lang.String workbinAgentId,
                                   java.lang.String workbinGroupId,
                                   java.lang.String workbinPlaceId,
                                   java.lang.String workbinPlaceGroupId,
                                   java.lang.Boolean hold)
Creates instance of RequestSubmit.

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.
tenantId - Tenant identifier of the party (dbid from the configuration).
mediaType - Interaction media type as defined in media types enumerator (system name of enumerator).
interactionType - Interaction type as defined in interaction types enumerator (system name of enumerator).
interactionSubtype - Interaction subtype as defined in interaction subtypes enumerator (system name of enumerator).
isOnline - Default value is 0. Non-zero value indicates that interaction is an online interaction (Chat for example as opposite to e-mail). An online interaction is treated differently by Interaction Server. If media server that submitted online interaction shuts down, interaction is stopped automatically. Note that media server is allowed to change this attribute after it has submitted an interaction.
receivedAt - The time interaction has been received by media server or created by agent application. If not specified, the current time at the moment of processing of RequestSubmit is set to this attribute.
userData - Any interaction related data.
parentInteractionId - Parent interaction identifier .
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.
workbinTypeId - Name of the workbin.
workbinAgentId - Employee identifier of the agent who is the owner of the workbin instance. Must be specified for agent workbin.
workbinGroupId - Agent group name of the agent group that is the owner of the workbin instance. Must be specified for agent group workbin.
workbinPlaceId - Place name of the place that is the owner of the workbin instance. Must be specified for place workbin
workbinPlaceGroupId - Place group name of the place group that is the owner of the workbin instance. Must be specified for place group workbin.
hold -
Returns:
instance of RequestSubmit

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.


getTenantId

public abstract java.lang.Integer getTenantId()
Tenant identifier of the Party (database ID from the configuration).


setTenantId

public abstract void setTenantId(java.lang.Integer tenantId)
Tenant identifier of the Party (database ID from the configuration).


setTenantId

public abstract void setTenantId(int tenantId)
Tenant identifier of the Party (database ID from the configuration).


getMediaType

public abstract java.lang.String getMediaType()
Intended for media server to specify the primary media type of the interaction it will submit to Interaction Server.


setMediaType

public abstract void setMediaType(java.lang.String mediaType)
Intended for media server to specify the primary media type of the interaction it will submit to Interaction Server.


getInteractionType

public abstract java.lang.String getInteractionType()
Interaction type, from Interaction Type Business Attribute.


setInteractionType

public abstract void setInteractionType(java.lang.String interactionType)
Interaction type, from Interaction Type Business Attribute.


getInteractionSubtype

public abstract java.lang.String getInteractionSubtype()
Interaction subtype, from Interaction Subtype Business Attribute.


setInteractionSubtype

public abstract void setInteractionSubtype(java.lang.String interactionSubtype)
Interaction subtype, from Interaction Subtype Business Attribute.


getIsOnline

public abstract java.lang.Boolean getIsOnline()
Values:


setIsOnline

public abstract void setIsOnline(java.lang.Boolean isOnline)
Values:


getReceivedAt

public abstract java.util.Date getReceivedAt()
Date and time that the interaction was first received by the media server or created by the agent application. If the preceding are not specified, the attribute is set to the moment that Interaction Server processed RequestSubmit.


setReceivedAt

public abstract void setReceivedAt(java.util.Date receivedAt)
Date and time that the interaction was first received by the media server or created by the agent application. If the preceding are not specified, the attribute is set to the moment that Interaction Server processed RequestSubmit.


getUserData

public abstract KeyValueCollection getUserData()
Pointer to any user data that should be attached to the interaction.


setUserData

public abstract void setUserData(KeyValueCollection userData)
Pointer to any user data that should be attached to the interaction.


getParentInteractionId

public abstract java.lang.String getParentInteractionId()
Parent interaction identifier.


setParentInteractionId

public abstract void setParentInteractionId(java.lang.String parentInteractionId)
Parent interaction identifier.


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.


getWorkbinTypeId

public abstract java.lang.String getWorkbinTypeId()
Name of the workbin type.


setWorkbinTypeId

public abstract void setWorkbinTypeId(java.lang.String workbinTypeId)
Name of the workbin type.


getWorkbinAgentId

public abstract java.lang.String getWorkbinAgentId()
Employee identifier of the agent who is the owner of the workbin instance. Must be specified for agent workbin.


setWorkbinAgentId

public abstract void setWorkbinAgentId(java.lang.String workbinAgentId)
Employee identifier of the agent who is the owner of the workbin instance. Must be specified for agent workbin.


getWorkbinGroupId

public abstract java.lang.String getWorkbinGroupId()
Name of the agent group that is the owner of the workbin instance. Mandatory for agent group workbin.


setWorkbinGroupId

public abstract void setWorkbinGroupId(java.lang.String workbinGroupId)
Name of the agent group that is the owner of the workbin instance. Mandatory for agent group workbin.


getWorkbinPlaceId

public abstract java.lang.String getWorkbinPlaceId()
Name of the place that is the owner of the workbin instance. Mandatory for place workbin.


setWorkbinPlaceId

public abstract void setWorkbinPlaceId(java.lang.String workbinPlaceId)
Name of the place that is the owner of the workbin instance. Mandatory for place workbin.


getWorkbinPlaceGroupId

public abstract java.lang.String getWorkbinPlaceGroupId()
Name of the place group that is the owner of the workbin instance. Mandatory for place group workbin.


setWorkbinPlaceGroupId

public abstract void setWorkbinPlaceGroupId(java.lang.String workbinPlaceGroupId)
Name of the place group that is the owner of the workbin instance. Mandatory for place group workbin.


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

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.