Platform SDK Java 8.5 API Reference

com.genesyslab.platform.routing.protocol.routingserver.requests
Class RequestGetStatistic

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.routing.protocol.routingserver.requests.RequestGetStatistic
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestGetStatistic
extends Message

This request asks URS to provide the statistics values for the specified list of targets. You can use it to determine why the router chose a particular target or so that you can determine the best target in your own application.

Required parameters:

Name Description
Tenant The contact center in whose environment the statistic is to be calculated.
Targets A list of eligible routing targets.
Statistic The statistic to be calculated.

Related Events:
Name Description
EventExecutionAck Indicates that the request executed successfully; provides information about the results of its execution.
EventExecutionError Indicates that the request was not executed successfully.
EventExecutionInProgress Indicates that URS has accepted the request and started to execute it.
EventError Indicates that the request was unknown to URS, or that some parameters were missing or invalid.

Example:

 RequestGetStatistic requestGetStatistic = 
        RequestGetStatistic.create();
 requestGetStatistic.setTenant("TheTenant");
 requestGetStatistic.setTargets("TheTargetList");
 requestGetStatistic.setStatistic("StatAgentsBusy");
 
 Message ret = protocol.request(requestGetStatistic);
 


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestGetStatistic create()
          Creates instance of RequestGetStatistic with no parameters set.
static RequestGetStatistic create(java.lang.String tenant, java.lang.String targets, java.lang.String statistic)
          Creates instance of RequestGetStatistic with all parameters set.
abstract  java.lang.Integer getReferenceId()
          The reference ID that connects a response to a request; if set to 0, it means that the ReferenceId should be assigned by ReferenceBuilder.
abstract  java.lang.String getStatistic()
          The type of statistic to be associated with a request.
abstract  java.lang.String getTargets()
          A list of eligible routing targets.
abstract  java.lang.String getTenant()
          The contact center in whose environment a request is to be executed.
abstract  void setReferenceId(int referenceId)
          The reference ID that connects a response to a request; if set to 0, it means that the ReferenceId should be assigned by ReferenceBuilder.
abstract  void setReferenceId(java.lang.Integer referenceId)
          The reference ID that connects a response to a request; if set to 0, it means that the ReferenceId should be assigned by ReferenceBuilder.
abstract  void setStatistic(java.lang.String statistic)
          The type of statistic to be associated with a request.
abstract  void setTargets(java.lang.String targets)
          A list of eligible routing targets.
abstract  void setTenant(java.lang.String tenant)
          The contact center in whose environment a request is to be executed.
 
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 RequestGetStatistic create()
Creates instance of RequestGetStatistic with no parameters set.

Returns:
instance of RequestGetStatistic

create

public static RequestGetStatistic create(java.lang.String tenant,
                                         java.lang.String targets,
                                         java.lang.String statistic)
Creates instance of RequestGetStatistic with all parameters set.

Parameters:
tenant - The contact center in whose environment a request is to be executed.
targets - A list of eligible routing targets.
statistic - The type of statistic to be associated with a request.
Returns:
instance of RequestGetStatistic

getReferenceId

public abstract java.lang.Integer getReferenceId()
The reference ID that connects a response to a request; if set to 0, it means that the ReferenceId should be assigned by ReferenceBuilder.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
The reference ID that connects a response to a request; if set to 0, it means that the ReferenceId should be assigned by ReferenceBuilder.


setReferenceId

public abstract void setReferenceId(int referenceId)
The reference ID that connects a response to a request; if set to 0, it means that the ReferenceId should be assigned by ReferenceBuilder.


getTenant

public abstract java.lang.String getTenant()
The contact center in whose environment a request is to be executed.


setTenant

public abstract void setTenant(java.lang.String tenant)
The contact center in whose environment a request is to be executed.


getTargets

public abstract java.lang.String getTargets()
A list of eligible routing targets.


setTargets

public abstract void setTargets(java.lang.String targets)
A list of eligible routing targets.


getStatistic

public abstract java.lang.String getStatistic()
The type of statistic to be associated with a request.


setStatistic

public abstract void setStatistic(java.lang.String statistic)
The type of statistic to be associated with a request.


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.