Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestOpenStatistic
extends Message

Requests that Stat Server start sending information about a predefined statistics.

Required parameters:

Name Description
Notification Specifies how often Stat Server will send updates on the requested statistical values.
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. 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.

Example:

 RequestOpenStatistic req = RequestOpenStatistic.create();
 StatisticObject object = StatisticObject.create();
 object.setObjectId("An_Agent");
 object.setObjectType(StatisticObjectType.Agent);
 object.setTenantName("The_Tenant");
 object.setTenantPassword("password");
 req.setStatisticObject(object);
 
 Notification notification = Notification.create();
 notification.setMode(NotificationMode.Periodical);
 notification.setFrequency(15);
 req.setNotification(notification);
 
 StatisticMetric statisticMetric = StatisticMetric.create("TotalLoginTime");
 req.setStatisticMetric(statisticMetric);
 
 req.setReferenceId(anIntThatYouSpecify);
 Message response = statProtocol.request(req);
 


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestOpenStatistic create()
          Creates instance of RequestOpenStatistic with no parameters set.
static RequestOpenStatistic create(StatisticObject statisticObject, StatisticMetric statisticMetric, Notification notification)
          Creates instance of RequestOpenStatistic with required parameters set.
static RequestOpenStatistic create(StatisticObject statisticObject, StatisticMetric statisticMetric, Notification notification, KeyValueCollection extensions, java.lang.Integer tag)
          Creates instance of RequestOpenStatistic 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  StatisticMetric getStatisticMetric()
           
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 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 RequestOpenStatistic create()
Creates instance of RequestOpenStatistic with no parameters set.

Returns:
instance of RequestOpenStatistic

create

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

Parameters:
statisticObject - StatisticObject
statisticMetric - StatisticMetric
notification - Notification
extensions - Extensions
tag - Tag
Returns:
instance of RequestOpenStatistic

create

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

Parameters:
statisticObject - StatisticObject
statisticMetric - StatisticMetric
notification - Notification
Returns:
instance of RequestOpenStatistic

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)

getNotification

public abstract Notification getNotification()

setNotification

public abstract void setNotification(Notification notification)

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.