|
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.RequestSearch
public abstract class RequestSearch
This class represents a callback search request. In response to the search
request, Callback Server can send an EventSearchResult
packet or an
EventError
packet. 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 RequestSearch |
create()
Creates instance of RequestSearch with no parameters set. |
static RequestSearch |
create(java.lang.String contact,
MediaType mediaType,
java.lang.Boolean done,
java.lang.String status,
KeyValueCollection userData)
Creates instance of RequestSearch with all parameters set. |
abstract java.lang.String |
getContact()
A string providing contact information for a callback object. |
abstract java.lang.Boolean |
getDone()
A boolean value, indicating whether the callback item has been marked as done. |
abstract MediaType |
getMediaType()
Specifies the media type 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 |
getStatus()
This string describes the current status of a callback 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 |
setDone(java.lang.Boolean done)
A boolean value, indicating whether the callback item has been marked as done. |
abstract void |
setMediaType(MediaType mediaType)
Specifies the media type 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 |
setStatus(java.lang.String status)
This string describes the current status of a callback 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 RequestSearch create()
public static RequestSearch create(java.lang.String contact, MediaType mediaType, java.lang.Boolean done, java.lang.String status, KeyValueCollection userData)
contact
- ContactmediaType
- MediaTypedone
- Donestatus
- StatususerData
- 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 getContact()
public abstract void setContact(java.lang.String contact)
public abstract MediaType getMediaType()
Voice
or VoiceOverIP
.
public abstract void setMediaType(MediaType mediaType)
Voice
or VoiceOverIP
.
public abstract java.lang.Boolean getDone()
public abstract void setDone(java.lang.Boolean done)
public abstract java.lang.String getStatus()
public abstract void setStatus(java.lang.String status)
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 |