|
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.events.EventWorkflowConfiguration
public abstract class EventWorkflowConfiguration
This event provides an agent application with information on queues
and views configuration directly through Interaction Server (rather
than from the Configuration Layer). This event is sent by Interaction
Server as a response to RequestWorkflowConfiguration.
Direction: From Interaction Server to an agent application.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static EventWorkflowConfiguration |
create()
Creates instance of EventWorkflowConfiguration with no parameters set. |
static EventWorkflowConfiguration |
create(java.lang.Integer proxyClientId,
KeyValueCollection queuesConfiguration,
KeyValueCollection viewsConfiguration,
KeyValueCollection extension)
Creates instance of EventWorkflowConfiguration with all parameters set. |
abstract KeyValueCollection |
getExtension()
A key-value list of extensions. |
abstract java.lang.Integer |
getProxyClientId()
Proxy client identifier. |
abstract KeyValueCollection |
getQueuesConfiguration()
Key-value list that contains information on the queues in a tenant. |
abstract java.lang.Integer |
getReferenceId()
Reference identifier of the request. |
abstract KeyValueCollection |
getViewsConfiguration()
Key-value list that contains information on the views in a tenant. |
abstract void |
setExtension(KeyValueCollection extension)
A key-value list of extensions. |
abstract void |
setProxyClientId(int proxyClientId)
Proxy client identifier. |
abstract void |
setProxyClientId(java.lang.Integer proxyClientId)
Proxy client identifier. |
abstract void |
setQueuesConfiguration(KeyValueCollection queuesConfiguration)
Key-value list that contains information on the queues in a tenant. |
abstract void |
setReferenceId(int referenceId)
Reference identifier of the request. |
abstract void |
setReferenceId(java.lang.Integer referenceId)
Reference identifier of the request. |
abstract void |
setViewsConfiguration(KeyValueCollection viewsConfiguration)
Key-value list that contains information on the views in a tenant. |
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 EventWorkflowConfiguration create()
public static EventWorkflowConfiguration create(java.lang.Integer proxyClientId, KeyValueCollection queuesConfiguration, KeyValueCollection viewsConfiguration, KeyValueCollection extension)
proxyClientId
- The identifier of the client of proxy.queuesConfiguration
- Key-value list that contains tenant queues information. Each key in the list is a queue name as present in configuration for the same tenant the agent that sent the request belongs to. Values are key-value lists that contain the following keys: 'Name' - name of the queue (as it should be used in protocol requests) 'DisplayName' - display name of the queue 'Description' - description of the queueviewsConfiguration
- Key-value list that contains tenant views information. Each key in the list is a view name as present in configuration for the same tenant the agent that sent the request belongs to. Values are key-value lists that contain the following keys: 'Name' - name of the view (as it should be used in protocol requests). 'QueueName' - name of the queue the view is based on. 'Condition' - condition as it is defined in the configuration. 'Condition.[property name]' - as many key-value pairs as there are parameters for the view. 'DisplayName' - display name of the queue. 'Description' - description of the queue.extension
- Extensions.
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 getQueuesConfiguration()
public abstract void setQueuesConfiguration(KeyValueCollection queuesConfiguration)
public abstract KeyValueCollection getViewsConfiguration()
public abstract void setViewsConfiguration(KeyValueCollection viewsConfiguration)
public abstract KeyValueCollection getExtension()
public abstract void setExtension(KeyValueCollection extension)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |