|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.openmedia.protocol.interactionserver.events.EventCurrentAgentStatus
public abstract class EventCurrentAgentStatus
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static 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)
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
- AgentDescriptionextension
- Extensions.eventTime
- Date and time of the event.
public static EventCurrentAgentStatus create(java.lang.Boolean donotDisturb, KeyValueCollection mediaStateList, KeyValueCollection mediaCapacityList, AgentDescription agentDescription)
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
public abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract java.lang.Integer getProxyClientId()
public abstract void setProxyClientId(java.lang.Integer proxyClientId)
public abstract void setProxyClientId(int proxyClientId)
public abstract java.lang.Boolean getDonotDisturb()
public abstract void setDonotDisturb(java.lang.Boolean donotDisturb)
public abstract KeyValueCollection getMediaStateList()
public abstract void setMediaStateList(KeyValueCollection mediaStateList)
public abstract KeyValueCollection getMediaCapacityList()
public abstract void setMediaCapacityList(KeyValueCollection mediaCapacityList)
public abstract AgentDescription getAgentDescription()
public abstract void setAgentDescription(AgentDescription agentDescription)
public abstract KeyValueCollection getExtension()
public abstract void setExtension(KeyValueCollection extension)
public abstract java.util.Date getEventTime()
public abstract void setEventTime(java.util.Date eventTime)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |