|
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.RequestGetStatisticProfile
public abstract class RequestGetStatisticProfile
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. |
Name | Description |
---|---|
EventStatisticProfile |
Contains statistics configuration information about StatTypes, TimeProfiles, Filters, or TimeRanges. |
EventError |
Indicates that the request encountered an error. |
RequestGetStatisticProfile
.
The first is for TimeProfiles
and the second is for TimeRanges
.
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static RequestGetStatisticProfile create()
public static RequestGetStatisticProfile create(StatisticProfile statisticProfile, java.lang.Integer tag)
statisticProfile
- StatisticProfiletag
- Tag
public static RequestGetStatisticProfile create(StatisticProfile statisticProfile)
statisticProfile
- StatisticProfile
public abstract StatisticProfile getStatisticProfile()
public abstract void setStatisticProfile(StatisticProfile statisticProfile)
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 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 |