Platform SDK Java 8.5 API Reference

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

public abstract class EventError
extends Message

This event is a reply to an unsuccessful request. An EventError event includes a description of the error, together with ErrorId and OccurredAt strings.


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.String occurredAt, java.lang.String errorId, Description description)
          Creates instance of EventError with all parameters set.
abstract  Description getDescription()
           
abstract  java.lang.String getErrorId()
          The error ID returned in an EventError event.
abstract  java.lang.String getOccurredAt()
          Indicates when an event occurred.
abstract  java.lang.Integer getReferenceId()
          The unique reference ID for any requests or events.
abstract  void setDescription(Description description)
           
abstract  void setErrorId(java.lang.String errorId)
          The error ID returned in an EventError event.
abstract  void setOccurredAt(java.lang.String occurredAt)
          Indicates when an event occurred.
abstract  void setReferenceId(int referenceId)
          The unique reference ID for any requests or events.
abstract  void setReferenceId(java.lang.Integer referenceId)
          The unique reference ID for any requests or events.
 
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.String occurredAt,
                                java.lang.String errorId,
                                Description description)
Creates instance of EventError with all parameters set.

Parameters:
occurredAt - OccurredAt
errorId - ErrorId
description - Description
Returns:
instance of EventError

getReferenceId

public abstract java.lang.Integer getReferenceId()
The unique reference ID for any requests or events.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
The unique reference ID for any requests or events.


setReferenceId

public abstract void setReferenceId(int referenceId)
The unique reference ID for any requests or events.


getOccurredAt

public abstract java.lang.String getOccurredAt()
Indicates when an event occurred.


setOccurredAt

public abstract void setOccurredAt(java.lang.String occurredAt)
Indicates when an event occurred.


getErrorId

public abstract java.lang.String getErrorId()
The error ID returned in an EventError event.


setErrorId

public abstract void setErrorId(java.lang.String errorId)
The error ID returned in an EventError event.


getDescription

public abstract Description getDescription()

setDescription

public abstract void setDescription(Description description)

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.