Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestPull
extends Message

With this request, an agent application can pull interactions for processing. Interactions can be pulled from:

Direction: From agent application or URS to Interaction Server


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

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 RequestPull create()
Creates instance of RequestPull with no parameters set.

Returns:
instance of 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)
Deprecated. use other create methods

Creates instance of RequestPull.

Parameters:
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.
Returns:
instance of RequestPull

create

public static RequestPull create(java.lang.String viewId,
                                 ReasonInfo reason)
Creates instance of RequestPull.

Parameters:
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.
Returns:
instance of 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,
                                 java.lang.Integer ignoreHold,
                                 ReasonInfo reason)
Creates instance of RequestPull.

Parameters:
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.
Returns:
instance of RequestPull

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:


getViewId

public abstract java.lang.String getViewId()
Identifier of the view to pull interactions from. The view should be defined for the tenant. The special _system_ view allows pulling of the specific interaction by its identifier.


setViewId

public abstract void setViewId(java.lang.String viewId)
Identifier of the view to pull interactions from. The view should be defined for the tenant. The special _system_ view allows pulling of the specific interaction by its identifier.


getPullParameters

public abstract KeyValueCollection getPullParameters()
Parameters for the pull request.


setPullParameters

public abstract void setPullParameters(KeyValueCollection pullParameters)
Parameters for the pull request.


getCount

public abstract java.lang.Integer getCount()
Maximum number of interactions to pull; default is 1.


setCount

public abstract void setCount(java.lang.Integer count)
Maximum number of interactions to pull; default is 1.


setCount

public abstract void setCount(int count)
Maximum number of interactions to pull; default is 1.


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).


getInitialInFocusState

public 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.

Returns:
property value

setInitialInFocusState

public 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.

Parameters:
initialInFocusState - new value of the property

getIgnoreHold

public abstract java.lang.Integer getIgnoreHold()
Returns:
property value

setIgnoreHold

public abstract void setIgnoreHold(java.lang.Integer ignoreHold)
Parameters:
ignoreHold - new value of the property

setIgnoreHold

public abstract void setIgnoreHold(int ignoreHold)
Parameters:
ignoreHold - new value of the property

getGetIdsOnly

public 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. Default value is 0 (false).

Returns:
property value

setGetIdsOnly

public 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. Default value is 0 (false).

Parameters:
getIdsOnly - new value of the property

setGetIdsOnly

public 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. Default value is 0 (false).

Parameters:
getIdsOnly - new value of the property

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.