|
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.RequestPull
public abstract class RequestPull
With this request, an agent application can pull interactions for processing. Interactions can be pulled from:
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestPull |
create()
Creates instance of RequestPull with no parameters set. |
static RequestPull |
create(java.lang.Integer referenceId,
java.lang.Integer proxyClientId,
KeyValueCollection extension,
java.lang.String viewId,
KeyValueCollection pullParameters,
java.lang.Integer count,
java.lang.Integer tenantId,
java.lang.Boolean initialInFocusState,
java.lang.Integer ignoreHold,
ReasonInfo reason)
Creates instance of RequestPull. |
static RequestPull |
create(java.lang.Integer referenceId,
java.lang.Integer proxyClientId,
KeyValueCollection extension,
java.lang.String viewId,
KeyValueCollection pullParameters,
java.lang.Integer count,
java.lang.Integer tenantId,
java.lang.Boolean initialInFocusState,
ReasonInfo reason)
Deprecated. use other create methods |
static RequestPull |
create(java.lang.String viewId,
ReasonInfo reason)
Creates instance of RequestPull. |
abstract java.lang.Integer |
getCount()
Maximum number of interactions to pull; default is 1. |
abstract KeyValueCollection |
getExtension()
A key-value list of extensions. |
abstract java.lang.Integer |
getGetIdsOnly()
If present and has value not equal to 0, Interaction Server would return interaction ids only in the corresponding EventPulledInteractions. |
abstract java.lang.Integer |
getIgnoreHold()
|
abstract java.lang.Boolean |
getInitialInFocusState()
Attribute specifies the initial state (In/out of focus) of the interaction right after it has been accepted or pulled by agent. |
abstract java.lang.Integer |
getProxyClientId()
Proxy client identifier. |
abstract KeyValueCollection |
getPullParameters()
Parameters for the pull request. |
abstract ReasonInfo |
getReason()
This property has been deprecated in all events. |
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 java.lang.String |
getViewId()
Identifier of the view to pull interactions from. |
abstract void |
setCount(int count)
Maximum number of interactions to pull; default is 1. |
abstract void |
setCount(java.lang.Integer count)
Maximum number of interactions to pull; default is 1. |
abstract void |
setExtension(KeyValueCollection extension)
A key-value list of extensions. |
abstract void |
setGetIdsOnly(int getIdsOnly)
If present and has value not equal to 0, Interaction Server would return interaction ids only in the corresponding EventPulledInteractions. |
abstract void |
setGetIdsOnly(java.lang.Integer getIdsOnly)
If present and has value not equal to 0, Interaction Server would return interaction ids only in the corresponding EventPulledInteractions. |
abstract void |
setIgnoreHold(int ignoreHold)
|
abstract void |
setIgnoreHold(java.lang.Integer ignoreHold)
|
abstract void |
setInitialInFocusState(java.lang.Boolean initialInFocusState)
Attribute specifies the initial state (In/out of focus) of the interaction right after it has been accepted or pulled by agent. |
abstract void |
setProxyClientId(int proxyClientId)
Proxy client identifier. |
abstract void |
setProxyClientId(java.lang.Integer proxyClientId)
Proxy client identifier. |
abstract void |
setPullParameters(KeyValueCollection pullParameters)
Parameters for the pull request. |
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. |
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 |
setViewId(java.lang.String viewId)
Identifier of the view to pull interactions from. |
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 RequestPull create()
public static RequestPull create(java.lang.Integer referenceId, java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String viewId, KeyValueCollection pullParameters, java.lang.Integer count, java.lang.Integer tenantId, java.lang.Boolean initialInFocusState, ReasonInfo reason)
referenceId
- Reference identifier of the request; it is client responsibility to generate the reference identifier and then tie the server response to the request.proxyClientId
- The identifier of the client of proxy.extension
- Extensions.viewId
- Existing view name. Instead of specifying custom condition for the snapshot, it is possible to instruct Interaction Server to use the same condition as the specified view has.pullParameters
- Parameters for the pull request. The '_system_' view requires 'InteractionId' parameter to be specified in the list. The configured parameterized views may require other parameters depending on view configuration. Workbin views require one of the following parameters, depending on workbin owner type:the following parameters, depending on workbin owner type:1. agent_id, 2. agent_group_id, 3. place_id, 4. place_group_id.count
- Maximum number of the interactions to pull. Default value is 1.tenantId
- Tenant identifier of the party (dbid from the configuration).initialInFocusState
- Attribute specifies the initial state (In/out of focus) of the interaction right after it has been accepted or pulled by agent.reason
- Reason.
public static RequestPull create(java.lang.String viewId, ReasonInfo reason)
viewId
- Existing view name. Instead of specifying custom condition for the snapshot, it is possible to instruct Interaction Server to use the same condition as the specified view has.reason
- Reason.
public static RequestPull create(java.lang.Integer referenceId, java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String viewId, KeyValueCollection pullParameters, java.lang.Integer count, java.lang.Integer tenantId, java.lang.Boolean initialInFocusState, java.lang.Integer ignoreHold, ReasonInfo reason)
referenceId
- Reference identifier of the request; it is client responsibility to generate the reference identifier and then tie the server response to the request.proxyClientId
- The identifier of the client of proxy.extension
- Extensions.viewId
- Existing view name. Instead of specifying custom condition for the snapshot, it is possible to instruct Interaction Server to use the same condition as the specified view has.pullParameters
- Parameters for the pull request. The '_system_' view requires 'InteractionId' parameter to be specified in the list. The configured parameterized views may require other parameters depending on view configuration. Workbin views require one of the following parameters, depending on workbin owner type:the following parameters, depending on workbin owner type:1. agent_id, 2. agent_group_id, 3. place_id, 4. place_group_id.count
- Maximum number of the interactions to pull. Default value is 1.tenantId
- Tenant identifier of the party (dbid from the configuration).initialInFocusState
- Attribute specifies the initial state (In/out of focus) of the interaction right after it has been accepted or pulled by agent.ignoreHold
- reason
- Reason.
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 getViewId()
public abstract void setViewId(java.lang.String viewId)
public abstract KeyValueCollection getPullParameters()
public abstract void setPullParameters(KeyValueCollection pullParameters)
public abstract java.lang.Integer getCount()
public abstract void setCount(java.lang.Integer count)
public abstract void setCount(int count)
public abstract java.lang.Integer getTenantId()
public abstract void setTenantId(java.lang.Integer tenantId)
public abstract void setTenantId(int tenantId)
public abstract java.lang.Boolean getInitialInFocusState()
public abstract void setInitialInFocusState(java.lang.Boolean initialInFocusState)
initialInFocusState
- new value of the propertypublic abstract java.lang.Integer getIgnoreHold()
public abstract void setIgnoreHold(java.lang.Integer ignoreHold)
ignoreHold
- new value of the propertypublic abstract void setIgnoreHold(int ignoreHold)
ignoreHold
- new value of the propertypublic abstract java.lang.Integer getGetIdsOnly()
public abstract void setGetIdsOnly(java.lang.Integer getIdsOnly)
getIdsOnly
- new value of the propertypublic abstract void setGetIdsOnly(int getIdsOnly)
getIdsOnly
- new value of the propertypublic abstract ReasonInfo getReason()
public abstract void setReason(ReasonInfo reason)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |