Platform SDK Java 8.5 API Reference

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

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.RequestQueryAddress
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestQueryAddress
extends Message

Requests the information of type info_type about the thisDN, or the thisQueue, or both, specified in parameters. Refer to the type TAddressInfoType for additional details.
If the query is supported, the requested information is returned in the event EventAddressInfo.
Use this request to synchronize your application with the switch after a disconnection and a reconnection. See also RequestQueryServer.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestQueryAddress create()
          Creates instance of RequestQueryAddress with no parameters set.
static RequestQueryAddress create(java.lang.String thisDN, AddressType addressType, AddressInfoType addressInfoType)
          Creates instance of RequestQueryAddress with required parameters set.
static RequestQueryAddress create(java.lang.String thisDN, AddressType addressType, AddressInfoType addressInfoType, java.lang.String thisQueue, KeyValueCollection extensions, java.lang.String protocolVersion, EventMask inputMask)
          Creates instance of RequestQueryAddress with all parameters set.
abstract  AddressInfoType getAddressInfoType()
          Information about the telephony object in question.
abstract  AddressType getAddressType()
          Address type specifying the telephony object in question.
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  EventMask getInputMask()
          An EventMask that specifies which T-Server Events are transmitted to the application.
abstract  java.lang.String getProtocolVersion()
          Protocol version, usually "tserver protocol 4.2"
abstract  java.lang.Integer getReferenceID()
          Reference ID of the related request.
abstract  java.lang.String getThisDN()
          The Directory Number (which your application registered) involved in this request or event.
abstract  java.lang.String getThisQueue()
          The queue related to ThisDN
abstract  void setAddressInfoType(AddressInfoType addressInfoType)
          Information about the telephony object in question.
abstract  void setAddressType(AddressType addressType)
          Address type specifying the telephony object in question.
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 setInputMask(EventMask inputMask)
          An EventMask that specifies which T-Server Events are transmitted to the application.
abstract  void setProtocolVersion(java.lang.String protocolVersion)
          Protocol version, usually "tserver protocol 4.2"
abstract  void setReferenceID(int referenceID)
          Reference ID of the related request.
abstract  void setReferenceID(java.lang.Integer referenceID)
          Reference ID of the related request.
abstract  void setThisDN(java.lang.String thisDN)
          The Directory Number (which your application registered) involved in this request or event.
abstract  void setThisQueue(java.lang.String thisQueue)
          The queue related to ThisDN
 
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 RequestQueryAddress create()
Creates instance of RequestQueryAddress with no parameters set.

Returns:
instance of RequestQueryAddress

create

public static RequestQueryAddress create(java.lang.String thisDN,
                                         AddressType addressType,
                                         AddressInfoType addressInfoType,
                                         java.lang.String thisQueue,
                                         KeyValueCollection extensions,
                                         java.lang.String protocolVersion,
                                         EventMask inputMask)
Creates instance of RequestQueryAddress with all parameters set.

Parameters:
thisDN - DN of the controlling agent or Route Point.
addressType - Address type specifying the telephony object in question.
addressInfoType - Information about the telephony object in question.
thisQueue - The queue related to ThisDN
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.
protocolVersion - protocol version, usually "tserver protocol 4.2"
inputMask - Specifies which T-Server events can be transmitted to the application.
Returns:
instance of RequestQueryAddress

create

public static RequestQueryAddress create(java.lang.String thisDN,
                                         AddressType addressType,
                                         AddressInfoType addressInfoType)
Creates instance of RequestQueryAddress with required parameters set.

Parameters:
thisDN - DN of the controlling agent or Route Point.
addressType - Address type specifying the telephony object in question.
addressInfoType - Information about the telephony object in question.
Returns:
instance of RequestQueryAddress

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.


getThisDN

public abstract java.lang.String getThisDN()
The Directory Number (which your application registered) involved in this request or event.


setThisDN

public abstract void setThisDN(java.lang.String thisDN)
The Directory Number (which your application registered) involved in this request or event.


getAddressType

public abstract AddressType getAddressType()
Address type specifying the telephony object in question.

Returns:
property value

setAddressType

public abstract void setAddressType(AddressType addressType)
Address type specifying the telephony object in question.

Parameters:
addressType - new value of the property

getAddressInfoType

public abstract AddressInfoType getAddressInfoType()
Information about the telephony object in question.

Returns:
property value

setAddressInfoType

public abstract void setAddressInfoType(AddressInfoType addressInfoType)
Information about the telephony object in question.

Parameters:
addressInfoType - new value of the property

getThisQueue

public abstract java.lang.String getThisQueue()
The queue related to ThisDN

Returns:
property value

setThisQueue

public abstract void setThisQueue(java.lang.String thisQueue)
The queue related to ThisDN

Parameters:
thisQueue - 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

getProtocolVersion

public abstract java.lang.String getProtocolVersion()
Protocol version, usually "tserver protocol 4.2"


setProtocolVersion

public abstract void setProtocolVersion(java.lang.String protocolVersion)
Protocol version, usually "tserver protocol 4.2"


getInputMask

public abstract EventMask getInputMask()
An EventMask that specifies which T-Server Events are transmitted to the application.


setInputMask

public abstract void setInputMask(EventMask inputMask)
An EventMask that specifies which T-Server Events are transmitted to the application.


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.