Platform SDK Java 8.5 API Reference

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

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

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

PartyInfo class.


Constructor Summary
PartyInfo()
           
 
Method Summary
static PartyInfo create()
          Creates instance of PartyInfo with no parameters set.
static PartyInfo create(PartyType partyType, java.lang.Integer tenantId, java.lang.String strategyId, java.lang.String routerId, java.lang.String placeId, java.lang.String agentId, TargetType targetType, java.lang.String targetQueue, java.lang.String targetWorkbin, java.lang.String targetPlace, java.lang.String targetAgent, java.lang.String targetPlaceGroup, java.lang.String targetAgentGroup, VisibilityMode visibilityMode)
          Creates instance of PartyInfo 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  PartyType getPartyType()
          Values: 1: Party is a strategy. 2: Party is a resource.
abstract  java.lang.String getPlaceId()
          Place identifier of the resource, if the Party is a resource.
abstract  java.lang.String getRouterId()
          Name of the URS that the strategy is loaded by, if the Party is a strategy.
abstract  java.lang.String getStrategyId()
          Name of the strategy, if the Party is a strategy.
abstract  java.lang.String getTargetAgent()
          Agent employee identifier if target is an agent or workbin owner id if target is an agent workbin
abstract  java.lang.String getTargetAgentGroup()
          Indicates workbin owner if target is an agent group workbin
abstract  java.lang.String getTargetPlace()
          Place name if target is an agent or workbin owner id if target is a place workbin
abstract  java.lang.String getTargetPlaceGroup()
          Indicates workbin owner if target is a place group workbin
abstract  java.lang.String getTargetQueue()
          Name of the queue if target is a queue or workbin
abstract  TargetType getTargetType()
          [optional] Specifies target type – destination of the interaction.
abstract  java.lang.String getTargetWorkbin()
          Name of the workbin if target is a workbin; exactly one of the workbin owner identifiers is present in the event depending on the workbin type
abstract  java.lang.Integer getTenantId()
          Tenant identifier of the Party (database ID from the configuration).
abstract  VisibilityMode getVisibilityMode()
          Values: 0-unknown 1-conference 2-monitor 3-coach
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 setPartyType(PartyType partyType)
          Values: 1: Party is a strategy. 2: Party is a resource.
abstract  void setPlaceId(java.lang.String placeId)
          Place identifier of the resource, if the Party is a resource.
abstract  void setRouterId(java.lang.String routerId)
          Name of the URS that the strategy is loaded by, if the Party is a strategy.
abstract  void setStrategyId(java.lang.String strategyId)
          Name of the strategy, if the Party is a strategy.
abstract  void setTargetAgent(java.lang.String targetAgent)
          Agent employee identifier if target is an agent or workbin owner id if target is an agent workbin
abstract  void setTargetAgentGroup(java.lang.String targetAgentGroup)
          Indicates workbin owner if target is an agent group workbin
abstract  void setTargetPlace(java.lang.String targetPlace)
          Place name if target is an agent or workbin owner id if target is a place workbin
abstract  void setTargetPlaceGroup(java.lang.String targetPlaceGroup)
          Indicates workbin owner if target is a place group workbin
abstract  void setTargetQueue(java.lang.String targetQueue)
          Name of the queue if target is a queue or workbin
abstract  void setTargetType(TargetType targetType)
          [optional] Specifies target type – destination of the interaction.
abstract  void setTargetWorkbin(java.lang.String targetWorkbin)
          Name of the workbin if target is a workbin; exactly one of the workbin owner identifiers is present in the event depending on the workbin type
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).
abstract  void setVisibilityMode(VisibilityMode visibilityMode)
          Values: 0-unknown 1-conference 2-monitor 3-coach
 
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

PartyInfo

public PartyInfo()
Method Detail

create

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

Returns:
instance of PartyInfo

create

public static PartyInfo create(PartyType partyType,
                               java.lang.Integer tenantId,
                               java.lang.String strategyId,
                               java.lang.String routerId,
                               java.lang.String placeId,
                               java.lang.String agentId,
                               TargetType targetType,
                               java.lang.String targetQueue,
                               java.lang.String targetWorkbin,
                               java.lang.String targetPlace,
                               java.lang.String targetAgent,
                               java.lang.String targetPlaceGroup,
                               java.lang.String targetAgentGroup,
                               VisibilityMode visibilityMode)
Creates instance of PartyInfo with all parameters set.

