|
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.RequestSuspendNotification
public abstract class RequestSuspendNotification
Asks Stat Server to temporarily stop sending notifications to the client: because this request is asynchronous, you should use the send method, not the request method.
Required parameters:
Name | Description |
---|---|
StatisticId | ReferenceId of the
RequestOpenStatistic or
RequestOpenStatisticEx
that was used to open the statistics. |
Name | Description |
---|---|
--- | No event is returned if the request was successful.. |
EventError |
Indicates that the request encountered an error. |
ReferenceId
of the
RequestOpenStatistic
or
RequestOpenStatisticEx
that was used to open the statistic, as shown here:
RequestSuspendNotification req = RequestSuspendNotification.create();
req.setStatisticId(referenceIdFromRequestOpenStatistic);
statProtocol.send(req);
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestSuspendNotification |
create()
Creates instance of RequestSuspendNotification with no parameters set. |
static RequestSuspendNotification |
create(java.lang.Integer statisticId)
Creates instance of RequestSuspendNotification with all parameters set. |
abstract java.lang.Integer |
getReferenceId()
A unique integer that is specified for identification of requested statistics. |
abstract java.lang.Integer |
getStatisticId()
Refers to the ReferenceId of the RequestOpenStatistic or RequestOpenStatisticEx associated with this request: Stat Server needs this information so that it can take action on the appropriate set of statistical information. |
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 |
setStatisticId(int statisticId)
Refers to the ReferenceId of the RequestOpenStatistic or RequestOpenStatisticEx associated with this request: Stat Server needs this information so that it can take action on the appropriate set of statistical information. |
abstract void |
setStatisticId(java.lang.Integer statisticId)
Refers to the ReferenceId of the RequestOpenStatistic or RequestOpenStatisticEx associated with this request: Stat Server needs this information so that it can take action on the appropriate set of statistical information. |
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 RequestSuspendNotification create()
public static RequestSuspendNotification create(java.lang.Integer statisticId)
statisticId
- StatisticId
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 getStatisticId()
public abstract void setStatisticId(java.lang.Integer statisticId)
public abstract void setStatisticId(int statisticId)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |