|
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.RequestOpenStatisticEx
public abstract class RequestOpenStatisticEx
Requests that Stat Server start sending information about a statistics that is defined in this request.
Required parameters:
Name | Description |
---|---|
Notification |
Specifies how often Stat Server will send updates on the requested statistical values. |
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. This event may be issued after EventStatisticOpened, depending on which notification mode has been requested. |
EventCurrentTargetStateTargetAdded |
Indicates that a member has been added to an agent or place group object. This event may be issued after EventStatisticOpened, depending on which notification mode has been requested. |
EventCurrentTargetStateTargetRemoved |
Indicates that a target has been removed. This event may be issued after EventStatisticOpened, depending on which notification mode has been requested. |
EventCurrentTargetStateTargetUpdated |
Indicates that the target's state has changed. This event may be issued after EventStatisticOpened, depending on which notification mode has been requested. |
EventInfo |
Contains information about a statistics request that does not concern a routing target. This event may be issued after EventStatisticOpened, depending on which notification mode has been requested. |
EventStatisticOpened |
Indicates that Stat Server will start sending information about the referenced statistic. |
EventError |
Indicates that the request encountered an error. |
RequestOpenStatisticEx request = RequestOpenStatisticEx.create();
StatisticObject object = StatisticObject.create();
object.setObjectId("An_Agent");
object.setObjectType(StatisticObjectType.Agent);
object.setTenantName("The_Tenant");
object.setTenantPassword("password");
Notification notification = Notification.create();
notification.setMode(NotificationMode.Immediate);
request.setNotification(notification);
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 RequestOpenStatisticEx |
create()
Creates instance of RequestOpenStatisticEx with no parameters set. |
static RequestOpenStatisticEx |
create(StatisticObject statisticObject,
StatisticMetricEx statisticMetricEx,
Notification notification)
Creates instance of RequestOpenStatisticEx with required parameters set. |
static RequestOpenStatisticEx |
create(StatisticObject statisticObject,
StatisticMetricEx statisticMetricEx,
Notification notification,
java.lang.String statisticExtension,
java.lang.String statisticExtensionSubcategory,
KeyValueCollection extensions,
java.lang.Integer tag)
Creates instance of RequestOpenStatisticEx with all parameters set. |
abstract KeyValueCollection |
getExtensions()
|
abstract Notification |
getNotification()
|
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 |
setNotification(Notification notification)
|
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 RequestOpenStatisticEx create()
public static RequestOpenStatisticEx create(StatisticObject statisticObject, StatisticMetricEx statisticMetricEx, Notification notification, java.lang.String statisticExtension, java.lang.String statisticExtensionSubcategory, KeyValueCollection extensions, java.lang.Integer tag)
statisticObject
- StatisticObjectstatisticMetricEx
- StatisticMetricExnotification
- NotificationstatisticExtension
- StatisticExtensionstatisticExtensionSubcategory
- StatisticExtensionSubcategoryextensions
- Extensionstag
- Tag
public static RequestOpenStatisticEx create(StatisticObject statisticObject, StatisticMetricEx statisticMetricEx, Notification notification)
statisticObject
- StatisticObjectstatisticMetricEx
- StatisticMetricExnotification
- Notification
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 Notification getNotification()
public abstract void setNotification(Notification notification)
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 |