|
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.reporting.protocol.statserver.requests.RequestGetStatistic
public abstract class RequestGetStatistic
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. |
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. |
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static RequestGetStatistic create()
public static RequestGetStatistic create(StatisticObject statisticObject, StatisticMetric statisticMetric, KeyValueCollection extensions, java.lang.Integer tag)
statisticObject
- StatisticObjectstatisticMetric
- StatisticMetricextensions
- Extensionstag
- Tag
public static RequestGetStatistic create(StatisticObject statisticObject, StatisticMetric statisticMetric)
statisticObject
- StatisticObjectstatisticMetric
- StatisticMetric
public abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract StatisticObject getStatisticObject()
public abstract void setStatisticObject(StatisticObject statisticObject)
public abstract StatisticMetric getStatisticMetric()
public abstract void setStatisticMetric(StatisticMetric statisticMetric)
public abstract KeyValueCollection getExtensions()
public abstract void setExtensions(KeyValueCollection extensions)
public abstract java.lang.Integer getTag()
public abstract void setTag(java.lang.Integer tag)
public abstract void setTag(int tag)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |