Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestUnregisterAddress
extends Message

Unregisters for a DN.
If the request is successful, your application receives the event EventUnregistered.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestUnregisterAddress create()
          Creates instance of RequestUnregisterAddress with no parameters set.
static RequestUnregisterAddress create(java.lang.String thisDN, ControlMode controlMode)
          Creates instance of RequestUnregisterAddress with required parameters set.
static RequestUnregisterAddress create(java.lang.String thisDN, ControlMode controlMode, KeyValueCollection extensions)
          Creates instance of RequestUnregisterAddress with all parameters set.
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  java.lang.String getThisDN()
          The Directory Number (which your application registered) involved in this request or event.
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 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 RequestUnregisterAddress create()
Creates instance of RequestUnregisterAddress with no parameters set.

Returns:
instance of RequestUnregisterAddress

create

public static RequestUnregisterAddress create(java.lang.String thisDN,
                                              ControlMode controlMode,
                                              KeyValueCollection extensions)
Creates instance of RequestUnregisterAddress with all parameters set.

Parameters:
thisDN - DN of the controlling agent or Route Point.
controlMode - Control mode specifying whether the fact of registration is to be relayed to the 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 RequestUnregisterAddress

create

public static RequestUnregisterAddress create(java.lang.String thisDN,
                                              ControlMode controlMode)
Creates instance of RequestUnregisterAddress with required parameters set.

Parameters:
thisDN - DN of the controlling agent or Route Point.
controlMode - Control mode specifying whether the fact of registration is to be relayed to the switch.
Returns:
instance of RequestUnregisterAddress

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.


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

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.