Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.externalservice.request
Class Request3rdServer

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.openmedia.protocol.externalservice.request.Request3rdServer
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class Request3rdServer
extends Message

Requests a third-party server to perform some operation.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static Request3rdServer create()
          Creates instance of Request3rdServer with no parameters set.
static Request3rdServer create(KeyValueCollection request)
          Creates instance of Request3rdServer with required parameters set.
static Request3rdServer create(KeyValueCollection request, KeyValueCollection userData)
          Creates instance of Request3rdServer with all parameters set.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  KeyValueCollection getRequest()
           
abstract  KeyValueCollection getUserData()
          Pointer to a key-value collection of user data that should be attached to the interaction.
abstract  void setReferenceId(int referenceId)
          Reference identifier of the request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference identifier of the request.
abstract  void setRequest(KeyValueCollection request)
           
abstract  void setUserData(KeyValueCollection userData)
          Pointer to a key-value collection of user data that should be attached to the interaction.
 
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 Request3rdServer create()
Creates instance of Request3rdServer with no parameters set.

Returns:
instance of Request3rdServer

create

public static Request3rdServer create(KeyValueCollection request,
                                      KeyValueCollection userData)
Creates instance of Request3rdServer with all parameters set.

Parameters:
request - Request
userData - UserData
Returns:
instance of Request3rdServer

create

public static Request3rdServer create(KeyValueCollection request)
Creates instance of Request3rdServer with required parameters set.

Parameters:
request - Request
Returns:
instance of Request3rdServer

getReferenceId

public abstract java.lang.Integer getReferenceId()
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


setReferenceId

public abstract void setReferenceId(int referenceId)
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


getRequest

public abstract KeyValueCollection getRequest()

setRequest

public abstract void setRequest(KeyValueCollection request)

getUserData

public abstract KeyValueCollection getUserData()
Pointer to a key-value collection of user data that should be attached to the interaction.


setUserData

public abstract void setUserData(KeyValueCollection userData)
Pointer to a key-value collection of user data that should be attached to the interaction.


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.