|
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.agentmanagement.RequestAgentState
public abstract class RequestAgentState
The purpose of this request is to allow agent application (or a proxy application) to get agent state after reconnect to Interaction Server.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestAgentState |
create()
Creates instance of RequestAgentState with no parameters set. |
static RequestAgentState |
create(java.lang.Integer tenantId)
Creates instance of RequestAgentState. Using only mandatory parameters set. |
static RequestAgentState |
create(java.lang.Integer proxyClientId,
KeyValueCollection extension,
java.lang.Integer tenantId,
java.lang.String agentId,
java.lang.String placeId)
Creates instance of RequestAgentState. Using all parameters set. |
abstract java.lang.String |
getAgentId()
Agent identifier of the resource, if the Party is a resource and if the resource logged in with its agent identifier specified. |
abstract KeyValueCollection |
getExtension()
A key-value list of extensions. |
abstract java.lang.String |
getPlaceId()
Place identifier of the resource, if the Party is a resource. |
abstract java.lang.Integer |
getProxyClientId()
Proxy client identifier. |
abstract java.lang.Integer |
getReferenceId()
Reference identifier of the request. |
abstract java.lang.Integer |
getTenantId()
Tenant identifier of the Party (database ID from the configuration). |
abstract void |
setAgentId(java.lang.String agentId)
Agent identifier of the resource, if the Party is a resource and if the resource logged in with its agent identifier specified. |
abstract void |
setExtension(KeyValueCollection extension)
A key-value list of extensions. |
abstract void |
setPlaceId(java.lang.String placeId)
Place identifier of the resource, if the Party is a resource. |
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 |
setTenantId(int tenantId)
Tenant identifier of the Party (database ID from the configuration). |
abstract void |
setTenantId(java.lang.Integer tenantId)
Tenant identifier of the Party (database ID from the configuration). |
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 RequestAgentState create()
public static RequestAgentState create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.Integer tenantId, java.lang.String agentId, java.lang.String placeId)
proxyClientId
- The identifier of the client of proxy.extension
- Extensions.tenantId
- Tenant identifier of the party (dbid from the configuration).agentId
- Agent identifier of the resource, if party is a resource and if resource logged in with agent identifier specified.placeId
- Place identifier of the resource, if party is a resource.
public static RequestAgentState create(java.lang.Integer tenantId)
tenantId
- Tenant identifier of the party (dbid from the configuration).
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.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract java.lang.Integer getTenantId()
public abstract void setTenantId(java.lang.Integer tenantId)
public abstract void setTenantId(int tenantId)
public abstract java.lang.String getAgentId()
public abstract void setAgentId(java.lang.String agentId)
public abstract java.lang.String getPlaceId()
public abstract void setPlaceId(java.lang.String placeId)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |