Platform SDK Java 8.5 API Reference

com.genesyslab.platform.voice.protocol.tserver.requests.queries
Class RequestQueryLocation

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.voice.protocol.tserver.requests.queries.RequestQueryLocation
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestQueryLocation
extends Message

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

ID

public static final int ID
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values
Method Detail

create

public static RequestQueryLocation create()
Creates instance of RequestQueryLocation with no parameters set.

Returns:
instance of RequestQueryLocation

create

public static RequestQueryLocation create(java.lang.String location,
                                          LocationInfoType locationInfoType,
                                          KeyValueCollection extensions)
Creates instance of RequestQueryLocation with all parameters set.

Parameters:
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
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.
Returns:
instance of RequestQueryLocation

create

public static RequestQueryLocation create(java.lang.String location,
                                          LocationInfoType locationInfoType)
Creates instance of RequestQueryLocation with required parameters set.

Parameters:
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
Returns:
instance of RequestQueryLocation

getReferenceID

public abstract java.lang.Integer getReferenceID()
Reference ID of the related request. In event objects, this reference ID indicates to which request the event refers to.


setReferenceID

public abstract void setReferenceID(java.lang.Integer referenceID)
Reference ID of the related request. In event objects, this reference ID indicates to which request the event refers to.


setReferenceID

public abstract void setReferenceID(int referenceID)
Reference ID of the related request. In event objects, this reference ID indicates to which request the event refers to.


getLocation

public abstract java.lang.String getLocation()
Name of the remote location in the form of `SwitchName` or `T-ServerApplicationName`@`SwitchName`.

Returns:
property value

setLocation

public abstract void setLocation(java.lang.String location)
Name of the remote location in the form of `SwitchName` or `T-ServerApplicationName`@`SwitchName`.

Parameters:
location - new value of the property

getLocationInfoType

public abstract LocationInfoType getLocationInfoType()
Allows a client to receive information about one or more remote locations

Returns:
property value

setLocationInfoType

public abstract void setLocationInfoType(LocationInfoType locationInfoType)
Allows a client to receive information about one or more remote locations

Parameters:
locationInfoType - new value of the property

getExtensions

public 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.

Returns:
property value

setExtensions

public 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.

Parameters:
extensions - new value of the property

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.