|
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.RequestGetStatisticEx
public abstract class RequestGetStatisticEx
Requests one-time notification about a statistic that is defined in this request.
Required parameters:
Name | Description |
---|---|
StatisticMetricEx |
Contains a detailed description of the type of statistical information to be gathered for the 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. |
RequestGetStatisticEx request = RequestGetStatisticEx.create();
StatisticObject object = StatisticObject.create();
object.setObjectId("An_Agent");
object.setObjectType(StatisticObjectType.Agent);
object.setTenantName("The_Tenant");
object.setTenantPassword("password");
request.setStatisticObject(object);
DnActionMask mainMask = ActionsMask.createDNActionsMask();
mainMask.setBit(DnActions.WaitForNextCall);
mainMask.setBit(DnActions.CallDialing);
mainMask.setBit(DnActions.CallRinging);
mainMask.setBit(DnActions.NotReadyForNextCall);
mainMask.setBit(DnActions.CallOnHold);
mainMask.setBit(DnActions.CallUnknown);
mainMask.setBit(DnActions.CallConsult);
mainMask.setBit(DnActions.CallInternal);
mainMask.setBit(DnActions.CallOutbound);
mainMask.setBit(DnActions.CallInbound);
mainMask.setBit(DnActions.LoggedOut);
DnActionMask relMask = ActionsMask.createDNActionsMask();
StatisticMetricEx metric = StatisticMetricEx.create();
metric.setCategory(StatisticCategory.CurrentState);
metric.setMainMask(mainMask);
metric.setRelativeMask(relMask);
metric.setSubject(StatisticSubject.DNStatus);
request.setStatisticMetricEx(metric);
request.setReferenceId(anIntThatYouSpecify);
Message response = statProtocol.request(request);
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestGetStatisticEx |
create()
Creates instance of RequestGetStatisticEx with no parameters set. |
static RequestGetStatisticEx |
create(StatisticObject statisticObject,
StatisticMetricEx statisticMetricEx)
Creates instance of RequestGetStatisticEx with required parameters set. |
static RequestGetStatisticEx |
create(StatisticObject statisticObject,
StatisticMetricEx statisticMetricEx,
java.lang.String statisticExtension,
java.lang.String statisticExtensionSubcategory,
KeyValueCollection extensions,
java.lang.Integer tag)
Creates instance of RequestGetStatisticEx with all parameters set. |
abstract KeyValueCollection |
getExtensions()
|
abstract java.lang.Integer |
getReferenceId()
A unique integer that is specified for identification of requested statistics. |
abstract java.lang.String |
getStatisticExtension()
|
abstract java.lang.String |
getStatisticExtensionSubcategory()
|
abstract StatisticMetricEx |
getStatisticMetricEx()
|
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 |
setStatisticExtension(java.lang.String statisticExtension)
|
abstract void |
setStatisticExtensionSubcategory(java.lang.String statisticExtensionSubcategory)
|
abstract void |
setStatisticMetricEx(StatisticMetricEx statisticMetricEx)
|
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 RequestGetStatisticEx create()
public static RequestGetStatisticEx create(StatisticObject statisticObject, StatisticMetricEx statisticMetricEx, java.lang.String statisticExtension, java.lang.String statisticExtensionSubcategory, KeyValueCollection extensions, java.lang.Integer tag)
statisticObject
- StatisticObjectstatisticMetricEx
- StatisticMetricExstatisticExtension
- StatisticExtensionstatisticExtensionSubcategory
- StatisticExtensionSubcategoryextensions
- Extensionstag
- Tag
public static RequestGetStatisticEx create(StatisticObject statisticObject, StatisticMetricEx statisticMetricEx)
statisticObject
- StatisticObjectstatisticMetricEx
- StatisticMetricEx
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 StatisticMetricEx getStatisticMetricEx()
public abstract void setStatisticMetricEx(StatisticMetricEx statisticMetricEx)
public abstract java.lang.String getStatisticExtension()
public abstract void setStatisticExtension(java.lang.String statisticExtension)
public abstract java.lang.String getStatisticExtensionSubcategory()
public abstract void setStatisticExtensionSubcategory(java.lang.String statisticExtensionSubcategory)
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 |