|
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.RequestLockInteraction
public abstract class RequestLockInteraction
With this request, an agent application asks Interaction Server to lock a specified
interaction in the context of a specified snapshot. Locked interactions not visible
to views and cannot be pulled from queues by URS or an agent.
Direction: From agent application to Interaction Server.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestLockInteraction |
create()
Creates instance of RequestLockInteraction with no parameters set. |
static RequestLockInteraction |
create(java.lang.Integer proxyClientId,
KeyValueCollection extension,
java.lang.String interactionId,
java.lang.Integer snapshotId,
ReasonInfo reason)
Creates instance of RequestLockInteraction with all parameters set. |
static RequestLockInteraction |
create(java.lang.String interactionId,
java.lang.Integer snapshotId,
ReasonInfo reason)
Creates instance of RequestLockInteraction with required parameters set. |
abstract KeyValueCollection |
getExtension()
A key-value list of extensions. |
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 java.lang.Integer |
getSnapshotId()
If specified, must be the identifier of a snapshot that the client has taken previously. |
abstract void |
setExtension(KeyValueCollection extension)
A key-value list of extensions. |
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 |
setSnapshotId(int snapshotId)
If specified, must be the identifier of a snapshot that the client has taken previously. |
abstract void |
setSnapshotId(java.lang.Integer snapshotId)
If specified, must be the identifier of a snapshot that the client has taken previously. |
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 RequestLockInteraction create()
public static RequestLockInteraction create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String interactionId, java.lang.Integer snapshotId, ReasonInfo reason)
proxyClientId
- The identifier of the client of proxy.extension
- Extensions.interactionId
- Interaction identifier.snapshotId
- If specified, should represent an identifier of the snapshot that client has taken before. The new snapshot will inherit all the locks that the older snapshot held. The identifier of the new snapshot is the same as the old snapshot. Old snapshot is automatically released.reason
- Reason.
public static RequestLockInteraction create(java.lang.String interactionId, java.lang.Integer snapshotId, ReasonInfo reason)
interactionId
- Interaction identifier.snapshotId
- If specified, should represent an identifier of the snapshot that client has taken before. The new snapshot will inherit all the locks that the older snapshot held. The identifier of the new snapshot is the same as the old snapshot. Old snapshot is automatically released.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.Integer getSnapshotId()
public abstract void setSnapshotId(java.lang.Integer snapshotId)
public abstract void setSnapshotId(int snapshotId)
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 |