Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestGetStatisticProfile
extends Message

Requests information on the currently available statistical types, time profiles, time ranges, or filters.

Required parameters:

Name Description
StatisticProfile Determines whether the request will receive information about StatTypes, TimeProfiles, Filters, or TimeRanges.

Related Events:
Name Description
EventStatisticProfile Contains statistics configuration information about StatTypes, TimeProfiles, Filters, or TimeRanges.
EventError Indicates that the request encountered an error.

Example:
Here are two samples of RequestGetStatisticProfile. The first is for TimeProfiles and the second is for TimeRanges.

TimeProfiles

 RequestGetStatisticProfile req = RequestGetStatisticProfile.create();
 req.setStatisticProfile(StatisticProfile.TimeProfiles);
 Message response = statProtocol.request(req);
 
TimeRanges

 RequestGetStatisticProfile req = RequestGetStatisticProfile.create();
 req.setStatisticProfile(StatisticProfile.TimeRanges);
 Message response = statProtocol.request(req);
 


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestGetStatisticProfile create()
          Creates instance of RequestGetStatisticProfile with no parameters set.
static RequestGetStatisticProfile create(StatisticProfile statisticProfile)
          Creates instance of RequestGetStatisticProfile with required parameters set.
static RequestGetStatisticProfile create(StatisticProfile statisticProfile, java.lang.Integer tag)
          Creates instance of RequestGetStatisticProfile with all parameters set.
abstract  java.lang.Integer getReferenceId()
          A unique integer that is specified for identification of requested statistics.
abstract  StatisticProfile getStatisticProfile()
          Specifies which type of profile information (statistical types, time profiles, time ranges, or filters) will be returned from a RequestGetStatisticProfile.
abstract  java.lang.Integer getTag()
          User reference ID.
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 setStatisticProfile(StatisticProfile statisticProfile)
          Specifies which type of profile information (statistical types, time profiles, time ranges, or filters) will be returned from a RequestGetStatisticProfile.
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 RequestGetStatisticProfile create()
Creates instance of RequestGetStatisticProfile with no parameters set.

Returns:
instance of RequestGetStatisticProfile

create

public static RequestGetStatisticProfile create(StatisticProfile statisticProfile,
                                                java.lang.Integer tag)
Creates instance of RequestGetStatisticProfile with all parameters set.

Parameters:
statisticProfile - StatisticProfile
tag - Tag
Returns:
instance of RequestGetStatisticProfile

create

public static RequestGetStatisticProfile create(StatisticProfile statisticProfile)
Creates instance of RequestGetStatisticProfile with required parameters set.

Parameters:
statisticProfile - StatisticProfile
Returns:
instance of RequestGetStatisticProfile

getStatisticProfile

public abstract StatisticProfile getStatisticProfile()
Specifies which type of profile information (statistical types, time profiles, time ranges, or filters) will be returned from a RequestGetStatisticProfile.


setStatisticProfile

public abstract void setStatisticProfile(StatisticProfile statisticProfile)
Specifies which type of profile information (statistical types, time profiles, time ranges, or filters) will be returned from a RequestGetStatisticProfile.


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.


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.