Platform SDK Java 8.5 API Reference

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

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

public abstract class EventInfo
extends Message

This event contains information about URS's handling of the specified RequestLoadStrategy, RequestNotify, or RequestReleaseStrategy; it can contain the loading status of any single routing point.

Related Requests:

Name Description
RequestLoadStrategy 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.
RequestNotify Asks for the current loading status of all routing points that were loaded by means of the specified RequestLoadStrategy.
RequestReleaseStrategy Disassociates a routing point from a strategy that was previously loaded with RequestLoadStrategy.

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

 'EventInfo' (2) attributes:
                 R_Message [str] = "ATTENTION: Strategy has been loaded from ooo-file."
                 R_cdn_status [int] = 1 [Loaded]
                 R_cdn [str] = "RP_sip1"
                 R_ErrorCode [int] = 0 [NoError]
                 R_tserver [str] = "TServerSip1"
                 R_refID [int] = 1
                 R_time [str] = "06/30/2010 10:00:29"
                 R_path [str] = "<Path>"
 


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventInfo create()
          Creates instance of EventInfo with no parameters set.
static EventInfo create(java.lang.Integer clientId, java.lang.String tServer, java.lang.String routingPoint, java.lang.String path, java.lang.String timestamp, java.lang.String message, RoutingPointStatus routingPointStatus, ErrorCode errorCode, java.lang.String errorMessage, OperationContext context, KeyValueCollection result)
          Creates instance of EventInfo with all parameters set.
abstract  java.lang.Integer getClientId()
           
abstract  OperationContext getContext()
          Provides information about the associated interaction, using a format similar to TEvent.
abstract  ErrorCode getErrorCode()
           
abstract  java.lang.String getErrorMessage()
           
abstract  java.lang.String getMessage()
           
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  KeyValueCollection getResult()
           
abstract  java.lang.String getRoutingPoint()
          The routing point that is to be loaded or released.
abstract  RoutingPointStatus getRoutingPointStatus()
           
abstract  java.lang.String getTimestamp()
           
abstract  java.lang.String getTServer()
          The T-Server to be used by the strategy associated with this request.
abstract  void setClientId(int clientId)
           
abstract  void setClientId(java.lang.Integer clientId)
           
abstract  void setContext(OperationContext context)
          Provides information about the associated interaction, using a format similar to TEvent.
abstract  void setErrorCode(ErrorCode errorCode)
           
abstract  void setErrorMessage(java.lang.String errorMessage)
           
abstract  void setMessage(java.lang.String message)
           
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 setResult(KeyValueCollection result)
           
abstract  void setRoutingPoint(java.lang.String routingPoint)
          The routing point that is to be loaded or released.
abstract  void setRoutingPointStatus(RoutingPointStatus routingPointStatus)
           
abstract  void setTimestamp(java.lang.String timestamp)
           
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 EventInfo create()
Creates instance of EventInfo with no parameters set.

Returns:
instance of EventInfo

create

public static EventInfo create(java.lang.Integer clientId,
                               java.lang.String tServer,
                               java.lang.String routingPoint,
                               java.lang.String path,
                               java.lang.String timestamp,
                               java.lang.String message,
                               RoutingPointStatus routingPointStatus,
                               ErrorCode errorCode,
                               java.lang.String errorMessage,
                               OperationContext context,
                               KeyValueCollection result)
Creates instance of EventInfo with all parameters set.

Parameters:
clientId -
tServer - The T-Server to be used by the strategy associated with this request.
routingPoint -
path -
timestamp -
message -
routingPointStatus -
errorCode -
errorMessage -
context - Provides information about the associated interaction, using a format similar to TEvent.
result -
Returns:
instance of EventInfo

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.


getClientId

public abstract java.lang.Integer getClientId()
Returns:
property value

setClientId

public abstract void setClientId(java.lang.Integer clientId)
Parameters:
clientId - new value of the property

setClientId

public abstract void setClientId(int clientId)
Parameters:
clientId - new value of the property

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.


getTimestamp

public abstract java.lang.String getTimestamp()
Returns:
property value

setTimestamp

public abstract void setTimestamp(java.lang.String timestamp)
Parameters:
timestamp - new value of the property

getMessage

public abstract java.lang.String getMessage()
Returns:
property value

setMessage

public abstract void setMessage(java.lang.String message)
Parameters:
message - new value of the property

getRoutingPointStatus

public abstract RoutingPointStatus getRoutingPointStatus()
Returns:
property value

setRoutingPointStatus

public abstract void setRoutingPointStatus(RoutingPointStatus routingPointStatus)
Parameters:
routingPointStatus - new value of the property

getErrorCode

public abstract ErrorCode getErrorCode()
Returns:
property value

setErrorCode

public abstract void setErrorCode(ErrorCode errorCode)
Parameters:
errorCode - new value of the property

getErrorMessage

public abstract java.lang.String getErrorMessage()
Returns:
property value

setErrorMessage

public abstract void setErrorMessage(java.lang.String errorMessage)
Parameters:
errorMessage - 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.


getResult

public abstract KeyValueCollection getResult()
Returns:
property value

setResult

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

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.