Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestDebug
extends Message

This request can be used for debugging SCXML strategies; it is deprecated, because the SCXML engine was moved into a separate component (Orchestration Server) with its own debugging interface.

Required parameters:

Name Description
DebugMessage A debugging message of your choice.

Related Events:
Name Description
EventDebug Contains the current debugging content of the specified session.
EventError Indicates that the request was unknown to URS, or that some parameters were missing or invalid.

Example:

 RequestDebug requestDebug = RequestDebug.create();
 requestDebug.setDebugMessage("Debugging Message");
 
 Message response = protocol.request(requestDebug);
 


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestDebug create()
          Creates instance of RequestDebug with no parameters set.
static RequestDebug create(java.lang.String debugMessage)
          Creates instance of RequestDebug with all parameters set.
abstract  java.lang.String getDebugMessage()
          A debugging message of your choice.
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  void setDebugMessage(java.lang.String debugMessage)
          A debugging message of your choice.
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.
 
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 RequestDebug create()
Creates instance of RequestDebug with no parameters set.

Returns:
instance of RequestDebug

create

public static RequestDebug create(java.lang.String debugMessage)
Creates instance of RequestDebug with all parameters set.

Parameters:
debugMessage - A debugging message of your choice.
Returns:
instance of RequestDebug

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.


getDebugMessage

public abstract java.lang.String getDebugMessage()
A debugging message of your choice.


setDebugMessage

public abstract void setDebugMessage(java.lang.String debugMessage)
A debugging message of your choice.


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.