Platform SDK Java 8.5 API Reference

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

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

public abstract class EventCurrentAgentStatus
extends Message

Stat Server uses this event to indicate the status of a particular resource. It calculates this status according to current resource state, media states, and capacity rules. Stat Server sends this event to Interaction Server, which relays it to the agent application that is responsible for the specified resource. The agent application can then display the resource's current status.

Direction: from the reporting engine to Interaction Server.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventCurrentAgentStatus create()
          Creates instance of EventCurrentAgentStatus with no parameters set.
static EventCurrentAgentStatus create(java.lang.Boolean donotDisturb, KeyValueCollection mediaStateList, KeyValueCollection mediaCapacityList, AgentDescription agentDescription)
          Creates instance of EventCurrentAgentStatus with required parameters set.
static EventCurrentAgentStatus create(java.lang.Integer proxyClientId, java.lang.Boolean donotDisturb, KeyValueCollection mediaStateList, KeyValueCollection mediaCapacityList, AgentDescription agentDescription, KeyValueCollection extension, java.util.Date eventTime)
          Creates instance of EventCurrentAgentStatus with all parameters set.
abstract  AgentDescription getAgentDescription()
           
abstract  java.lang.Boolean getDonotDisturb()
          'Do not disturb' mode indicator.
abstract  java.util.Date getEventTime()
          Date and time of the event.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  KeyValueCollection getMediaCapacityList()
          List of media types with the current capacity indicated by Stat Server.
abstract  KeyValueCollection getMediaStateList()
          List of media types and their initial states.
abstract  java.lang.Integer getProxyClientId()
          Proxy client identifier.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  void setAgentDescription(AgentDescription agentDescription)
           
abstract  void setDonotDisturb(java.lang.Boolean donotDisturb)
          'Do not disturb' mode indicator.
abstract  void setEventTime(java.util.Date eventTime)
          Date and time of the event.
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setMediaCapacityList(KeyValueCollection mediaCapacityList)
          List of media types with the current capacity indicated by Stat Server.
abstract  void setMediaStateList(KeyValueCollection mediaStateList)
          List of media types and their initial states.
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.
 
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 EventCurrentAgentStatus create()
Creates instance of EventCurrentAgentStatus with no parameters set.

Returns:
instance of EventCurrentAgentStatus

create

public static EventCurrentAgentStatus create(java.lang.Integer proxyClientId,
                                             java.lang.Boolean donotDisturb,
                                             KeyValueCollection mediaStateList,
                                             KeyValueCollection mediaCapacityList,
                                             AgentDescription agentDescription,
                                             KeyValueCollection extension,
                                             java.util.Date eventTime)
Creates instance of EventCurrentAgentStatus with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
donotDisturb - Default value is 'false'. 'True' value indicates that initially 'do not disturb' mode is ON.
mediaStateList - List of media types agent logs in to. Each key is media type name (system identifier of enumerator value). Each Value is an integer: 1 ' agent is ready for the media; 0 ' agent is not ready for the media.
mediaCapacityList - Current capacity information. Each key is a media type name (system identifier of enumerator value).
agentDescription - AgentDescription
extension - Extensions.
eventTime - Date and time of the event.
Returns:
instance of EventCurrentAgentStatus

create

public static EventCurrentAgentStatus create(java.lang.Boolean donotDisturb,
                                             KeyValueCollection mediaStateList,
                                             KeyValueCollection mediaCapacityList,
                                             AgentDescription agentDescription)
Creates instance of EventCurrentAgentStatus with required parameters set.

Parameters:
donotDisturb - Default value is 'false'. 'True' value indicates that initially 'do not disturb' mode is ON.
mediaStateList - List of media types agent logs in to. Each key is media type name (system identifier of enumerator value). Each Value is an integer: 1 ' agent is ready for the media; 0 ' agent is not ready for the media.
mediaCapacityList - Current capacity information. Each key is a media type name (system identifier of enumerator value).
agentDescription - AgentDescription
Returns:
instance of EventCurrentAgentStatus

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.


getDonotDisturb

public abstract java.lang.Boolean getDonotDisturb()
'Do not disturb' mode indicator. 'True' value indicates that 'do not disturb' mode is on. 'False' is a default value and indicates that 'do not disturb' mode is off. Null means default value (i.e. the mode is off).


setDonotDisturb

public abstract void setDonotDisturb(java.lang.Boolean donotDisturb)
'Do not disturb' mode indicator. 'True' value indicates that 'do not disturb' mode is on. 'False' is a default value and indicates that 'do not disturb' mode is off. Null means default value (i.e. the mode is off).


getMediaStateList

public abstract KeyValueCollection getMediaStateList()
List of media types and their initial states. The key names are the system names of the media types that the resource supports. The values are integers that indicate the initial state of the media:


setMediaStateList

public abstract void setMediaStateList(KeyValueCollection mediaStateList)
List of media types and their initial states. The key names are the system names of the media types that the resource supports. The values are integers that indicate the initial state of the media:


getMediaCapacityList

public abstract KeyValueCollection getMediaCapacityList()
List of media types with the current capacity indicated by Stat Server.


setMediaCapacityList

public abstract void setMediaCapacityList(KeyValueCollection mediaCapacityList)
List of media types with the current capacity indicated by Stat Server.


getAgentDescription

public abstract AgentDescription getAgentDescription()

setAgentDescription

public abstract void setAgentDescription(AgentDescription agentDescription)

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:


getEventTime

public abstract java.util.Date getEventTime()
Date and time of the event.


setEventTime

public abstract void setEventTime(java.util.Date eventTime)
Date and time of the event.


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.