Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestQueryCall
extends Message

Requests the information specified by info_type about the telephony object specified by conn_id. If the query type is supported, the requested information will be returned in EventPartyInfo.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestQueryCall create()
          Creates instance of RequestQueryCall with no parameters set.
static RequestQueryCall create(java.lang.String thisDN, ConnectionId connID, CallInfoType callInfoType)
          Creates instance of RequestQueryCall with required parameters set.
static RequestQueryCall create(java.lang.String thisDN, ConnectionId connID, CallInfoType callInfoType, KeyValueCollection extensions)
          Creates instance of RequestQueryCall with all parameters set.
abstract  CallInfoType getCallInfoType()
          Type of the requested information.
abstract  ConnectionId getConnID()
          Connection identifier of the current call handled by the DN.
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.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  void setCallInfoType(CallInfoType callInfoType)
          Type of the requested information.
abstract  void setConnID(ConnectionId connID)
          Connection identifier of the current call handled by the DN.
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 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.
 
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 RequestQueryCall create()
Creates instance of RequestQueryCall with no parameters set.

Returns:
instance of RequestQueryCall

create

public static RequestQueryCall create(java.lang.String thisDN,
                                      ConnectionId connID,
                                      CallInfoType callInfoType,
                                      KeyValueCollection extensions)
Creates instance of RequestQueryCall with all parameters set.

Parameters:
thisDN - DN of the controlling agent or Route Point.
connID - Connection identifier of the current call handled by the DN.
callInfoType - Type of the requested information.
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 RequestQueryCall

create

public static RequestQueryCall create(java.lang.String thisDN,
                                      ConnectionId connID,
                                      CallInfoType callInfoType)
Creates instance of RequestQueryCall with required parameters set.

Parameters:
thisDN - DN of the controlling agent or Route Point.
connID - Connection identifier of the current call handled by the DN.
callInfoType - Type of the requested information.
Returns:
instance of RequestQueryCall

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.


getConnID

public abstract ConnectionId getConnID()
Connection identifier of the current call handled by the DN.


setConnID

public abstract void setConnID(ConnectionId connID)
Connection identifier of the current call handled by the DN.


getCallInfoType

public abstract CallInfoType getCallInfoType()
Type of the requested information.

Returns:
property value

setCallInfoType

public abstract void setCallInfoType(CallInfoType callInfoType)
Type of the requested information.

Parameters:
callInfoType - 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.