|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.webmedia.protocol.basicchat.events.EventError
public abstract class EventError
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static EventError create()
public static EventError create(java.lang.String occurredAt, java.lang.String errorId, Description description)
occurredAt
- OccurredAterrorId
- ErrorIddescription
- Description
public abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract java.lang.String getOccurredAt()
public abstract void setOccurredAt(java.lang.String occurredAt)
public abstract java.lang.String getErrorId()
EventError
event.
public abstract void setErrorId(java.lang.String errorId)
EventError
event.
public abstract Description getDescription()
public abstract void setDescription(Description description)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |