Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.interactionserver.requests.agentmanagement
Class RequestStopPlaceAgentStateReportingAll

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.openmedia.protocol.interactionserver.requests.agentmanagement.RequestStopPlaceAgentStateReportingAll
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestStopPlaceAgentStateReportingAll
extends Message

With this request, the reporting engine can cancel its registration for reporting events regarding specified reportable objects. This request does not necessarily cancel all previous registrations, but it may. This request can be sent multiple times to cancel registration for some specified objects.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestStopPlaceAgentStateReportingAll create()
          Creates instance of RequestStopPlaceAgentStateReportingAll with no parameters set.
static RequestStopPlaceAgentStateReportingAll create(java.lang.Integer proxyClientId, KeyValueCollection tenantList, KeyValueCollection extension)
          Creates instance of RequestStopPlaceAgentStateReportingAll with all parameters set.
static RequestStopPlaceAgentStateReportingAll create(KeyValueCollection tenantList)
          Creates instance of RequestStopPlaceAgentStateReportingAll with required parameters set.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  java.lang.Integer getProxyClientId()
          Proxy client identifier.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  KeyValueCollection getTenantList()
          List of reportable objects that reporting engine wants to receive reporting events for.
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
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 setTenantList(KeyValueCollection tenantList)
          List of reportable objects that reporting engine wants to receive reporting events for.
 
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

ID

public static final int ID
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values
Method Detail

create

public static RequestStopPlaceAgentStateReportingAll create()
Creates instance of RequestStopPlaceAgentStateReportingAll with no parameters set.

Returns:
instance of RequestStopPlaceAgentStateReportingAll

create

public static RequestStopPlaceAgentStateReportingAll create(java.lang.Integer proxyClientId,
                                                            KeyValueCollection tenantList,
                                                            KeyValueCollection extension)
Creates instance of RequestStopPlaceAgentStateReportingAll with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
tenantList -
extension - Extensions.
Returns:
instance of RequestStopPlaceAgentStateReportingAll

create

public static RequestStopPlaceAgentStateReportingAll create(KeyValueCollection tenantList)
Creates instance of RequestStopPlaceAgentStateReportingAll with required parameters set.

Parameters:
tenantList -
Returns:
instance of RequestStopPlaceAgentStateReportingAll

getReferenceId

public abstract java.lang.Integer getReferenceId()
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


setReferenceId

public abstract void setReferenceId(int referenceId)
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


getProxyClientId

public abstract java.lang.Integer getProxyClientId()
Proxy client identifier. Mandatory if client connects via proxy.


setProxyClientId

public abstract void setProxyClientId(java.lang.Integer proxyClientId)
Proxy client identifier. Mandatory if client connects via proxy.


setProxyClientId

public abstract void setProxyClientId(int proxyClientId)
Proxy client identifier. Mandatory if client connects via proxy.


getTenantList

public abstract KeyValueCollection getTenantList()
List of reportable objects that reporting engine wants to receive reporting events for.

If the list is empty, Interaction Server assumes that the reporting engine wants to register for all reportable objects.

If the list includes a key-value pair with the key ESP:
If a key-value pair with the key equal to some tenant identifier (database ID) is present in the list:


setTenantList

public abstract void setTenantList(KeyValueCollection tenantList)
List of reportable objects that reporting engine wants to receive reporting events for.

If the list is empty, Interaction Server assumes that the reporting engine wants to register for all reportable objects.

If the list includes a key-value pair with the key ESP:
If a key-value pair with the key equal to some tenant identifier (database ID) is present in the list:


getExtension

public abstract KeyValueCollection getExtension()
A key-value list of extensions. For media servers the following extensions are defined, with values of type integer:


setExtension

public abstract void setExtension(KeyValueCollection extension)
A key-value list of extensions. For media servers the following extensions are defined, with values of type integer:


Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.