|
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.RequestPlaceInQueue
public abstract class RequestPlaceInQueue
With this request, an agent application or URS can place an interaction
into a specified queue. The queue 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 RequestPlaceInQueue |
create()
Creates instance of RequestPlaceInQueue with no parameters set. |
static RequestPlaceInQueue |
create(java.lang.Integer proxyClientId,
KeyValueCollection extension,
java.lang.String interactionId,
java.lang.String queue,
java.lang.Boolean hold,
ReasonInfo reason)
Creates instance of RequestPlaceInQueue. |
static RequestPlaceInQueue |
create(java.lang.Integer proxyClientId,
KeyValueCollection extension,
java.lang.String interactionId,
java.lang.String queue,
KeyValueCollection addedProperties,
KeyValueCollection changedProperties,
KeyValueCollection deletedProperties,
ReasonInfo reason)
Deprecated. use other create methods. (Obsolete since 8.0.0) |
static RequestPlaceInQueue |
create(java.lang.Integer proxyClientId,
KeyValueCollection extension,
java.lang.String interactionId,
java.lang.String queue,
ReasonInfo reason)
Deprecated. use other create methods. (Obsolete since 8.0.1) |
static RequestPlaceInQueue |
create(java.lang.String interactionId,
java.lang.String queue,
ReasonInfo reason)
Creates instance of RequestPlaceInQueue. |
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 java.lang.String |
getQueue()
Name of the queue that the interaction was in previously. |
abstract ReasonInfo |
getReason()
This property has been deprecated in all events. |
abstract java.lang.Integer |
getReferenceId()
Reference identifier of the request. |
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 |
setQueue(java.lang.String queue)
Name of the queue that the interaction was in previously. |
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. |
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 RequestPlaceInQueue create()
public static RequestPlaceInQueue create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String interactionId, java.lang.String queue, KeyValueCollection addedProperties, KeyValueCollection changedProperties, KeyValueCollection deletedProperties, ReasonInfo reason)
proxyClientId
- The identifier of the client of proxy.extension
- Extensions.interactionId
- Interaction identifier.queue
- Queue name to submit interaction into. The queue should be configured for the tenant.addedProperties
- 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 RequestPlaceInQueue create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String interactionId, java.lang.String queue, ReasonInfo reason)
proxyClientId
- The identifier of the client of proxy.extension
- Extensions.interactionId
- Interaction identifier.queue
- Queue name to submit interaction into. The queue should be configured for the tenant.reason
- Reason.
public static RequestPlaceInQueue create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String interactionId, java.lang.String queue, java.lang.Boolean hold, ReasonInfo reason)
proxyClientId
- The identifier of the client of proxy.extension
- Extensions.interactionId
- Interaction identifier.queue
- Queue name to submit interaction into. The queue should be configured for the tenant.hold
- reason
- Reason.
public static RequestPlaceInQueue create(java.lang.String interactionId, java.lang.String queue, ReasonInfo reason)
interactionId
- Interaction identifier.queue
- Queue name to submit interaction into. The queue should be configured for the tenant.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 getInteractionId()
public abstract void setInteractionId(java.lang.String interactionId)
public abstract java.lang.String getQueue()
public abstract void setQueue(java.lang.String queue)
@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 java.lang.Boolean getHold()
public abstract void setHold(java.lang.Boolean hold)
hold
- 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 |