|
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.RequestPlaceInWorkbin
public abstract class RequestPlaceInWorkbin
With this request, an agent application or URS can place an interaction
into a specified workbin instance. The workbin must be defined for the tenant
that the interaction belongs to.
Direction: From URS or agent application to Interaction Server.
The following properties have been deprecated: AddedProperties, ChangedProperties, and DeletedProperties.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestPlaceInWorkbin |
create()
Creates instance of RequestPlaceInWorkbin with no parameters set. |
static RequestPlaceInWorkbin |
create(java.lang.Integer proxyClientId,
KeyValueCollection extension,
java.lang.String interactionId,
java.lang.Boolean hold,
WorkbinInfo workbin,
ReasonInfo reason)
Creates instance of RequestPlaceInWorkbin. |
static RequestPlaceInWorkbin |
create(java.lang.Integer proxyClientId,
KeyValueCollection extension,
java.lang.String interactionId,
WorkbinInfo workbin,
KeyValueCollection addedProperties,
KeyValueCollection changedProperties,
KeyValueCollection deletedProperties,
ReasonInfo reason)
Deprecated. use other create methods. (Obsolete since 8.0.0) |
static RequestPlaceInWorkbin |
create(java.lang.Integer proxyClientId,
KeyValueCollection extension,
java.lang.String interactionId,
WorkbinInfo workbin,
ReasonInfo reason)
Deprecated. use other create methods. (Obsolete since 8.0.1) |
static RequestPlaceInWorkbin |
create(java.lang.String interactionId,
WorkbinInfo workbin,
ReasonInfo reason)
Creates instance of RequestPlaceInWorkbin. |
abstract KeyValueCollection |
getAddedProperties()
Deprecated. |
abstract KeyValueCollection |
getChangedProperties()
Deprecated. |
abstract KeyValueCollection |
getDeletedProperties()
Deprecated. |
abstract KeyValueCollection |
getExtension()
A key-value list of extensions. |
abstract java.lang.Boolean |
getHold()
|
abstract java.lang.String |
getInteractionId()
Identifier of the interaction being accepted. |
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 |
setAddedProperties(KeyValueCollection addedProperties)
Deprecated. |
abstract void |
setChangedProperties(KeyValueCollection changedProperties)
Deprecated. |
abstract void |
setDeletedProperties(KeyValueCollection deletedProperties)
Deprecated. |
abstract void |
setExtension(KeyValueCollection extension)
A key-value list of extensions. |
abstract void |
setHold(java.lang.Boolean hold)
|
abstract void |
setInteractionId(java.lang.String interactionId)
Identifier of the interaction being accepted. |
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 RequestPlaceInWorkbin create()
public static RequestPlaceInWorkbin create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String interactionId, WorkbinInfo workbin, KeyValueCollection addedProperties, KeyValueCollection changedProperties, KeyValueCollection deletedProperties, ReasonInfo reason)
proxyClientId
- The identifier of the client of proxy.extension
- Extensions.interactionId
- Interaction identifier.workbin
- WorkbinaddedProperties
- List of properties to change.changedProperties
- List of properties to change. Note that since Interaction Server does not allow duplicated properties, the lists of added and changed are treated the same way.deletedProperties
- List of properties to delete.reason
- Reason.
public static RequestPlaceInWorkbin create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String interactionId, WorkbinInfo workbin, ReasonInfo reason)
proxyClientId
- The identifier of the client of proxy.extension
- Extensions.interactionId
- Interaction identifier.workbin
- Workbinreason
- Reason.
public static RequestPlaceInWorkbin create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String interactionId, java.lang.Boolean hold, WorkbinInfo workbin, ReasonInfo reason)
proxyClientId
- The identifier of the client of proxy.extension
- Extensions.interactionId
- Interaction identifier.hold
- workbin
- Workbinreason
- Reason.
public static RequestPlaceInWorkbin create(java.lang.String interactionId, WorkbinInfo workbin, ReasonInfo reason)
interactionId
- Interaction identifier.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 KeyValueCollection getExtension()
public abstract void setExtension(KeyValueCollection extension)
public abstract java.lang.String getInteractionId()
public abstract void setInteractionId(java.lang.String interactionId)
public abstract java.lang.Boolean getHold()
public abstract void setHold(java.lang.Boolean hold)
hold
- new value of the propertypublic abstract WorkbinInfo getWorkbin()
public abstract void setWorkbin(WorkbinInfo workbin)
@Deprecated public abstract KeyValueCollection getAddedProperties()
@Deprecated public abstract void setAddedProperties(KeyValueCollection addedProperties)
@Deprecated public abstract KeyValueCollection getChangedProperties()
@Deprecated public abstract void setChangedProperties(KeyValueCollection changedProperties)
@Deprecated public abstract KeyValueCollection getDeletedProperties()
@Deprecated public abstract void setDeletedProperties(KeyValueCollection deletedProperties)
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 |