Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.interactionserver.events
Class EventWorkbinStatistic

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.openmedia.protocol.interactionserver.events.EventWorkbinStatistic
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventWorkbinStatistic
extends Message

This event is Interaction Server's response to an agent application's RequestWorkbinStatistic for the specified workbin type.

Direction: From Interaction Server to agent application.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventWorkbinStatistic create()
          Creates instance of EventWorkbinStatistic with no parameters set.
static EventWorkbinStatistic create(java.lang.Integer proxyClientId, java.lang.String workbinTypeId, java.lang.Integer workbinOwnerType, KeyValueCollection workbinStatistic, KeyValueCollection extension)
          Creates instance of EventWorkbinStatistic with all parameters set.
static EventWorkbinStatistic create(java.lang.String workbinTypeId, java.lang.Integer workbinOwnerType)
          Creates instance of EventWorkbinStatistic with required parameters set.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  java.lang.Integer getProxyClientId()
          Proxy client identifier.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  java.lang.Integer getWorkbinOwnerType()
          Values: 1-agent 2-place 3-agent group 4-place group
abstract  KeyValueCollection getWorkbinStatistic()
          May be absent if there are no interactions in workbin instances of the specified workbin type.
abstract  java.lang.String getWorkbinTypeId()
          Name of the workbin type.
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setProxyClientId(int proxyClientId)
          Proxy client identifier.
abstract  void setProxyClientId(java.lang.Integer proxyClientId)
          Proxy client identifier.
abstract  void setReferenceId(int referenceId)
          Reference identifier of the request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference identifier of the request.
abstract  void setWorkbinOwnerType(int workbinOwnerType)
          Values: 1-agent 2-place 3-agent group 4-place group
abstract  void setWorkbinOwnerType(java.lang.Integer workbinOwnerType)
          Values: 1-agent 2-place 3-agent group 4-place group
abstract  void setWorkbinStatistic(KeyValueCollection workbinStatistic)
          May be absent if there are no interactions in workbin instances of the specified workbin type.
abstract  void setWorkbinTypeId(java.lang.String workbinTypeId)
          Name of the workbin type.
 
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 EventWorkbinStatistic create()
Creates instance of EventWorkbinStatistic with no parameters set.

Returns:
instance of EventWorkbinStatistic

create

public static EventWorkbinStatistic create(java.lang.Integer proxyClientId,
                                           java.lang.String workbinTypeId,
                                           java.lang.Integer workbinOwnerType,
                                           KeyValueCollection workbinStatistic,
                                           KeyValueCollection extension)
Creates instance of EventWorkbinStatistic with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
workbinTypeId - Name of the workbin.
workbinOwnerType - Owner type: 1 - agent, 2 - place, 3 - agent group, 4 - place group.
workbinStatistic - May be absent if there are no interactions in workbin instances of the specified workbin type.
extension - Extensions.
Returns:
instance of EventWorkbinStatistic

create

public static EventWorkbinStatistic create(java.lang.String workbinTypeId,
                                           java.lang.Integer workbinOwnerType)
Creates instance of EventWorkbinStatistic with required parameters set.

Parameters:
workbinTypeId - Name of the workbin.
workbinOwnerType - Owner type: 1 - agent, 2 - place, 3 - agent group, 4 - place group.
Returns:
instance of EventWorkbinStatistic

getReferenceId

public abstract java.lang.Integer getReferenceId()
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


setReferenceId

public abstract void setReferenceId(int referenceId)
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


getProxyClientId

public abstract java.lang.Integer getProxyClientId()
Proxy client identifier. Mandatory if client connects via proxy.


setProxyClientId

public abstract void setProxyClientId(java.lang.Integer proxyClientId)
Proxy client identifier. Mandatory if client connects via proxy.


setProxyClientId

public abstract void setProxyClientId(int proxyClientId)
Proxy client identifier. Mandatory if client connects via proxy.


getWorkbinTypeId

public abstract java.lang.String getWorkbinTypeId()
Name of the workbin type.


setWorkbinTypeId

public abstract void setWorkbinTypeId(java.lang.String workbinTypeId)
Name of the workbin type.


getWorkbinOwnerType

public abstract java.lang.Integer getWorkbinOwnerType()
Values:


setWorkbinOwnerType

public abstract void setWorkbinOwnerType(java.lang.Integer workbinOwnerType)
Values:


setWorkbinOwnerType

public abstract void setWorkbinOwnerType(int workbinOwnerType)
Values:


getWorkbinStatistic

public abstract KeyValueCollection getWorkbinStatistic()
May be absent if there are no interactions in workbin instances of the specified workbin type. Each key is an owner identifier. Each value is a key-value list containing the following keys:


setWorkbinStatistic

public abstract void setWorkbinStatistic(KeyValueCollection workbinStatistic)
May be absent if there are no interactions in workbin instances of the specified workbin type. Each key is an owner identifier. Each value is a key-value list containing the following keys:


getExtension

public abstract KeyValueCollection getExtension()
A key-value list of extensions. For media servers the following extensions are defined, with values of type integer:


setExtension

public abstract void setExtension(KeyValueCollection extension)
A key-value list of extensions. For media servers the following extensions are defined, with values of type integer:


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.