|
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.callback.requests.RequestCancel
public abstract class RequestCancel
The RequestCancel
class encodes and decodes packets
containing requests to cancel a callback request.
In response to the cancellation request, Callback Server can send an
acknowledgement packet EventAck
or an error packet
EventError
. This response packet contains the same
reference identifier as the request packet.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestCancel |
create()
Creates instance of RequestCancel with no parameters set. |
static RequestCancel |
create(java.lang.String requestId,
java.lang.String contact,
KeyValueCollection userData)
Creates instance of RequestCancel with all parameters set. |
abstract java.lang.String |
getContact()
A string providing contact information for a callback object. |
abstract java.lang.Integer |
getReferenceId()
An integer that provides a unique identifier for each request or event message. |
abstract java.lang.String |
getRequestId()
This string identifies a particular request. |
abstract KeyValueCollection |
getUserData()
A key value collection that contains user data. |
abstract void |
setContact(java.lang.String contact)
A string providing contact information for a callback object. |
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. |
abstract void |
setRequestId(java.lang.String requestId)
This string identifies a particular request. |
abstract void |
setUserData(KeyValueCollection userData)
A key value collection that contains user data. |
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 RequestCancel create()
public static RequestCancel create(java.lang.String requestId, java.lang.String contact, KeyValueCollection userData)
requestId
- RequestIdcontact
- ContactuserData
- UserData
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 getRequestId()
RequestId
that you set.
public abstract void setRequestId(java.lang.String requestId)
RequestId
that you set.
public abstract java.lang.String getContact()
public abstract void setContact(java.lang.String contact)
public abstract KeyValueCollection getUserData()
public abstract void setUserData(KeyValueCollection userData)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |