Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.externalservice.event
Class Event3rdServerResponse

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

public abstract class Event3rdServerResponse
extends Message

Returns the results of the third-party server's operation.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static Event3rdServerResponse create()
          Creates instance of Event3rdServerResponse with no parameters set.
static Event3rdServerResponse create(KeyValueCollection request)
          Creates instance of Event3rdServerResponse with required parameters set.
static Event3rdServerResponse create(KeyValueCollection request, KeyValueCollection userData)
          Creates instance of Event3rdServerResponse 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 Event3rdServerResponse create()
Creates instance of Event3rdServerResponse with no parameters set.

Returns:
instance of Event3rdServerResponse

create

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

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

create

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

Parameters:
request - Request
Returns:
instance of Event3rdServerResponse

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.