|
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.RequestStartPlaceAgentStateReporting
public abstract class RequestStartPlaceAgentStateReporting
With this request, the reporting engine can register with Interaction Server to receive reporting events regarding a specified resource. As a result of successful registration, the reporting engine will receive unsolicited events related to the specified resource.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestStartPlaceAgentStateReporting |
create()
Creates instance of RequestStartPlaceAgentStateReporting with no parameters set. |
static RequestStartPlaceAgentStateReporting |
create(java.lang.Integer proxyClientId,
java.lang.String placeId,
java.lang.Integer tenantId,
KeyValueCollection extension)
Creates instance of RequestStartPlaceAgentStateReporting with all parameters set. |
static RequestStartPlaceAgentStateReporting |
create(java.lang.String placeId)
Creates instance of RequestStartPlaceAgentStateReporting with required parameters set. |
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 |
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 RequestStartPlaceAgentStateReporting create()
public static RequestStartPlaceAgentStateReporting create(java.lang.Integer proxyClientId, java.lang.String placeId, java.lang.Integer tenantId, KeyValueCollection extension)
proxyClientId
- The identifier of the client of proxy.placeId
- Place identifier of the resource, if party is a resource.tenantId
- Tenant identifier of the party (dbid from the configuration).extension
- Extensions.
public static RequestStartPlaceAgentStateReporting create(java.lang.String placeId)
placeId
- Place identifier of the resource, if party is a resource.
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 java.lang.String getPlaceId()
public abstract void setPlaceId(java.lang.String placeId)
public abstract java.lang.Integer getTenantId()
public abstract void setTenantId(java.lang.Integer tenantId)
public abstract void setTenantId(int tenantId)
public 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 |