|
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.RequestGetInteractionProperties
public abstract class RequestGetInteractionProperties
The purpose is to provide the ability for the client to get interaction properties by external id instead of interaction id.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestGetInteractionProperties |
create()
Creates instance of RequestGetInteractionProperties with no parameters set. |
static RequestGetInteractionProperties |
create(java.lang.String interactionId)
Creates instance of RequestGetInteractionProperties. |
static RequestGetInteractionProperties |
create(java.lang.String interactionId,
java.lang.Integer proxyClientId,
java.lang.Boolean searchByExternalId)
Deprecated. use other create methods |
static RequestGetInteractionProperties |
create(java.lang.String interactionId,
java.lang.Integer proxyClientId,
java.lang.Boolean searchByExternalId,
KeyValueCollection extension)
Creates instance of RequestGetInteractionProperties. |
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 java.lang.Integer |
getReferenceId()
Reference identifier of the request. |
abstract java.lang.Boolean |
getSearchByExternalId()
[optional; default is 'false'] 'true' value indicates that attr_itx_id of the request should be interpreted as external id instead of interaction id. |
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 |
setReferenceId(int referenceId)
Reference identifier of the request. |
abstract void |
setReferenceId(java.lang.Integer referenceId)
Reference identifier of the request. |
abstract void |
setSearchByExternalId(java.lang.Boolean searchByExternalId)
[optional; default is 'false'] 'true' value indicates that attr_itx_id of the request should be interpreted as external id instead of interaction id. |
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 RequestGetInteractionProperties create()
public static RequestGetInteractionProperties create(java.lang.String interactionId, java.lang.Integer proxyClientId, java.lang.Boolean searchByExternalId)
interactionId
- Interaction identifier.proxyClientId
- The identifier of the client of proxy.searchByExternalId
- [optional; default is 'false'] 'true' value indicates that attr_itx_id of the request should be interpreted as external id instead of interaction id.
public static RequestGetInteractionProperties create(java.lang.String interactionId)
interactionId
- Interaction identifier.
public static RequestGetInteractionProperties create(java.lang.String interactionId, java.lang.Integer proxyClientId, java.lang.Boolean searchByExternalId, KeyValueCollection extension)
interactionId
- Interaction identifier.proxyClientId
- The identifier of the client of proxy.searchByExternalId
- [optional; default is 'false'] 'true' value indicates that attr_itx_id of the request should be interpreted as external id instead of interaction id.extension
- Extensions.
public abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract java.lang.String getInteractionId()
public abstract void setInteractionId(java.lang.String interactionId)
public abstract java.lang.Integer getProxyClientId()
public abstract void setProxyClientId(java.lang.Integer proxyClientId)
public abstract void setProxyClientId(int proxyClientId)
public abstract java.lang.Boolean getSearchByExternalId()
public abstract void setSearchByExternalId(java.lang.Boolean searchByExternalId)
searchByExternalId
- new value of the propertypublic abstract KeyValueCollection getExtension()
public abstract void setExtension(KeyValueCollection extension)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |