|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.routing.protocol.routingserver.requests.RequestExecuteStrategy
public abstract class RequestExecuteStrategy
Requests that URS execute the specified routing strategy.
The response to this request includes the extensions of the associated
interaction at the moment the strategy completed execution. Additional
output information can be passed through the execution context. Depending
on the strategy, this request can take a significant amount of time to complete.
Required parameters:
Name | Description |
---|---|
Strategy | The routing strategy that is to be executed. |
Tenant | The contact center in whose environment the routing strategy is to be executed. |
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. |
RequestExecuteStrategy requestExecuteStrategy =
RequestExecuteStrategy.create();
requestExecuteStrategy.setStrategy("TheRoutingStrategyName");
requestExecuteStrategy.setTenant("TheTenant");
Message response = protocol.request(requestExecuteStrategy);
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestExecuteStrategy |
create()
Creates instance of RequestExecuteStrategy with no parameters set. |
static RequestExecuteStrategy |
create(java.lang.String strategy,
java.lang.String tenant,
OperationContext context)
Creates instance of RequestExecuteStrategy with all parameters set. |
abstract OperationContext |
getContext()
Provides information about the associated interaction, using a format similar to TEvent. |
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 |
getStrategy()
The routing strategy that is to be executed. |
abstract java.lang.String |
getTenant()
The contact center in whose environment a request is to be executed. |
abstract void |
setContext(OperationContext context)
Provides information about the associated interaction, using a format similar to TEvent. |
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 |
setStrategy(java.lang.String strategy)
The routing strategy that is to be executed. |
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static RequestExecuteStrategy create()
public static RequestExecuteStrategy create(java.lang.String strategy, java.lang.String tenant, OperationContext context)
strategy
- The routing strategy that is to be executed.tenant
- The contact center in whose environment a request is to be executed.context
- Provides information about the associated interaction, using a format similar to TEvent.
public abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract java.lang.String getStrategy()
public abstract void setStrategy(java.lang.String strategy)
public abstract java.lang.String getTenant()
public abstract void setTenant(java.lang.String tenant)
public abstract OperationContext getContext()
public abstract void setContext(OperationContext context)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |