Platform SDK Java 8.5 API Reference

com.genesyslab.platform.routing.protocol.routingserver.runtime.channel
Class RequestExecute

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.runtime.channel.RequestExecute
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestExecute
extends Message


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestExecute create()
          Creates instance of RequestExecute with no parameters set.
static RequestExecute create(KeyValueCollection envelope)
          Creates instance of RequestExecute with all parameters set.
abstract  KeyValueCollection getEnvelope()
           
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 setEnvelope(KeyValueCollection envelope)
           
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 RequestExecute create()
Creates instance of RequestExecute with no parameters set.

Returns:
instance of RequestExecute

create

public static RequestExecute create(KeyValueCollection envelope)
Creates instance of RequestExecute with all parameters set.

Parameters:
envelope -
Returns:
instance of RequestExecute

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.


getEnvelope

public abstract KeyValueCollection getEnvelope()
Returns:
property value

setEnvelope

public abstract void setEnvelope(KeyValueCollection envelope)
Parameters:
envelope - 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.