Platform SDK Java 8.5 API Reference

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

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.RequestAgentAvailable
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestAgentAvailable
extends Message

This request is used in configurations with multiple Interaction Servers. With this request, an agent application indicates to secondary Interaction Servers that the agent has logged in with the primary Interaction Server.

The effect of this request differs from that of RequestAgentLogin in that secondary Interaction Servers do not keep track of the agent state, and do not report the agent state to the reporting engine.

Direction: From agent application to Interaction Server.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestAgentAvailable create()
          Creates instance of RequestAgentAvailable with no parameters set.
static RequestAgentAvailable create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.Integer tenantId, java.lang.String placeId, java.lang.String agentId)
          Creates instance of RequestAgentAvailable with all parameters set.
static RequestAgentAvailable create(java.lang.String placeId)
          Creates instance of RequestAgentAvailable with required 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

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 RequestAgentAvailable create()
Creates instance of RequestAgentAvailable with no parameters set.

Returns:
instance of RequestAgentAvailable

create

public static RequestAgentAvailable create(java.lang.Integer proxyClientId,
                                           KeyValueCollection extension,
                                           java.lang.Integer tenantId,
                                           java.lang.String placeId,
                                           java.lang.String agentId)
Creates instance of RequestAgentAvailable with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
extension - Extensions.
tenantId - Tenant identifier of the party (dbid from the configuration).
placeId - Place identifier of the resource, if party is a resource.
agentId - Agent identifier of the resource, if party is a resource and if resource logged in with agent identifier specified.
Returns:
instance of RequestAgentAvailable

create

public static RequestAgentAvailable create(java.lang.String placeId)
Creates instance of RequestAgentAvailable with required parameters set.

Parameters:
placeId - Place identifier of the resource, if party is a resource.
Returns:
instance of RequestAgentAvailable

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.


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:


getTenantId

public abstract java.lang.Integer getTenantId()
Tenant identifier of the Party (database ID from the configuration).


setTenantId

public abstract void setTenantId(java.lang.Integer tenantId)
Tenant identifier of the Party (database ID from the configuration).


setTenantId

public abstract void setTenantId(int tenantId)
Tenant identifier of the Party (database ID from the configuration).


getPlaceId

public abstract java.lang.String getPlaceId()
Place identifier of the resource, if the Party is a resource.


setPlaceId

public abstract void setPlaceId(java.lang.String placeId)
Place identifier of the resource, if the Party is a resource.


getAgentId

public 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.


setAgentId

public 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.


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.