|
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.voice.protocol.tserver.requests.queries.RequestQueryLocation
public abstract class RequestQueryLocation
Allows a client to receive information specified by the info_type parameter about one or more remote locations specified by the location parameter. T-Server generates an EventLocationInfo in response to the function TQueryLocation().
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestQueryLocation |
create()
Creates instance of RequestQueryLocation with no parameters set. |
static RequestQueryLocation |
create(java.lang.String location,
LocationInfoType locationInfoType)
Creates instance of RequestQueryLocation with required parameters set. |
static RequestQueryLocation |
create(java.lang.String location,
LocationInfoType locationInfoType,
KeyValueCollection extensions)
Creates instance of RequestQueryLocation with all parameters set. |
abstract KeyValueCollection |
getExtensions()
An additional data structure intended to take account of switch-specific features that cannot be described by other parameters or in the original structure of user data. |
abstract java.lang.String |
getLocation()
Name of the remote location in the form of `SwitchName` or `T-ServerApplicationName`@`SwitchName`. |
abstract LocationInfoType |
getLocationInfoType()
Allows a client to receive information about one or more remote locations |
abstract java.lang.Integer |
getReferenceID()
Reference ID of the related request. |
abstract void |
setExtensions(KeyValueCollection extensions)
An additional data structure intended to take account of switch-specific features that cannot be described by other parameters or in the original structure of user data. |
abstract void |
setLocation(java.lang.String location)
Name of the remote location in the form of `SwitchName` or `T-ServerApplicationName`@`SwitchName`. |
abstract void |
setLocationInfoType(LocationInfoType locationInfoType)
Allows a client to receive information about one or more remote locations |
abstract void |
setReferenceID(int referenceID)
Reference ID of the related request. |
abstract void |
setReferenceID(java.lang.Integer referenceID)
Reference ID of the related 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 RequestQueryLocation create()
public static RequestQueryLocation create(java.lang.String location, LocationInfoType locationInfoType, KeyValueCollection extensions)
location
- Name of the remote location in the form of `SwitchName` or `T-ServerApplicationName`@`SwitchName`.locationInfoType
- Allows a client to receive information about one or more remote locationsextensions
- An additional data structure intended to take account of switch-specific features that cannot be described by other parameters or in the original structure of user data.
public static RequestQueryLocation create(java.lang.String location, LocationInfoType locationInfoType)
location
- Name of the remote location in the form of `SwitchName` or `T-ServerApplicationName`@`SwitchName`.locationInfoType
- Allows a client to receive information about one or more remote locations
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 getLocation()
public abstract void setLocation(java.lang.String location)
location
- new value of the propertypublic abstract LocationInfoType getLocationInfoType()
public abstract void setLocationInfoType(LocationInfoType locationInfoType)
locationInfoType
- new value of the propertypublic abstract KeyValueCollection getExtensions()
public abstract void setExtensions(KeyValueCollection extensions)
extensions
- new value of the property
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |