Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.interactionserver
Class ActorInfo

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

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

ActorInfo class.


Constructor Summary
ActorInfo()
           
 
Method Summary
static ActorInfo create()
          Creates instance of ActorInfo with no parameters set.
static ActorInfo create(ActorType actorType)
          Creates instance of ActorInfo with required parameters set.
static ActorInfo create(ActorType actorType, java.lang.String actorMediaServerId, java.lang.Integer actorTenantId, java.lang.String actorStrategyId, java.lang.String actorRouterId, java.lang.String actorPlaceId, java.lang.String actorAgentId, java.lang.String agentLoginSessionId, java.util.Date loggedInAt)
          Creates instance of ActorInfo with all parameters set.
abstract  java.lang.String getActorAgentId()
          Agent employee ID of the resource.
abstract  java.lang.String getActorMediaServerId()
          Media Server name as defined in the configuration.
abstract  java.lang.String getActorPlaceId()
          Place name of the resource.
abstract  java.lang.String getActorRouterId()
          Name of the URS that is executing the strategy.
abstract  java.lang.String getActorStrategyId()
          Strategy name.
abstract  java.lang.Integer getActorTenantId()
          Tenant identifier of the strategy or resource.
abstract  ActorType getActorType()
          Values: 1: Actor is a strategy. 2: Actor is a resource. 3: Actor is a media server.
abstract  java.lang.String getAgentLoginSessionId()
          Unique identifier of the login session.
abstract  java.util.Date getLoggedInAt()
          Time of login.
abstract  void setActorAgentId(java.lang.String actorAgentId)
          Agent employee ID of the resource.
abstract  void setActorMediaServerId(java.lang.String actorMediaServerId)
          Media Server name as defined in the configuration.
abstract  void setActorPlaceId(java.lang.String actorPlaceId)
          Place name of the resource.
abstract  void setActorRouterId(java.lang.String actorRouterId)
          Name of the URS that is executing the strategy.
abstract  void setActorStrategyId(java.lang.String actorStrategyId)
          Strategy name.
abstract  void setActorTenantId(int actorTenantId)
          Tenant identifier of the strategy or resource.
abstract  void setActorTenantId(java.lang.Integer actorTenantId)
          Tenant identifier of the strategy or resource.
abstract  void setActorType(ActorType actorType)
          Values: 1: Actor is a strategy. 2: Actor is a resource. 3: Actor is a media server.
abstract  void setAgentLoginSessionId(java.lang.String agentLoginSessionId)
          Unique identifier of the login session.
abstract  void setLoggedInAt(java.util.Date loggedInAt)
          Time of login.
 
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

ActorInfo

public ActorInfo()
Method Detail

create

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

Returns:
instance of ActorInfo

create

public static ActorInfo create(ActorType actorType,
                               java.lang.String actorMediaServerId,
                               java.lang.Integer actorTenantId,
                               java.lang.String actorStrategyId,
                               java.lang.String actorRouterId,
                               java.lang.String actorPlaceId,
                               java.lang.String actorAgentId,
                               java.lang.String agentLoginSessionId,
                               java.util.Date loggedInAt)
Creates instance of ActorInfo with all parameters set.

Parameters:
actorType - Actor type: 1 - actor is a strategy, 2 - actor is a resource, 3 - actor is a media server.
actorMediaServerId - Media Server name as defined in configuration. Presents only if actor is a media server.
actorTenantId - Tenant identifier of the strategy or resource. Presents only if actor is a strategy or resource.
actorStrategyId - Strategy name. Presents only if actor is a strategy
actorRouterId - Router name of the router that executing the strategy. Presents only if actor is a strategy.
actorPlaceId - Place name of the resource. Presents only if actor is a resource.
actorAgentId - Agent employee id of the resource. Presents only if actor is a resource and if login has been made with specification of the agent identifier (employee id).
agentLoginSessionId - Unique login session identifier.
loggedInAt - [optional] Agent login timestamp.
Returns:
instance of ActorInfo

create

public static ActorInfo create(ActorType actorType)
Creates instance of ActorInfo with required parameters set.

Parameters:
actorType - Actor type: 1 - actor is a strategy, 2 - actor is a resource, 3 - actor is a media server.
Returns:
instance of ActorInfo

getActorType

public abstract ActorType getActorType()
Values:


setActorType

public abstract void setActorType(ActorType actorType)
Values:


getActorMediaServerId

public abstract java.lang.String getActorMediaServerId()
Media Server name as defined in the configuration. Present only if the Actor is a media server.


setActorMediaServerId

public abstract void setActorMediaServerId(java.lang.String actorMediaServerId)
Media Server name as defined in the configuration. Present only if the Actor is a media server.


getActorTenantId

public abstract java.lang.Integer getActorTenantId()
Tenant identifier of the strategy or resource. Present only if the Actor is a strategy or resource.


setActorTenantId

public abstract void setActorTenantId(java.lang.Integer actorTenantId)
Tenant identifier of the strategy or resource. Present only if the Actor is a strategy or resource.


setActorTenantId

public abstract void setActorTenantId(int actorTenantId)
Tenant identifier of the strategy or resource. Present only if the Actor is a strategy or resource.


getActorStrategyId

public abstract java.lang.String getActorStrategyId()
Strategy name. Present only if the Actor is a strategy.


setActorStrategyId

public abstract void setActorStrategyId(java.lang.String actorStrategyId)
Strategy name. Present only if the Actor is a strategy.


getActorRouterId

public abstract java.lang.String getActorRouterId()
Name of the URS that is executing the strategy. Present only if the Actor is a strategy.


setActorRouterId

public abstract void setActorRouterId(java.lang.String actorRouterId)
Name of the URS that is executing the strategy. Present only if the Actor is a strategy.


getActorPlaceId

public abstract java.lang.String getActorPlaceId()
Place name of the resource. Present only if the Actor is a resource.


setActorPlaceId

public abstract void setActorPlaceId(java.lang.String actorPlaceId)
Place name of the resource. Present only if the Actor is a resource.


getActorAgentId

public abstract java.lang.String getActorAgentId()
Agent employee ID of the resource. Present only if the Actor is a resource and if the resource logged in with its agent identifier (employee ID) specified.


setActorAgentId

public abstract void setActorAgentId(java.lang.String actorAgentId)
Agent employee ID of the resource. Present only if the Actor is a resource and if the resource logged in with its agent identifier (employee ID) specified.


getAgentLoginSessionId

public abstract java.lang.String getAgentLoginSessionId()
Unique identifier of the login session.


setAgentLoginSessionId

public abstract void setAgentLoginSessionId(java.lang.String agentLoginSessionId)
Unique identifier of the login session.


getLoggedInAt

public abstract java.util.Date getLoggedInAt()
Time of login.


setLoggedInAt

public abstract void setLoggedInAt(java.util.Date loggedInAt)
Time of login.


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.