|
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.RequestGetWorkbinContent
public abstract class RequestGetWorkbinContent
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static RequestGetWorkbinContent create()
public static RequestGetWorkbinContent create(java.lang.Integer proxyClientId, KeyValueCollection extension, WorkbinInfo workbin, ReasonInfo reason)
proxyClientId
- The identifier of the client of proxy.extension
- Extensions.workbin
- Workbinreason
- Reason.
public static RequestGetWorkbinContent create(WorkbinInfo workbin, ReasonInfo reason)
workbin
- Workbinreason
- 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 java.lang.Integer getFindMaxInteractions()
public abstract void setFindMaxInteractions(java.lang.Integer findMaxInteractions)
public abstract void setFindMaxInteractions(int findMaxInteractions)
public abstract java.lang.String getCondition()
public abstract void setCondition(java.lang.String condition)
public abstract java.lang.String getOrder()
public abstract void setOrder(java.lang.String order)
public abstract KeyValueCollection getExtension()
public abstract void setExtension(KeyValueCollection extension)
public abstract WorkbinInfo getWorkbin()
public abstract void setWorkbin(WorkbinInfo workbin)
public 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 |