Parameters:
partyType - Party type: 1 - party is a strategy, 2 - party is a resource
tenantId - Tenant identifier of the party (dbid from the configuration).
strategyId - Name of the strategy, if party is a strategy.
routerId - Name of the router the strategy is loaded by, if party is a strategy.
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.
targetType - [optional] Specifies target type – destination of the interaction.
targetQueue - Name of the queue if target is a queue or workbin
targetWorkbin - Name of the workbin if target is a workbin; exactly one of the workbin owner identifiers is present in the event depending on the workbin type
targetPlace - Place name if target is an agent or workbin owner id if target is a place workbin
targetAgent - Agent employee identifier if target is an agent or workbin owner id if target is an agent workbin
targetPlaceGroup - Indicates workbin owner if target is a place group workbin
targetAgentGroup - Indicates workbin owner if target is an agent group workbin
visibilityMode - The following values are possible: 1 - conference, 2 - monitor, 3 - coach. Default value is 1 - conference.
Returns:
instance of PartyInfo

getPartyType

public abstract PartyType getPartyType()
Values:


setPartyType

public abstract void setPartyType(PartyType partyType)
Values:


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


getStrategyId

public abstract java.lang.String getStrategyId()
Name of the strategy, if the Party is a strategy.


setStrategyId

public abstract void setStrategyId(java.lang.String strategyId)
Name of the strategy, if the Party is a strategy.


getRouterId

public abstract java.lang.String getRouterId()
Name of the URS that the strategy is loaded by, if the Party is a strategy.


setRouterId

public abstract void setRouterId(java.lang.String routerId)
Name of the URS that the strategy is loaded by, if the Party is a strategy.


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.


getTargetType

public abstract TargetType getTargetType()
[optional] Specifies target type – destination of the interaction.

Returns:
property value

setTargetType

public abstract void setTargetType(TargetType targetType)
[optional] Specifies target type – destination of the interaction.

Parameters:
targetType - new value of the property

getTargetQueue

public abstract java.lang.String getTargetQueue()
Name of the queue if target is a queue or workbin

Returns:
property value

setTargetQueue

public abstract void setTargetQueue(java.lang.String targetQueue)
Name of the queue if target is a queue or workbin

Parameters:
targetQueue - new value of the property

getTargetWorkbin

public abstract java.lang.String getTargetWorkbin()
Name of the workbin if target is a workbin; exactly one of the workbin owner identifiers is present in the event depending on the workbin type

Returns:
property value

setTargetWorkbin

public abstract void setTargetWorkbin(java.lang.String targetWorkbin)
Name of the workbin if target is a workbin; exactly one of the workbin owner identifiers is present in the event depending on the workbin type

Parameters:
targetWorkbin - new value of the property

getTargetPlace

public abstract java.lang.String getTargetPlace()
Place name if target is an agent or workbin owner id if target is a place workbin

Returns:
property value

setTargetPlace

public abstract void setTargetPlace(java.lang.String targetPlace)
Place name if target is an agent or workbin owner id if target is a place workbin

Parameters:
targetPlace - new value of the property

getTargetAgent

public abstract java.lang.String getTargetAgent()
Agent employee identifier if target is an agent or workbin owner id if target is an agent workbin

Returns:
property value

setTargetAgent

public abstract void setTargetAgent(java.lang.String targetAgent)
Agent employee identifier if target is an agent or workbin owner id if target is an agent workbin

Parameters:
targetAgent - new value of the property

getTargetPlaceGroup

public abstract java.lang.String getTargetPlaceGroup()
Indicates workbin owner if target is a place group workbin

Returns:
property value

setTargetPlaceGroup

public abstract void setTargetPlaceGroup(java.lang.String targetPlaceGroup)
Indicates workbin owner if target is a place group workbin

Parameters:
targetPlaceGroup - new value of the property

getTargetAgentGroup

public abstract java.lang.String getTargetAgentGroup()
Indicates workbin owner if target is an agent group workbin

Returns:
property value

setTargetAgentGroup

public abstract void setTargetAgentGroup(java.lang.String targetAgentGroup)
Indicates workbin owner if target is an agent group workbin

Parameters:
targetAgentGroup - new value of the property

getVisibilityMode

public abstract VisibilityMode getVisibilityMode()
Values:


setVisibilityMode

public abstract void setVisibilityMode(VisibilityMode visibilityMode)
Values:


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.