|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.openmedia.protocol.interactionserver.requests.interactionmanagement.RequestSubmit
public abstract class RequestSubmit
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static 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)
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 workbinworkbinPlaceGroupId
- Place group name of the place group that is the owner of the workbin instance. Must be specified for place group workbin.
public static RequestSubmit create(java.lang.String mediaType, java.lang.String interactionType)
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).
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)
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 workbinworkbinPlaceGroupId
- Place group name of the place group that is the owner of the workbin instance. Must be specified for place group workbin.hold
-
public abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract java.lang.Integer getProxyClientId()
public abstract void setProxyClientId(java.lang.Integer proxyClientId)
public abstract void setProxyClientId(int proxyClientId)
public abstract KeyValueCollection getExtension()
public abstract void setExtension(KeyValueCollection extension)
public abstract java.lang.String getInteractionId()
public abstract void setInteractionId(java.lang.String interactionId)
public abstract java.lang.String getQueue()
public abstract void setQueue(java.lang.String queue)
public abstract java.lang.Integer getTenantId()
public abstract void setTenantId(java.lang.Integer tenantId)
public abstract void setTenantId(int tenantId)
public abstract java.lang.String getMediaType()
public abstract void setMediaType(java.lang.String mediaType)
public abstract java.lang.String getInteractionType()
public abstract void setInteractionType(java.lang.String interactionType)
public abstract java.lang.String getInteractionSubtype()
public abstract void setInteractionSubtype(java.lang.String interactionSubtype)
public abstract java.lang.Boolean getIsOnline()
public abstract void setIsOnline(java.lang.Boolean isOnline)
public abstract java.util.Date getReceivedAt()
public abstract void setReceivedAt(java.util.Date receivedAt)
public abstract KeyValueCollection getUserData()
public abstract void setUserData(KeyValueCollection userData)
public abstract java.lang.String getParentInteractionId()
public abstract void setParentInteractionId(java.lang.String parentInteractionId)
public abstract KeyValueCollection getInQueues()
public abstract void setInQueues(KeyValueCollection inQueues)
public abstract KeyValueCollection getOutQueues()
public abstract void setOutQueues(KeyValueCollection outQueues)
public abstract java.lang.String getWorkbinTypeId()
public abstract void setWorkbinTypeId(java.lang.String workbinTypeId)
public abstract java.lang.String getWorkbinAgentId()
public abstract void setWorkbinAgentId(java.lang.String workbinAgentId)
public abstract java.lang.String getWorkbinGroupId()
public abstract void setWorkbinGroupId(java.lang.String workbinGroupId)
public abstract java.lang.String getWorkbinPlaceId()
public abstract void setWorkbinPlaceId(java.lang.String workbinPlaceId)
public abstract java.lang.String getWorkbinPlaceGroupId()
public abstract void setWorkbinPlaceGroupId(java.lang.String workbinPlaceGroupId)
public abstract java.lang.Boolean getHold()
public abstract void setHold(java.lang.Boolean hold)
hold
- new value of the property
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |