Platform SDK Java 8.5 API Reference

com.genesyslab.platform.reporting.protocol.statserver.events
Class EventCurrentTargetStateSnapshot

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.reporting.protocol.statserver.events.EventCurrentTargetStateSnapshot
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventCurrentTargetStateSnapshot
extends Message

Contains the CurrentTargetStateSnapshot data structure, which includes multimedia-capacity information about agent, place, agent group, and place group states. Issued in response to RequestOpenStatistic, RequestOpenStatisticEx, RequestGetStatistic, RequestGetStatisticEx, or RequestPeekStatistic.

See the Stat Server User's Guide section on "CurrentTargetState" for detailed information on how to work with statistics that include multimedia-capacity information about agent, place, agent group, and place group states.

Selected Properties:

Name Description
ReferenceId ReferenceId of the RequestOpenStatistic, RequestOpenStatisticEx, RequestGetStatistic, RequestGetStatisticEx, RequestPeekStatistic that was used to request the statistic.
IntValue Int value of the statistic.
Tag User reference ID.

Related Requests:
Name Description
RequestGetStatistic Requests one-time notification about a particular predefined statistic.
RequestGetStatisticEx Requests one-time notification about a statistic that is defined in the request.
RequestOpenStatistic Requests that Stat Server start sending information about a predefined statistics.
RequestOpenStatisticEx Requests that Stat Server start sending information about a statistics that is defined in the request.
RequestPeekStatistic Requests immediate recalculation and transmission of the value of a previously opened statistic.

Example:
Here is a sample of the console output for a typical EventCurrentTargetStateSnapshot. Note that the property names used by the Stat Server are different from those used by Platform SDK. The table below gives naming equivalents for the most important properties.

 'EventCurrentTargetStateSnapshot' ('17')
 message attributes:
 CURRENT_TARGET_STATE_INFO [CurrentTargetState] = CurrentTargetStateSnapshot (size=2) [
    [0] CurrentTargetStateInfo {
         AgentDbId = 101
         PlaceDbId = 0
         AgentId = Analyst001
         Extensions = KVList:
                 'VOICE_MEDIA_STATUS' [int] = 0
                 'AGENT_VOICE_MEDIA_STATUS' [int] = 0
     }
    [1] CurrentTargetStateInfo {
         AgentDbId = 110
         PlaceDbId = 0
         AgentId = Developer002
         Extensions = KVList:
                 'VOICE_MEDIA_STATUS' [int] = 0
                 'AGENT_VOICE_MEDIA_STATUS' [int] = 0
     }
 ]
 LONG_VALUE [int] = 0
 TM_LENGTH [int] = 0
 TM_SERVER [int] = 1253828031
 USER_REQ_ID [int] = -1
 REQ_ID [int]    = 1
 
Selected Property Naming Equivalents for Stat Server and Platform SDK:
Stat Server Name Platform SDK Name
REQ_ID ReferenceId
LONG_VALUE IntValue
USER_REQ_ID Tag


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventCurrentTargetStateSnapshot create()
          Creates instance of EventCurrentTargetStateSnapshot with no parameters set.
static EventCurrentTargetStateSnapshot create(java.lang.Integer timestamp, java.lang.Integer intervalLength, java.lang.Integer intValue)
          Creates instance of EventCurrentTargetStateSnapshot with required parameters set.
static EventCurrentTargetStateSnapshot create(java.lang.Integer tag, java.lang.Integer timestamp, java.lang.Integer intervalLength, java.lang.Integer intValue, java.lang.String stringValue, CurrentTargetStateSnapshot currentTargetStateSnapshot)
          Creates instance of EventCurrentTargetStateSnapshot with all parameters set.
abstract  CurrentTargetStateSnapshot getCurrentTargetStateSnapshot()
          Contains updated information on routing objects whose state has been updated after a client has requested a statistic using the CurrentTargetState category - see Stat Server User's Guide for more information.
abstract  java.lang.Integer getIntervalLength()
          Interval length for historical statistics.
abstract  java.lang.Integer getIntValue()
          Specifies which type of profile information (statistical types, time profiles, time ranges, or filters) will be returned from a RequestGetStatisticProfile.
abstract  java.lang.Integer getReferenceId()
          A unique integer that is specified for identification of requested statistics.
abstract  java.lang.String getStringValue()
           
abstract  java.lang.Integer getTag()
          User reference ID.
abstract  java.lang.Integer getTimestamp()
           
abstract  void setCurrentTargetStateSnapshot(CurrentTargetStateSnapshot currentTargetStateSnapshot)
          Contains updated information on routing objects whose state has been updated after a client has requested a statistic using the CurrentTargetState category - see Stat Server User's Guide for more information.
abstract  void setIntervalLength(int intervalLength)
          Interval length for historical statistics.
abstract  void setIntervalLength(java.lang.Integer intervalLength)
          Interval length for historical statistics.
