Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestSuspendNotification
extends Message

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.

Related Events:
Name Description
--- No event is returned if the request was successful..
EventError Indicates that the request encountered an error.

Example:
This request requires that you specify the 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

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 RequestSuspendNotification create()
Creates instance of RequestSuspendNotification with no parameters set.

Returns:
instance of RequestSuspendNotification

create

public static RequestSuspendNotification create(java.lang.Integer statisticId)
Creates instance of RequestSuspendNotification with all parameters set.

Parameters:
statisticId - StatisticId
Returns:
instance of RequestSuspendNotification

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.


getStatisticId

public 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.


setStatisticId

public 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.


setStatisticId

public 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.


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.