Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.interactionserver.events
Class AgentDescription

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.runtime.CompoundValue
          extended by com.genesyslab.platform.openmedia.protocol.interactionserver.events.AgentDescription
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class AgentDescription
extends com.genesyslab.platform.commons.protocol.runtime.CompoundValue

AgentDescription class.


Constructor Summary
AgentDescription()
           
 
Method Summary
static AgentDescription create()
          Creates instance of AgentDescription with no parameters set.
static AgentDescription create(java.lang.Integer tenantId, java.lang.String placeId)
          Creates instance of AgentDescription with required parameters set.
static AgentDescription create(java.lang.Integer tenantId, java.lang.String placeId, java.lang.String agentId)
          Creates instance of AgentDescription with 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  java.lang.String getPlaceId()
          Place identifier of the resource, if the Party is a resource.
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 setPlaceId(java.lang.String placeId)
          Place identifier of the resource, if the Party is a resource.
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.runtime.CompoundValue
getProtocolDescription
 
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
 

Constructor Detail

AgentDescription

public AgentDescription()
Method Detail

create

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

Returns:
instance of AgentDescription

create

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

Parameters:
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 AgentDescription

create

public static AgentDescription create(java.lang.Integer tenantId,
                                      java.lang.String placeId)
Creates instance of AgentDescription with required parameters set.

Parameters:
tenantId - Tenant identifier of the party (dbid from the configuration).
placeId - Place identifier of the resource, if party is a resource.
Returns:
instance of AgentDescription

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.