|
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.openmedia.protocol.interactionserver.events.EventError
public abstract class EventError
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static EventError create()
public static EventError create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.Integer errorCode, java.lang.String errorDescription)
proxyClientId
- The identifier of the client of proxy.extension
- Extensions.errorCode
- Error code.errorDescription
- Error description.
public static EventError create(java.lang.Integer errorCode)
errorCode
- Error code.
public abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract java.lang.Integer getProxyClientId()
public abstract void setProxyClientId(java.lang.Integer proxyClientId)
public abstract void setProxyClientId(int proxyClientId)
public abstract KeyValueCollection getExtension()
public abstract void setExtension(KeyValueCollection extension)
public abstract java.lang.Integer getErrorCode()
public abstract void setErrorCode(java.lang.Integer errorCode)
public abstract void setErrorCode(int errorCode)
public abstract java.lang.String getErrorDescription()
public abstract void setErrorDescription(java.lang.String errorDescription)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |