Platform SDK Java 8.5 API Reference

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

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

public abstract class EventWorkbinTypesInfo
extends Message

This event is Interaction Server's response to an agent application's RequestWorkbinTypesInfo.

Direction: From Interaction Server to agent application.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventWorkbinTypesInfo create()
          Creates instance of EventWorkbinTypesInfo with no parameters set.
static EventWorkbinTypesInfo create(java.lang.Integer proxyClientId, KeyValueCollection workbinTypes, KeyValueCollection extension)
          Creates instance of EventWorkbinTypesInfo with all parameters set.
static EventWorkbinTypesInfo create(KeyValueCollection workbinTypes)
          Creates instance of EventWorkbinTypesInfo 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  KeyValueCollection getWorkbinTypes()
          Optional key-value list property that contains workbin information.
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 setWorkbinTypes(KeyValueCollection workbinTypes)
          Optional key-value list property that contains workbin 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 EventWorkbinTypesInfo create()
Creates instance of EventWorkbinTypesInfo with no parameters set.

Returns:
instance of EventWorkbinTypesInfo

create

public static EventWorkbinTypesInfo create(java.lang.Integer proxyClientId,
                                           KeyValueCollection workbinTypes,
                                           KeyValueCollection extension)
Creates instance of EventWorkbinTypesInfo with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
workbinTypes - Key-value list that contains workbins information. Each key in the list is a workbin type name as present in configuration. Values are key-value lists that contain the following keys: 'WorkbinType' ' owner type (1 ' agent, 2 ' place, 3 ' agent group, 4 ' place group). 'View' ' name of the view the workbin is based on; this view should be used to pull interaction from the workbin in the order defined by the view. This is an alternative to getting workbin content and then pulling particular interaction by its identifier. This approach should be used for group workbins. 'Active' ' (0 ' workbin is disabled, 1 ' workbin is enabled).
extension - Extensions.
Returns:
instance of EventWorkbinTypesInfo

create

public static EventWorkbinTypesInfo create(KeyValueCollection workbinTypes)
Creates instance of EventWorkbinTypesInfo with required parameters set.

Parameters:
workbinTypes - Key-value list that contains workbins information. Each key in the list is a workbin type name as present in configuration. Values are key-value lists that contain the following keys: 'WorkbinType' ' owner type (1 ' agent, 2 ' place, 3 ' agent group, 4 ' place group). 'View' ' name of the view the workbin is based on; this view should be used to pull interaction from the workbin in the order defined by the view. This is an alternative to getting workbin content and then pulling particular interaction by its identifier. This approach should be used for group workbins. 'Active' ' (0 ' workbin is disabled, 1 ' workbin is enabled).
Returns:
instance of EventWorkbinTypesInfo

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.


getWorkbinTypes

public abstract KeyValueCollection getWorkbinTypes()
Optional key-value list property that contains workbin information. Each key in the list is a workbin type name as present in configuration. Each value us a key-value list that contains the following keys:

WorkbinType - Owner type. Values: View - Name of the view the workbin is based on. This view should be used to pull interactions from the workbin in the order defined by the view. This should be used for group workbins; it is an alternative to getting workbin content and then pulling particular interactions by their identifiers.

Active - Values:


setWorkbinTypes

public abstract void setWorkbinTypes(KeyValueCollection workbinTypes)
Optional key-value list property that contains workbin information. Each key in the list is a workbin type name as present in configuration. Each value us a key-value list that contains the following keys:

WorkbinType - Owner type. Values: View - Name of the view the workbin is based on. This view should be used to pull interactions from the workbin in the order defined by the view. This should be used for group workbins; it is an alternative to getting workbin content and then pulling particular interactions by their identifiers.

Active - Values:


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.