Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.interactionserver.requests.agentmanagement
Class RequestWorkbinTypesInfo

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.requests.agentmanagement.RequestWorkbinTypesInfo
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestWorkbinTypesInfo
extends Message

With this request, an agent (supervisor) application asks for information on configured workbins. The response from Interaction Server lists workbin types, names, views, and enabled/disabled status; see EventWorkbinTypesInfo for more information.

Direction: From agent application to Interaction Server


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestWorkbinTypesInfo create()
          Creates instance of RequestWorkbinTypesInfo with no parameters set.
static RequestWorkbinTypesInfo create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.Integer tenantId)
          Creates instance of RequestWorkbinTypesInfo with all 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 getTenantId()
          Tenant identifier of the Party (database ID from the configuration).
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 setTenantId(int tenantId)
          Tenant identifier of the Party (database ID from the configuration).
abstract  void setTenantId(java.lang.Integer tenantId)
          Tenant identifier of the Party (database ID from the configuration).
 
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 RequestWorkbinTypesInfo create()
Creates instance of RequestWorkbinTypesInfo with no parameters set.

Returns:
instance of RequestWorkbinTypesInfo

create

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

Parameters:
proxyClientId - The identifier of the client of proxy.
extension - Extensions.
tenantId - Tenant identifier of the party (dbid from the configuration).
Returns:
instance of RequestWorkbinTypesInfo

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.


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:


getTenantId

public abstract java.lang.Integer getTenantId()
Tenant identifier of the Party (database ID from the configuration).


setTenantId

public abstract void setTenantId(java.lang.Integer tenantId)
Tenant identifier of the Party (database ID from the configuration).


setTenantId

public abstract void setTenantId(int tenantId)
Tenant identifier of the Party (database ID from the configuration).


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.