Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.callback.requests
Class RequestGetStatistics

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.webmedia.protocol.callback.requests.RequestGetStatistics
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestGetStatistics
extends Message

This class represents a statistics request packet. In response to the statistics request, Callback Server can send a packet containing EventStatInfo or an EventError packet. This response packet contains the same reference identifier as the request packet.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestGetStatistics create()
          Creates instance of RequestGetStatistics with no parameters set.
static RequestGetStatistics create(java.lang.String requestId, java.lang.String contact, KeyValueCollection userData)
          Creates instance of RequestGetStatistics with all parameters set.
abstract  java.lang.String getContact()
          A string providing contact information for a callback object.
abstract  java.lang.Integer getReferenceId()
          An integer that provides a unique identifier for each request or event message.
abstract  java.lang.String getRequestId()
          This string identifies a particular request.
abstract  KeyValueCollection getUserData()
          A key value collection that contains user data.
abstract  void setContact(java.lang.String contact)
          A string providing contact information for a callback object.
abstract  void setReferenceId(int referenceId)
          An integer that provides a unique identifier for each request or event message.
abstract  void setReferenceId(java.lang.Integer referenceId)
          An integer that provides a unique identifier for each request or event message.
abstract  void setRequestId(java.lang.String requestId)
          This string identifies a particular request.
abstract  void setUserData(KeyValueCollection userData)
          A key value collection that contains user data.
 
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 RequestGetStatistics create()
Creates instance of RequestGetStatistics with no parameters set.

Returns:
instance of RequestGetStatistics

create

public static RequestGetStatistics create(java.lang.String requestId,
                                          java.lang.String contact,
                                          KeyValueCollection userData)
Creates instance of RequestGetStatistics with all parameters set.

Parameters:
requestId - RequestId
contact - Contact
userData - UserData
Returns:
instance of RequestGetStatistics

getReferenceId

public abstract java.lang.Integer getReferenceId()
An integer that provides a unique identifier for each request or event message.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
An integer that provides a unique identifier for each request or event message.


setReferenceId

public abstract void setReferenceId(int referenceId)
An integer that provides a unique identifier for each request or event message.


getRequestId

public abstract java.lang.String getRequestId()
This string identifies a particular request. When a related event is received, it will include the RequestId that you set.


setRequestId

public abstract void setRequestId(java.lang.String requestId)
This string identifies a particular request. When a related event is received, it will include the RequestId that you set.


getContact

public abstract java.lang.String getContact()
A string providing contact information for a callback object.


setContact

public abstract void setContact(java.lang.String contact)
A string providing contact information for a callback object.


getUserData

public abstract KeyValueCollection getUserData()
A key value collection that contains user data.


setUserData

public abstract void setUserData(KeyValueCollection userData)
A key value collection that contains user data.


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.