Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestFindTarget
extends Message

This request asks URS to select the most suitable target from a set of eligible targets, such as agent groups. Depending on the specified wait time, this request can take a significant amount of time to complete.

Required parameters:

Name Description
Tenant The contact center in whose environment the target is to be found.
Targets A list of eligible routing targets.
Statistic The statistic to be applied.
StatisticUsage Indicates whether to select the minimum, maximum, or any value.
VirtualQueue The queue that interactions will be placed into.

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:

 RequestFindTarget requestFindTarget = RequestFindTarget.create();
 requestFindTarget.setTenant("TheTenant");
 requestFindTarget.setTargets("TheTargetList");
 requestFindTarget.setTimeout(5);
 requestFindTarget.setStatistic("TheStatistic");
 requestFindTarget.setStatisticUsage(StatisticUsage.setMax);
 requestFindTarget.setVirtualQueue("TheQueue");
 requestFindTarget.setPriority(1);
 requestFindTarget.setMediaType("TheMediaType");
 
 Message response = protocol.request(requestFindTarget);
 


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestFindTarget create()
          Creates instance of RequestFindTarget with no parameters set.
static RequestFindTarget create(java.lang.String tenant, java.lang.String targets, java.lang.Integer timeout, java.lang.String statistic, StatisticUsage statisticUsage, java.lang.String virtualQueue, java.lang.Integer priority, java.lang.String mediaType)
          Creates instance of RequestFindTarget with all parameters set.
abstract  java.lang.String getMediaType()
          The media type of a target.
abstract  java.lang.Integer getPriority()
          Sets the default priority for the interactions processed by the selected target.
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  StatisticUsage getStatisticUsage()
          Indicates whether to select the minimum, the maximum, or any value for a given statistic.
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  java.lang.Integer getTimeout()
          The length of time to wait before cancelling a request.
abstract  java.lang.String getVirtualQueue()
          The queue that interactions will be placed into.
abstract  void setMediaType(java.lang.String mediaType)
          The media type of a target.
abstract  void setPriority(int priority)
          Sets the default priority for the interactions processed by the selected target.
abstract  void setPriority(java.lang.Integer priority)
          Sets the default priority for the interactions processed by the selected target.
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 setStatisticUsage(StatisticUsage statisticUsage)
          Indicates whether to select the minimum, the maximum, or any value for a given statistic.
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.
abstract  void setTimeout(int timeout)
          The length of time to wait before cancelling a request.
abstract  void setTimeout(java.lang.Integer timeout)
          The length of time to wait before cancelling a request.
abstract  void setVirtualQueue(java.lang.String virtualQueue)
          The queue that interactions will be placed into.
 
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 RequestFindTarget create()
Creates instance of RequestFindTarget with no parameters set.

Returns:
instance of RequestFindTarget

create

public static RequestFindTarget create(java.lang.String tenant,
                                       java.lang.String targets,
                                       java.lang.Integer timeout,
                                       java.lang.String statistic,
                                       StatisticUsage statisticUsage,
                                       java.lang.String virtualQueue,
                                       java.lang.Integer priority,
                                       java.lang.String mediaType)
Creates instance of RequestFindTarget 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.
timeout - The length of time to wait before cancelling a request.
statistic - The type of statistic to be associated with a request.
statisticUsage - Indicates whether to select the minimum, the maximum, or any value for a given statistic.
virtualQueue - The queue that interactions will be placed into.
priority -
mediaType -
Returns:
instance of RequestFindTarget

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.


getTimeout

public abstract java.lang.Integer getTimeout()
The length of time to wait before cancelling a request.


setTimeout

public abstract void setTimeout(java.lang.Integer timeout)
The length of time to wait before cancelling a request.


setTimeout

public abstract void setTimeout(int timeout)
The length of time to wait before cancelling a request.


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.


getStatisticUsage

public abstract StatisticUsage getStatisticUsage()
Indicates whether to select the minimum, the maximum, or any value for a given statistic.


setStatisticUsage

public abstract void setStatisticUsage(StatisticUsage statisticUsage)
Indicates whether to select the minimum, the maximum, or any value for a given statistic.


getVirtualQueue

public abstract java.lang.String getVirtualQueue()
The queue that interactions will be placed into.


setVirtualQueue

public abstract void setVirtualQueue(java.lang.String virtualQueue)
The queue that interactions will be placed into.


getPriority

public abstract java.lang.Integer getPriority()
Sets the default priority for the interactions processed by the selected target.


setPriority

public abstract void setPriority(java.lang.Integer priority)
Sets the default priority for the interactions processed by the selected target.


setPriority

public abstract void setPriority(int priority)
Sets the default priority for the interactions processed by the selected target.


getMediaType

public abstract java.lang.String getMediaType()
The media type of a target.


setMediaType

public abstract void setMediaType(java.lang.String mediaType)
The media type of a target.


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.