|
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.RequestPeekStatistic
public abstract class RequestPeekStatistic
Requests immediate recalculation and transmission of the
value of a previously opened statistic. Because this request
is asynchronous, you should use the
send
method and not the request
method when issuing this request, otherwise your request will time out
and receive null.
Note, this request is not applicable to the CurrentTargetState
category.
Required parameters:
Name | Description |
---|---|
StatisticId | ReferenceId of the
RequestOpenStatistic or
RequestOpenStatisticEx
that was used to open the statistics. |
Name | Description |
---|---|
EventInfo |
Contains information about a statistics request that does not concern a routing target. |
EventCurrentTargetStateSnapshot |
Contains the CurrentTargetStateSnapshot data structure, which includes information about routing targets such as agent, place, agent group, and place group states. |
EventError |
Indicates that the request encountered an error. |
ReferenceId
of the
RequestOpenStatistic
or
RequestOpenStatisticEx
that was used to open the statistic, as shown here:
RequestPeekStatistic req = RequestPeekStatistic.create();
req.setStatisticId(referenceIdFromRequestOpenStatistic);
statProtocol.send(req);
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestPeekStatistic |
create()
Creates instance of RequestPeekStatistic with no parameters set. |
static RequestPeekStatistic |
create(java.lang.Integer statisticId)
Creates instance of RequestPeekStatistic with all parameters set. |
abstract java.lang.Integer |
getReferenceId()
A unique integer that is specified for identification of requested statistics. |
abstract java.lang.Integer |
getStatisticId()
Refers to the ReferenceId of the RequestOpenStatistic or RequestOpenStatisticEx associated with this request: Stat Server needs this information so that it can take action on the appropriate set of statistical information. |
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 |
setStatisticId(int statisticId)
Refers to the ReferenceId of the RequestOpenStatistic or RequestOpenStatisticEx associated with this request: Stat Server needs this information so that it can take action on the appropriate set of statistical information. |
abstract void |
setStatisticId(java.lang.Integer statisticId)
Refers to the ReferenceId of the RequestOpenStatistic or RequestOpenStatisticEx associated with this request: Stat Server needs this information so that it can take action on the appropriate set of statistical information. |
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 RequestPeekStatistic create()
public static RequestPeekStatistic create(java.lang.Integer statisticId)
statisticId
- StatisticId
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 getStatisticId()
public abstract void setStatisticId(java.lang.Integer statisticId)
public abstract void setStatisticId(int statisticId)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |