Platform SDK Java 8.5 API Reference

com.genesyslab.platform.routing.protocol.routingserver.events
Class EventExecutionAck

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

public abstract class EventExecutionAck
extends Message

Indicates that the specified RequestExecuteStrategy, RequestFindTarget, or RequestGetStatistic executed successfully; provides information about the results of its execution.

Related Requests:

Name Description
RequestExecuteStrategy Asks URS to execute the specified routing strategy.
RequestFindTarget Asks URS to select the most suitable target from a set of eligible targets, such as agent groups.
RequestGetStatistic Asks URS to provide the statistics values for the specified list of targets.

Example:
Here is a sample of the console output for a typical EventExecutionAck:

 'EventExecutionAck' ('200')
 message attributes:
 R_result [bstr] = KVList: 
                                 'DN' [str] = "701"
                                 'CUSTOMER_ID' [str] = "TenantForTest"
                                 'TARGET' [str] = "701_sip@StatServer1.A"
                                 'SWITCH' [str] = "SipSwitch"
                                 'NVQ' [int] = 1
                                 'PLACE' [str] = "701"
                                 'AGENT' [str] = "701_sip"
                                 'ACCESS' [str] = "701"
                                 'VQ' [str] = "1234"
 Context         = ComplexClass(OperationContext):
                 UserData [bstr] = KVList: 
                                                 'ServiceObjective' [str] = ""
                                                 'ServiceType' [str] = "default"
                                                 'CBR-Interaction_cost' [str] = ""
                                                 'RTargetTypeSelected' [str] = "0"
                                                 'CBR-IT-path_DBIDs' [str] = ""
                                                 'RVQDBID' [str] = ""
                                                 'RTargetPlaceSelected' [str] = "701"
                                                 'RTargetAgentSelected' [str] = "701_sip"
                                                 'CBR-actual_volume' [str] = ""
                                                 'RStrategyName' [str] = "##GetTarget"
                                                 'RRequestedSkillCombination' [str] = ""
                                                 'RTargetRuleSelected' [str] = ""
                                                 'RStrategyDBID' [str] = ""
                                                 'RRequestedSkills' [bstr] = KVList: 
 
                                                 'CustomerSegment' [str] = "default"
                                                 'RTargetObjSelDBID' [str] = "984"
                                                 'RTargetObjectSelected' [str] = "701_sip"
                                                 'RTenant' [str] = "TenantForTest"
                                                 'RVQID' [str] = ""
                                                 'CBR-contract_DBIDs' [str] = ""
 R_refID [int]   = 0
 
 


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventExecutionAck create()
          Creates instance of EventExecutionAck with no parameters set.
static EventExecutionAck create(KeyValueCollection result, OperationContext context, java.lang.Integer executionId)
          Creates instance of EventExecutionAck with all parameters set.
abstract  OperationContext getContext()
          Provides information about the associated interaction, using a format similar to TEvent.
abstract  java.lang.Integer getExecutionId()
          The ReferenceId of the request that this request will be executed against.
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  KeyValueCollection getResult()
           
abstract  void setContext(OperationContext context)
          Provides information about the associated interaction, using a format similar to TEvent.
abstract  void setExecutionId(int executionId)
          The ReferenceId of the request that this request will be executed against.
abstract  void setExecutionId(java.lang.Integer executionId)
          The ReferenceId of the request that this request will be executed against.
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 setResult(KeyValueCollection result)
           
 
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 EventExecutionAck create()
Creates instance of EventExecutionAck with no parameters set.

Returns:
instance of EventExecutionAck

create

public static EventExecutionAck create(KeyValueCollection result,
                                       OperationContext context,
                                       java.lang.Integer executionId)
Creates instance of EventExecutionAck with all parameters set.

Parameters:
result -
context - Provides information about the associated interaction, using a format similar to TEvent.
executionId - Request reference to execute control command on.
Returns:
instance of EventExecutionAck

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.


getResult

public abstract KeyValueCollection getResult()
Returns:
property value

setResult

public abstract void setResult(KeyValueCollection result)
Parameters:
result - new value of the property

getContext

public abstract OperationContext getContext()
Provides information about the associated interaction, using a format similar to TEvent.


setContext

public abstract void setContext(OperationContext context)
Provides information about the associated interaction, using a format similar to TEvent.


getExecutionId

public abstract java.lang.Integer getExecutionId()
The ReferenceId of the request that this request will be executed against.


setExecutionId

public abstract void setExecutionId(java.lang.Integer executionId)
The ReferenceId of the request that this request will be executed against.


setExecutionId

public abstract void setExecutionId(int executionId)
The ReferenceId of the request that this request will be executed against.


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.