abstract  void setIntValue(int intValue)
          Specifies which type of profile information (statistical types, time profiles, time ranges, or filters) will be returned from a RequestGetStatisticProfile.
abstract  void setIntValue(java.lang.Integer intValue)
          Specifies which type of profile information (statistical types, time profiles, time ranges, or filters) will be returned from a RequestGetStatisticProfile.
abstract  void setReferenceId(int referenceId)
          A unique integer that is specified for identification of requested statistics.
abstract  void setReferenceId(java.lang.Integer referenceId)
          A unique integer that is specified for identification of requested statistics.
abstract  void setStringValue(java.lang.String stringValue)
           
abstract  void setTag(int tag)
          User reference ID.
abstract  void setTag(java.lang.Integer tag)
          User reference ID.
abstract  void setTimestamp(int timestamp)
           
abstract  void setTimestamp(java.lang.Integer timestamp)
           
 
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 EventCurrentTargetStateSnapshot create()
Creates instance of EventCurrentTargetStateSnapshot with no parameters set.

Returns:
instance of EventCurrentTargetStateSnapshot

create

public static EventCurrentTargetStateSnapshot create(java.lang.Integer tag,
                                                     java.lang.Integer timestamp,
                                                     java.lang.Integer intervalLength,
                                                     java.lang.Integer intValue,
                                                     java.lang.String stringValue,
                                                     CurrentTargetStateSnapshot currentTargetStateSnapshot)
Creates instance of EventCurrentTargetStateSnapshot with all parameters set.

Parameters:
tag - Tag
timestamp - Timestamp
intervalLength - IntervalLength
intValue - IntValue
stringValue - StringValue
currentTargetStateSnapshot - CurrentTargetStateSnapshot
Returns:
instance of EventCurrentTargetStateSnapshot

create

public static EventCurrentTargetStateSnapshot create(java.lang.Integer timestamp,
                                                     java.lang.Integer intervalLength,
                                                     java.lang.Integer intValue)
Creates instance of EventCurrentTargetStateSnapshot with required parameters set.

Parameters:
timestamp - Timestamp
intervalLength - IntervalLength
intValue - IntValue
Returns:
instance of EventCurrentTargetStateSnapshot

getReferenceId

public abstract java.lang.Integer getReferenceId()
A unique integer that is specified for identification of requested statistics. This property can be assigned automatically just before sending a message. If property has already been assigned, it will not be modified automatically. If you specify this property on your own, you should guarantee its uniqueness.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
A unique integer that is specified for identification of requested statistics. This property can be assigned automatically just before sending a message. If property has already been assigned, it will not be modified automatically. If you specify this property on your own, you should guarantee its uniqueness.


setReferenceId

public abstract void setReferenceId(int referenceId)
A unique integer that is specified for identification of requested statistics. This property can be assigned automatically just before sending a message. If property has already been assigned, it will not be modified automatically. If you specify this property on your own, you should guarantee its uniqueness.


getTag

public abstract java.lang.Integer getTag()
User reference ID.


setTag

public abstract void setTag(java.lang.Integer tag)
User reference ID.


setTag

public abstract void setTag(int tag)
User reference ID.


getTimestamp

public abstract java.lang.Integer getTimestamp()

setTimestamp

public abstract void setTimestamp(java.lang.Integer timestamp)

setTimestamp

public abstract void setTimestamp(int timestamp)

getIntervalLength

public abstract java.lang.Integer getIntervalLength()
Interval length for historical statistics.


setIntervalLength

public abstract void setIntervalLength(java.lang.Integer intervalLength)
Interval length for historical statistics.


setIntervalLength

public abstract void setIntervalLength(int intervalLength)
Interval length for historical statistics.


getIntValue

public abstract java.lang.Integer getIntValue()
Specifies which type of profile information (statistical types, time profiles, time ranges, or filters) will be returned from a RequestGetStatisticProfile.


setIntValue

public abstract void setIntValue(java.lang.Integer intValue)
Specifies which type of profile information (statistical types, time profiles, time ranges, or filters) will be returned from a RequestGetStatisticProfile.


setIntValue

public abstract void setIntValue(int intValue)
Specifies which type of profile information (statistical types, time profiles, time ranges, or filters) will be returned from a RequestGetStatisticProfile.


getStringValue

public abstract java.lang.String getStringValue()

setStringValue

public abstract void setStringValue(java.lang.String stringValue)

getCurrentTargetStateSnapshot

public abstract CurrentTargetStateSnapshot getCurrentTargetStateSnapshot()
Contains updated information on routing objects whose state has been updated after a client has requested a statistic using the CurrentTargetState category - see Stat Server User's Guide for more information.


setCurrentTargetStateSnapshot

public abstract void setCurrentTargetStateSnapshot(CurrentTargetStateSnapshot currentTargetStateSnapshot)
Contains updated information on routing objects whose state has been updated after a client has requested a statistic using the CurrentTargetState category - see Stat Server User's Guide for more information.


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.