|
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.runtime.CompoundValue
com.genesyslab.platform.webmedia.protocol.flexchat.Description
public abstract class Description
Event notification or error description structure.
Constructor Summary | |
---|---|
Description()
|
Method Summary | |
---|---|
static Description |
create()
Creates instance of Description with no parameters set. |
static Description |
create(java.lang.String errorId)
Creates instance of Description with required parameters set. |
static Description |
create(java.lang.String errorId,
java.lang.String text)
Creates instance of Description with all parameters set. |
abstract java.lang.String |
getErrorId()
The error ID returned in an EventError event. |
abstract java.lang.String |
getText()
If NoticeType is not equal to None , then this property contains the notification text. |
abstract void |
setErrorId(java.lang.String errorId)
The error ID returned in an EventError event. |
abstract void |
setText(java.lang.String text)
If NoticeType is not equal to None , then this property contains the notification text. |
Methods inherited from class com.genesyslab.platform.commons.protocol.runtime.CompoundValue |
---|
getProtocolDescription |
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 |
Constructor Detail |
---|
public Description()
Method Detail |
---|
public static Description create()
public static Description create(java.lang.String errorId, java.lang.String text)
errorId
- ErrorIdtext
- Text
public static Description create(java.lang.String errorId)
errorId
- ErrorId
public abstract java.lang.String getErrorId()
EventError
event.
public abstract void setErrorId(java.lang.String errorId)
EventError
event.
public abstract java.lang.String getText()
NoticeType
is not equal to None
, then this property contains the notification text. Otherwise, it holds the message text.
public abstract void setText(java.lang.String text)
NoticeType
is not equal to None
, then this property contains the notification text. Otherwise, it holds the message text.
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |