Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.interactionserver.events
Class EventError

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.interactionserver.events.EventError
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventError
extends Message

This event is a reply to an unsuccessful request.

Direction: From Interaction server to request issuer.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventError create()
          Creates instance of EventError with no parameters set.
static EventError create(java.lang.Integer errorCode)
          Creates instance of EventError with required parameters set.
static EventError create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.Integer errorCode, java.lang.String errorDescription)
          Creates instance of EventError with all parameters set.
abstract  java.lang.Integer getErrorCode()
          The error code.
abstract  java.lang.String getErrorDescription()
          Description of the error.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  java.lang.Integer getProxyClientId()
          Proxy client identifier.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  void setErrorCode(int errorCode)
          The error code.
abstract  void setErrorCode(java.lang.Integer errorCode)
          The error code.
abstract  void setErrorDescription(java.lang.String errorDescription)
          Description of the error.
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setProxyClientId(int proxyClientId)
          Proxy client identifier.
abstract  void setProxyClientId(java.lang.Integer proxyClientId)
          Proxy client identifier.
abstract  void setReferenceId(int referenceId)
          Reference identifier of the request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference identifier of the 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 EventError create()
Creates instance of EventError with no parameters set.

Returns:
instance of EventError

create

public static EventError create(java.lang.Integer proxyClientId,
                                KeyValueCollection extension,
                                java.lang.Integer errorCode,
                                java.lang.String errorDescription)
Creates instance of EventError with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
extension - Extensions.
errorCode - Error code.
errorDescription - Error description.
Returns:
instance of EventError

create

public static EventError create(java.lang.Integer errorCode)
Creates instance of EventError with required parameters set.

Parameters:
errorCode - Error code.
Returns:
instance of EventError

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.


getProxyClientId

public abstract java.lang.Integer getProxyClientId()
Proxy client identifier. Mandatory if client connects via proxy.


setProxyClientId

public abstract void setProxyClientId(java.lang.Integer proxyClientId)
Proxy client identifier. Mandatory if client connects via proxy.


setProxyClientId

public abstract void setProxyClientId(int proxyClientId)
Proxy client identifier. Mandatory if client connects via proxy.


getExtension

public abstract KeyValueCollection getExtension()
A key-value list of extensions. For media servers the following extensions are defined, with values of type integer:


setExtension

public abstract void setExtension(KeyValueCollection extension)
A key-value list of extensions. For media servers the following extensions are defined, with values of type integer:


getErrorCode

public abstract java.lang.Integer getErrorCode()
The error code.


setErrorCode

public abstract void setErrorCode(java.lang.Integer errorCode)
The error code.


setErrorCode

public abstract void setErrorCode(int errorCode)
The error code.


getErrorDescription

public abstract java.lang.String getErrorDescription()
Description of the error.


setErrorDescription

public abstract void setErrorDescription(java.lang.String errorDescription)
Description of the error.


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.