Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestLoadStrategy
extends Message

This request allows you to load a compiled strategy or schedule in URS, provide a name for it, and optionally associate the strategy with a routing point. If you use this request to associate a strategy with a routing point, all interactions arriving on the routing point will be processed with that strategy.

Required parameters:

Name Description
RoutingPoint The routing point to be associated with the strategy.
TServer The T-Server to be used by the strategy.
Path The path to the file containing the strategy.

Related Events:
Name Description
EventInfo Contains information about URS's handling of your request.
EventError Indicates that the request was unknown to URS, or that some parameters were missing or invalid.

Example:

 RequestLoadStrategy requestLoadStrategy = 
        RequestLoadStrategy.create();
 requestLoadStrategy.setTServer("TheT-Server");
 requestLoadStrategy.setRoutingPoint("TheRoutingPoint");
 requestLoadStrategy.setPath("<Path to the strategy>");
 
 Message response = protocol.request(requestLoadStrategy);
 


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestLoadStrategy create()
          Creates instance of RequestLoadStrategy with no parameters set.
static RequestLoadStrategy create(java.lang.String tServer, java.lang.String routingPoint, java.lang.String path, java.lang.String strategy)
          Creates instance of RequestLoadStrategy with all parameters set.
abstract  java.lang.String getPath()
          The path to the routing strategy that is to be loaded.
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 getRoutingPoint()
          The routing point that is to be loaded or released.
abstract  java.lang.String getStrategy()
          The routing strategy that is to be executed.
abstract  java.lang.String getTServer()
          The T-Server to be used by the strategy associated with this request.
abstract  void setPath(java.lang.String path)
          The path to the routing strategy that is to be loaded.
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 setRoutingPoint(java.lang.String routingPoint)
          The routing point that is to be loaded or released.
abstract  void setStrategy(java.lang.String strategy)
          The routing strategy that is to be executed.
abstract  void setTServer(java.lang.String tServer)
          The T-Server to be used by the strategy associated with this request.
 
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 RequestLoadStrategy create()
Creates instance of RequestLoadStrategy with no parameters set.

Returns:
instance of RequestLoadStrategy

create

public static RequestLoadStrategy create(java.lang.String tServer,
                                         java.lang.String routingPoint,
                                         java.lang.String path,
                                         java.lang.String strategy)
Creates instance of RequestLoadStrategy with all parameters set.

Parameters:
tServer - The T-Server to be used by the strategy associated with this request.
routingPoint -
path -
strategy - The routing strategy that is to be executed.
Returns:
instance of RequestLoadStrategy

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.


getTServer

public abstract java.lang.String getTServer()
The T-Server to be used by the strategy associated with this request.


setTServer

public abstract void setTServer(java.lang.String tServer)
The T-Server to be used by the strategy associated with this request.


getRoutingPoint

public abstract java.lang.String getRoutingPoint()
The routing point that is to be loaded or released.


setRoutingPoint

public abstract void setRoutingPoint(java.lang.String routingPoint)
The routing point that is to be loaded or released.


getPath

public abstract java.lang.String getPath()
The path to the routing strategy that is to be loaded.


setPath

public abstract void setPath(java.lang.String path)
The path to the routing strategy that is to be loaded.


getStrategy

public abstract java.lang.String getStrategy()
The routing strategy that is to be executed.


setStrategy

public abstract void setStrategy(java.lang.String strategy)
The routing strategy that is to be executed.


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.