Platform SDK Java 8.5 API Reference

com.genesyslab.platform.voice.protocol.tserver.requests.dn
Class RequestRegisterAddress

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

public abstract class RequestRegisterAddress
extends Message

Registers for a DN. Your application must register the DN before sending the request RequestAgentLogin.

                        RequestRegisterAddress requestRegisterAddress = RequestRegisterAddress.create(thisDn, 
                                RegisterMode.ModeShare, ControlMode.RegisterDefault, AddressType.DN);
                        

If the request is successful, your application receives the EventRegistered.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestRegisterAddress create()
          Creates instance of RequestRegisterAddress with no parameters set.
static RequestRegisterAddress create(java.lang.String thisDN, RegisterMode registerMode, ControlMode controlMode, AddressType addressType)
          Creates instance of RequestRegisterAddress with required parameters set.
static RequestRegisterAddress create(java.lang.String thisDN, RegisterMode registerMode, ControlMode controlMode, AddressType addressType, KeyValueCollection extensions)
          Creates instance of RequestRegisterAddress with all parameters set.
abstract  AddressType getAddressType()
          Address type specifying the telephony object in question.
abstract  ControlMode getControlMode()
          Control mode specifying whether the fact of registration is to be relayed to the switch.
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  RegisterMode getRegisterMode()
          Registration mode specifying whether information about this telephony object will be available to other applications.
abstract  java.lang.String getThisDN()
          The Directory Number (which your application registered) involved in this request or event.
abstract  void setAddressType(AddressType addressType)
          Address type specifying the telephony object in question.
abstract  void setControlMode(ControlMode controlMode)
          Control mode specifying whether the fact of registration is to be relayed to the 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 setRegisterMode(RegisterMode registerMode)
          Registration mode specifying whether information about this telephony object will be available to other applications.
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 RequestRegisterAddress create()
Creates instance of RequestRegisterAddress with no parameters set.

Returns:
instance of RequestRegisterAddress

create

public static RequestRegisterAddress create(java.lang.String thisDN,
                                            RegisterMode registerMode,
                                            ControlMode controlMode,
                                            AddressType addressType,
                                            KeyValueCollection extensions)
Creates instance of RequestRegisterAddress with all parameters set.

Parameters:
thisDN - DN of the controlling agent or Route Point.
registerMode - Registration mode specifying whether information about this telephony object will be available to other applications.
controlMode - Control mode specifying whether the fact of registration is to be relayed to the switch.
addressType - Address type specifying the telephony object in question.
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 RequestRegisterAddress

create

public static RequestRegisterAddress create(java.lang.String thisDN,
                                            RegisterMode registerMode,
                                            ControlMode controlMode,
                                            AddressType addressType)
Creates instance of RequestRegisterAddress with required parameters set.

Parameters:
thisDN - DN of the controlling agent or Route Point.
registerMode - Registration mode specifying whether information about this telephony object will be available to other applications.
controlMode - Control mode specifying whether the fact of registration is to be relayed to the switch.
addressType - Address type specifying the telephony object in question.
Returns:
instance of RequestRegisterAddress

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.


getRegisterMode

public abstract RegisterMode getRegisterMode()
Registration mode specifying whether information about this telephony object will be available to other applications.

Returns:
property value

setRegisterMode

public abstract void setRegisterMode(RegisterMode registerMode)
Registration mode specifying whether information about this telephony object will be available to other applications.

Parameters:
registerMode - new value of the property

getControlMode

public abstract ControlMode getControlMode()
Control mode specifying whether the fact of registration is to be relayed to the switch.

Returns:
property value

setControlMode

public abstract void setControlMode(ControlMode controlMode)
Control mode specifying whether the fact of registration is to be relayed to the switch.

Parameters:
controlMode - new value of the property

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

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.