Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestGetWorkbinContent
extends Message

With this request, an agent asks for information on the contents of a workbin instance.

Note: This request is to be used to retrieve information from place or agent workbins only, not from agent group or place group workbins.

Direction: From agent application to Interaction Server.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestGetWorkbinContent create()
          Creates instance of RequestGetWorkbinContent with no parameters set.
static RequestGetWorkbinContent create(java.lang.Integer proxyClientId, KeyValueCollection extension, WorkbinInfo workbin, ReasonInfo reason)
          Deprecated. use other create methods
static RequestGetWorkbinContent create(WorkbinInfo workbin, ReasonInfo reason)
          Creates instance of RequestGetWorkbinContent.
abstract  java.lang.String getCondition()
          [Optional] filtering condition for the database.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  java.lang.Integer getFindMaxInteractions()
          Maximum number of interactions to return in EventWorkbinContent.
abstract  java.lang.String getOrder()
          [Optional] order in which the records are retruned.
abstract  java.lang.Integer getProxyClientId()
          Proxy client identifier.
abstract  ReasonInfo getReason()
          This property has been deprecated in all events.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  WorkbinInfo getWorkbin()
           
abstract  void setCondition(java.lang.String condition)
          [Optional] filtering condition for the database.
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setFindMaxInteractions(int findMaxInteractions)
          Maximum number of interactions to return in EventWorkbinContent.
abstract  void setFindMaxInteractions(java.lang.Integer findMaxInteractions)
          Maximum number of interactions to return in EventWorkbinContent.
abstract  void setOrder(java.lang.String order)
          [Optional] order in which the records are retruned.
abstract  void setProxyClientId(int proxyClientId)
          Proxy client identifier.
abstract  void setProxyClientId(java.lang.Integer proxyClientId)
          Proxy client identifier.
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 setWorkbin(WorkbinInfo workbin)
           
 
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 RequestGetWorkbinContent create()
Creates instance of RequestGetWorkbinContent with no parameters set.

Returns:
instance of RequestGetWorkbinContent

create

public static RequestGetWorkbinContent create(java.lang.Integer proxyClientId,
                                              KeyValueCollection extension,
                                              WorkbinInfo workbin,
                                              ReasonInfo reason)
Deprecated. use other create methods

Creates instance of RequestGetWorkbinContent.

Parameters:
proxyClientId - The identifier of the client of proxy.
extension - Extensions.
workbin - Workbin
reason - Reason.
Returns:
instance of RequestGetWorkbinContent

create

public static RequestGetWorkbinContent create(WorkbinInfo workbin,
                                              ReasonInfo reason)
Creates instance of RequestGetWorkbinContent.

Parameters:
workbin - Workbin
reason - Reason.
Returns:
instance of RequestGetWorkbinContent

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.


getFindMaxInteractions

public abstract java.lang.Integer getFindMaxInteractions()
Maximum number of interactions to return in EventWorkbinContent. If not present, the number of interactions returned in EventWorkbinContent is limited by IS parameter 'max-workbin-interactions'. If the attribute is present, the minimum of the attribute value and the parameter 'max-workbin-interactions' value is applied to the number of returned interactions in EventWorkbinContent event.


setFindMaxInteractions

public abstract void setFindMaxInteractions(java.lang.Integer findMaxInteractions)
Maximum number of interactions to return in EventWorkbinContent. If not present, the number of interactions returned in EventWorkbinContent is limited by IS parameter 'max-workbin-interactions'. If the attribute is present, the minimum of the attribute value and the parameter 'max-workbin-interactions' value is applied to the number of returned interactions in EventWorkbinContent event.


setFindMaxInteractions

public abstract void setFindMaxInteractions(int findMaxInteractions)
Maximum number of interactions to return in EventWorkbinContent. If not present, the number of interactions returned in EventWorkbinContent is limited by IS parameter 'max-workbin-interactions'. If the attribute is present, the minimum of the attribute value and the parameter 'max-workbin-interactions' value is applied to the number of returned interactions in EventWorkbinContent event.


getCondition

public abstract java.lang.String getCondition()
[Optional] filtering condition for the database.


setCondition

public abstract void setCondition(java.lang.String condition)
[Optional] filtering condition for the database.


getOrder

public abstract java.lang.String getOrder()
[Optional] order in which the records are retruned.


setOrder

public abstract void setOrder(java.lang.String order)
[Optional] order in which the records are retruned.


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:


getWorkbin

public abstract WorkbinInfo getWorkbin()

setWorkbin

public abstract void setWorkbin(WorkbinInfo workbin)

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.