Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.callback.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.webmedia.protocol.callback.events.EventError
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventError
extends Message

The EventError class encodes and decodes a packet containing a callback error.


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, java.lang.String description)
          Creates instance of EventError with all parameters set.
abstract  java.lang.String getDescription()
          A description of the error.
abstract  java.lang.Integer getErrorCode()
          The error code returned in an EventError.
abstract  java.lang.Integer getReferenceId()
          An integer that provides a unique identifier for each request or event message.
abstract  void setDescription(java.lang.String description)
          A description of the error.
abstract  void setErrorCode(int errorCode)
          The error code returned in an EventError.
abstract  void setErrorCode(java.lang.Integer errorCode)
          The error code returned in an EventError.
abstract  void setReferenceId(int referenceId)
          An integer that provides a unique identifier for each request or event message.
abstract  void setReferenceId(java.lang.Integer referenceId)
          An integer that provides a unique identifier for each request or event message.
 
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 errorCode,
                                java.lang.String description)
Creates instance of EventError with all parameters set.

Parameters:
errorCode - ErrorCode
description - Description
Returns:
instance of EventError

getReferenceId

public abstract java.lang.Integer getReferenceId()
An integer that provides a unique identifier for each request or event message.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
An integer that provides a unique identifier for each request or event message.


setReferenceId

public abstract void setReferenceId(int referenceId)
An integer that provides a unique identifier for each request or event message.


getErrorCode

public abstract java.lang.Integer getErrorCode()
The error code returned in an EventError.


setErrorCode

public abstract void setErrorCode(java.lang.Integer errorCode)
The error code returned in an EventError.


setErrorCode

public abstract void setErrorCode(int errorCode)
The error code returned in an EventError.


getDescription

public abstract java.lang.String getDescription()
A description of the error.


setDescription

public abstract void setDescription(java.lang.String description)
A 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.