Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.callback.events
Class EventStatInfo

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

public abstract class EventStatInfo
extends Message

This class represents a packet containing statistical information.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventStatInfo create()
          Creates instance of EventStatInfo with no parameters set.
static EventStatInfo create(java.lang.String requestId, java.lang.String contact, java.lang.String requestStatus, java.lang.Integer queueSize, java.lang.Integer queueEstimatedWaitingTime, java.lang.Integer requestPositionInQueue, java.lang.Integer requestEstimatedWaitingTime)
          Creates instance of EventStatInfo with all parameters set.
abstract  java.lang.String getContact()
          A string providing contact information for a callback object.
abstract  java.lang.Integer getQueueEstimatedWaitingTime()
          This integer value is an estimate of how long it will take before a callback request is ready to be processed in an interaction queue.
abstract  java.lang.Integer getQueueSize()
          This integer value indicates the current size of the interaction queue where a callback request is located in.
abstract  java.lang.Integer getReferenceId()
          An integer that provides a unique identifier for each request or event message.
abstract  java.lang.Integer getRequestEstimatedWaitingTime()
          This integer value is an estimate of the average time it takes to handle a callback request.
abstract  java.lang.String getRequestId()
          This string identifies a particular request.
abstract  java.lang.Integer getRequestPositionInQueue()
          This property holds the queue position for a callback interaction request in a specified queue.
abstract  java.lang.String getRequestStatus()
          This string is returned with an EventStatInfo event, and indicates the status of a callback request.
abstract  void setContact(java.lang.String contact)
          A string providing contact information for a callback object.
abstract  void setQueueEstimatedWaitingTime(int queueEstimatedWaitingTime)
          This integer value is an estimate of how long it will take before a callback request is ready to be processed in an interaction queue.
abstract  void setQueueEstimatedWaitingTime(java.lang.Integer queueEstimatedWaitingTime)
          This integer value is an estimate of how long it will take before a callback request is ready to be processed in an interaction queue.
abstract  void setQueueSize(int queueSize)
          This integer value indicates the current size of the interaction queue where a callback request is located in.
abstract  void setQueueSize(java.lang.Integer queueSize)
          This integer value indicates the current size of the interaction queue where a callback request is located in.
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 setRequestEstimatedWaitingTime(int requestEstimatedWaitingTime)
          This integer value is an estimate of the average time it takes to handle a callback request.
abstract  void setRequestEstimatedWaitingTime(java.lang.Integer requestEstimatedWaitingTime)
          This integer value is an estimate of the average time it takes to handle a callback request.
abstract  void setRequestId(java.lang.String requestId)
          This string identifies a particular request.
abstract  void setRequestPositionInQueue(int requestPositionInQueue)
          This property holds the queue position for a callback interaction request in a specified queue.
abstract  void setRequestPositionInQueue(java.lang.Integer requestPositionInQueue)
          This property holds the queue position for a callback interaction request in a specified queue.
abstract  void setRequestStatus(java.lang.String requestStatus)
          This string is returned with an EventStatInfo event, and indicates the status of a callback request.
 
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 EventStatInfo create()
Creates instance of EventStatInfo with no parameters set.

Returns:
instance of EventStatInfo

create

public static EventStatInfo create(java.lang.String requestId,
                                   java.lang.String contact,
                                   java.lang.String requestStatus,
                                   java.lang.Integer queueSize,
                                   java.lang.Integer queueEstimatedWaitingTime,
                                   java.lang.Integer requestPositionInQueue,
                                   java.lang.Integer requestEstimatedWaitingTime)
Creates instance of EventStatInfo with all parameters set.

Parameters:
requestId - RequestId
contact - Contact
requestStatus - RequestStatus
queueSize - QueueSize
queueEstimatedWaitingTime - QueueEstimatedWaitingTime
requestPositionInQueue - RequestPositionInQueue
requestEstimatedWaitingTime - RequestEstimatedWaitingTime
Returns:
instance of EventStatInfo

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.


getRequestStatus

public abstract java.lang.String getRequestStatus()
This string is returned with an EventStatInfo event, and indicates the status of a callback request.


setRequestStatus

public abstract void setRequestStatus(java.lang.String requestStatus)
This string is returned with an EventStatInfo event, and indicates the status of a callback request.


getQueueSize

public abstract java.lang.Integer getQueueSize()
This integer value indicates the current size of the interaction queue where a callback request is located in. Returned as part of the EventStatInfo event.


setQueueSize

public abstract void setQueueSize(java.lang.Integer queueSize)
This integer value indicates the current size of the interaction queue where a callback request is located in. Returned as part of the EventStatInfo event.


setQueueSize

public abstract void setQueueSize(int queueSize)
This integer value indicates the current size of the interaction queue where a callback request is located in. Returned as part of the EventStatInfo event.


getQueueEstimatedWaitingTime

public abstract java.lang.Integer getQueueEstimatedWaitingTime()
This integer value is an estimate of how long it will take before a callback request is ready to be processed in an interaction queue. Returned as part of the EventStatInfo event.


setQueueEstimatedWaitingTime

public abstract void setQueueEstimatedWaitingTime(java.lang.Integer queueEstimatedWaitingTime)
This integer value is an estimate of how long it will take before a callback request is ready to be processed in an interaction queue. Returned as part of the EventStatInfo event.


setQueueEstimatedWaitingTime

public abstract void setQueueEstimatedWaitingTime(int queueEstimatedWaitingTime)
This integer value is an estimate of how long it will take before a callback request is ready to be processed in an interaction queue. Returned as part of the EventStatInfo event.


getRequestPositionInQueue

public abstract java.lang.Integer getRequestPositionInQueue()
This property holds the queue position for a callback interaction request in a specified queue.


setRequestPositionInQueue

public abstract void setRequestPositionInQueue(java.lang.Integer requestPositionInQueue)
This property holds the queue position for a callback interaction request in a specified queue.


setRequestPositionInQueue

public abstract void setRequestPositionInQueue(int requestPositionInQueue)
This property holds the queue position for a callback interaction request in a specified queue.


getRequestEstimatedWaitingTime

public abstract java.lang.Integer getRequestEstimatedWaitingTime()
This integer value is an estimate of the average time it takes to handle a callback request. Returned as part of the EventStatInfo event.


setRequestEstimatedWaitingTime

public abstract void setRequestEstimatedWaitingTime(java.lang.Integer requestEstimatedWaitingTime)
This integer value is an estimate of the average time it takes to handle a callback request. Returned as part of the EventStatInfo event.


setRequestEstimatedWaitingTime

public abstract void setRequestEstimatedWaitingTime(int requestEstimatedWaitingTime)
This integer value is an estimate of the average time it takes to handle a callback request. Returned as part of the EventStatInfo event.


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.