Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestAgentWorkbinStats
extends Message

The purpose of this request is to allow agent application (or a proxy application) to request agent, place or group specific statistics for workbins. Given the agent id and/or place name and/or agent group id and/or place group id, the Server returns list of workbin names, with specification of workbin type, owner id and number of interaction in the workbin.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestAgentWorkbinStats create()
          Creates instance of RequestAgentWorkbinStats with no parameters set.
static RequestAgentWorkbinStats create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.Integer tenantId, java.lang.String workbinAgentId, java.lang.String workbinPlaceId, java.lang.String workbinGroupId, java.lang.String workbinPlaceGroupId)
          Creates instance of RequestAgentWorkbinStats with all parameters set.
abstract  KeyValueCollection getExtension()
          [Optional] Extensions.
abstract  java.lang.Integer getProxyClientId()
          [Optional] Through proxy client identifier that must be specified by proxy.
abstract  java.lang.Integer getReferenceId()
          [Mandatory] Reference identifier of the request.
abstract  java.lang.Integer getTenantId()
          [Optional] Tenant identifier of the agent.
abstract  java.lang.String getWorkbinAgentId()
          [Optional] Employee id of the agent statistic is required for.
abstract  java.lang.String getWorkbinGroupId()
          [Optional] Agent group names of the groups statistic is required for.
abstract  java.lang.String getWorkbinPlaceGroupId()
          [Optional] Place group names of the groups statistic is required for.
abstract  java.lang.String getWorkbinPlaceId()
          [Optional] Place name of the place statistic is required for.
abstract  void setExtension(KeyValueCollection extension)
          [Optional] Extensions.
abstract  void setProxyClientId(int proxyClientId)
          [Optional] Through proxy client identifier that must be specified by proxy.
abstract  void setProxyClientId(java.lang.Integer proxyClientId)
          [Optional] Through proxy client identifier that must be specified by proxy.
abstract  void setReferenceId(int referenceId)
          [Mandatory] Reference identifier of the request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          [Mandatory] Reference identifier of the request.
abstract  void setTenantId(int tenantId)
          [Optional] Tenant identifier of the agent.
abstract  void setTenantId(java.lang.Integer tenantId)
          [Optional] Tenant identifier of the agent.
abstract  void setWorkbinAgentId(java.lang.String workbinAgentId)
          [Optional] Employee id of the agent statistic is required for.
abstract  void setWorkbinGroupId(java.lang.String workbinGroupId)
          [Optional] Agent group names of the groups statistic is required for.
abstract  void setWorkbinPlaceGroupId(java.lang.String workbinPlaceGroupId)
          [Optional] Place group names of the groups statistic is required for.
abstract  void setWorkbinPlaceId(java.lang.String workbinPlaceId)
          [Optional] Place name of the place statistic is required for.
 
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 RequestAgentWorkbinStats create()
Creates instance of RequestAgentWorkbinStats with no parameters set.

Returns:
instance of RequestAgentWorkbinStats

create

public static RequestAgentWorkbinStats create(java.lang.Integer proxyClientId,
                                              KeyValueCollection extension,
                                              java.lang.Integer tenantId,
                                              java.lang.String workbinAgentId,
                                              java.lang.String workbinPlaceId,
                                              java.lang.String workbinGroupId,
                                              java.lang.String workbinPlaceGroupId)
Creates instance of RequestAgentWorkbinStats 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).
workbinAgentId - Employee identifier of the agent who is the owner of the workbin instance. Must be specified for agent workbin.
workbinPlaceId - Place name of the place that is the owner of the workbin instance. Must be specified for place workbin
workbinGroupId - Agent group name of the agent group that is the owner of the workbin instance. Must be specified for agent group workbin.
workbinPlaceGroupId - Place group name of the place group that is the owner of the workbin instance. Must be specified for place group workbin.
Returns:
instance of RequestAgentWorkbinStats

getProxyClientId

public abstract java.lang.Integer getProxyClientId()
[Optional] Through proxy client identifier that must be specified by proxy. Ignored for any other type of client.


setProxyClientId

public abstract void setProxyClientId(java.lang.Integer proxyClientId)
[Optional] Through proxy client identifier that must be specified by proxy. Ignored for any other type of client.


setProxyClientId

public abstract void setProxyClientId(int proxyClientId)
[Optional] Through proxy client identifier that must be specified by proxy. Ignored for any other type of client.


getExtension

public abstract KeyValueCollection getExtension()
[Optional] Extensions.


setExtension

public abstract void setExtension(KeyValueCollection extension)
[Optional] Extensions.


getReferenceId

public abstract java.lang.Integer getReferenceId()
[Mandatory] Reference identifier of the request.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
[Mandatory] Reference identifier of the request.


setReferenceId

public abstract void setReferenceId(int referenceId)
[Mandatory] Reference identifier of the request.


getTenantId

public abstract java.lang.Integer getTenantId()
[Optional] Tenant identifier of the agent. Must be specified in the request from proxy. For agent application, the logged in agent tenant id is taken and if this attribute is specified and is not equal to agent's tenant id, the error is generated.


setTenantId

public abstract void setTenantId(java.lang.Integer tenantId)
[Optional] Tenant identifier of the agent. Must be specified in the request from proxy. For agent application, the logged in agent tenant id is taken and if this attribute is specified and is not equal to agent's tenant id, the error is generated.


setTenantId

public abstract void setTenantId(int tenantId)
[Optional] Tenant identifier of the agent. Must be specified in the request from proxy. For agent application, the logged in agent tenant id is taken and if this attribute is specified and is not equal to agent's tenant id, the error is generated.


getWorkbinAgentId

public abstract java.lang.String getWorkbinAgentId()
[Optional] Employee id of the agent statistic is required for. If not specified, for agent application client, it is assumed to be agent id of the logged in agent


setWorkbinAgentId

public abstract void setWorkbinAgentId(java.lang.String workbinAgentId)
[Optional] Employee id of the agent statistic is required for. If not specified, for agent application client, it is assumed to be agent id of the logged in agent


getWorkbinPlaceId

public abstract java.lang.String getWorkbinPlaceId()
[Optional] Place name of the place statistic is required for. If not specified, for agent application client, it is assumed to be place name of the logged in agent


setWorkbinPlaceId

public abstract void setWorkbinPlaceId(java.lang.String workbinPlaceId)
[Optional] Place name of the place statistic is required for. If not specified, for agent application client, it is assumed to be place name of the logged in agent


getWorkbinGroupId

public abstract java.lang.String getWorkbinGroupId()
[Optional] Agent group names of the groups statistic is required for. If not specified, statistic for agent group workbins is not included. The names should be comma separated.


setWorkbinGroupId

public abstract void setWorkbinGroupId(java.lang.String workbinGroupId)
[Optional] Agent group names of the groups statistic is required for. If not specified, statistic for agent group workbins is not included. The names should be comma separated.


getWorkbinPlaceGroupId

public abstract java.lang.String getWorkbinPlaceGroupId()
[Optional] Place group names of the groups statistic is required for. If not specified, statistic for place group workbins is not included. The names should be comma separated.


setWorkbinPlaceGroupId

public abstract void setWorkbinPlaceGroupId(java.lang.String workbinPlaceGroupId)
[Optional] Place group names of the groups statistic is required for. If not specified, statistic for place group workbins is not included. The names should be comma separated.


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.