Platform SDK Java 8.5 API Reference

com.genesyslab.platform.reporting.protocol.statserver.requests
Class RequestGetStatistic

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

public abstract class RequestGetStatistic
extends Message

Requests one-time notification about a particular predefined statistic.
Note, this request is not applicable to the CurrentTargetState category.

Required parameters:

Name Description
StatisticMetric Contains the StatisticType and TimeProfile to be used in gathering data for the requested statistic object.
StatisticObject The statistic object for which data is requested.

Related Events:
Name Description
EventCurrentTargetStateSnapshot Contains the CurrentTargetStateSnapshot data structure, which includes information about routing targets such as agent, place, agent group, and place group states.
EventInfo Contains information about a statistics request that does not concern a routing target.
EventError Indicates that the request encountered an error.

Example:

 RequestGetStatistic req = RequestGetStatistic.create();
 StatisticObject object = StatisticObject.create();
 object.setObjectId("An_Agent");
 object.setObjectType(StatisticObjectType.Agent);
 object.setTenantName("The_Tenant");
 object.setTenantPassword("password");
 req.setStatisticObject(object);
 
 StatisticMetric statisticMetric = StatisticMetric.create("TotalLoginTime");
 req.setStatisticMetric(statisticMetric);
 
 Message response = statProtocol.request(req);
 


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestGetStatistic create()
          Creates instance of RequestGetStatistic with no parameters set.
static RequestGetStatistic create(StatisticObject statisticObject, StatisticMetric statisticMetric)
          Creates instance of RequestGetStatistic with required parameters set.
static RequestGetStatistic create(StatisticObject statisticObject, StatisticMetric statisticMetric, KeyValueCollection extensions, java.lang.Integer tag)
          Creates instance of RequestGetStatistic with all parameters set.
abstract  KeyValueCollection getExtensions()
           
abstract  java.lang.Integer getReferenceId()
          A unique integer that is specified for identification of requested statistics.
abstract  StatisticMetric getStatisticMetric()
           
abstract  StatisticObject getStatisticObject()
           
abstract  java.lang.Integer getTag()
          User reference ID.
abstract  void setExtensions(KeyValueCollection extensions)
           
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 setStatisticMetric(StatisticMetric statisticMetric)
           
abstract  void setStatisticObject(StatisticObject statisticObject)
           
abstract  void setTag(int tag)
          User reference ID.
abstract  void setTag(java.lang.Integer tag)
          User reference ID.
 
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 RequestGetStatistic create()
Creates instance of RequestGetStatistic with no parameters set.

Returns:
instance of RequestGetStatistic

create

public static RequestGetStatistic create(StatisticObject statisticObject,
                                         StatisticMetric statisticMetric,
                                         KeyValueCollection extensions,
                                         java.lang.Integer tag)
Creates instance of RequestGetStatistic with all parameters set.

Parameters:
statisticObject - StatisticObject
statisticMetric - StatisticMetric
extensions - Extensions
tag - Tag
Returns:
instance of RequestGetStatistic

create

public static RequestGetStatistic create(StatisticObject statisticObject,
                                         StatisticMetric statisticMetric)
Creates instance of RequestGetStatistic with required parameters set.

Parameters:
statisticObject - StatisticObject
statisticMetric - StatisticMetric
Returns:
instance of RequestGetStatistic

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.


getStatisticObject

public abstract StatisticObject getStatisticObject()

setStatisticObject

public abstract void setStatisticObject(StatisticObject statisticObject)

getStatisticMetric

public abstract StatisticMetric getStatisticMetric()

setStatisticMetric

public abstract void setStatisticMetric(StatisticMetric statisticMetric)

getExtensions

public abstract KeyValueCollection getExtensions()

setExtensions

public abstract void setExtensions(KeyValueCollection extensions)

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.


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.