Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestQuerySwitch
extends Message

Requests from the T-Server, specified by the parameter server, information about the switch to which T-Server is connected.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestQuerySwitch create()
          Creates instance of RequestQuerySwitch with no parameters set.
static RequestQuerySwitch create(SwitchInfoType switchInfoType)
          Creates instance of RequestQuerySwitch with required parameters set.
static RequestQuerySwitch create(SwitchInfoType switchInfoType, KeyValueCollection extensions)
          Creates instance of RequestQuerySwitch 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.Integer getReferenceID()
          Reference ID of the related request.
abstract  SwitchInfoType getSwitchInfoType()
          Requests/returns info about switch.
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 setSwitchInfoType(SwitchInfoType switchInfoType)
          Requests/returns info about switch.
 
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 RequestQuerySwitch create()
Creates instance of RequestQuerySwitch with no parameters set.

Returns:
instance of RequestQuerySwitch

create

public static RequestQuerySwitch create(SwitchInfoType switchInfoType,
                                        KeyValueCollection extensions)
Creates instance of RequestQuerySwitch with all parameters set.

Parameters:
switchInfoType - Requests/returns info about switch.
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 RequestQuerySwitch

create

public static RequestQuerySwitch create(SwitchInfoType switchInfoType)
Creates instance of RequestQuerySwitch with required parameters set.

Parameters:
switchInfoType - Requests/returns info about switch.
Returns:
instance of RequestQuerySwitch

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.


getSwitchInfoType

public abstract SwitchInfoType getSwitchInfoType()
Requests/returns info about switch.

Returns:
property value

setSwitchInfoType

public abstract void setSwitchInfoType(SwitchInfoType switchInfoType)
Requests/returns info about switch.

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