Platform SDK Java 8.5 API Reference

com.genesyslab.platform.voice.protocol.tserver.requests.voicemail
Class RequestLoginMailBox

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

public abstract class RequestLoginMailBox
extends Message

Logs in the telephony object specified by the parameter dn to the mailbox specified by the parameter mbox_number.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestLoginMailBox create()
          Creates instance of RequestLoginMailBox with no parameters set.
static RequestLoginMailBox create(java.lang.String thisDN)
          Creates instance of RequestLoginMailBox with required parameters set.
static RequestLoginMailBox create(java.lang.String thisDN, java.lang.String userID, java.lang.String password, KeyValueCollection reasons, KeyValueCollection extensions)
          Creates instance of RequestLoginMailBox 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.String getPassword()
          The password to get logged in.
abstract  KeyValueCollection getReasons()
          Additional data intended to specify reasons for and results of actions taken by the user.
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 getUserID()
          The user ID for the involved mailbox.
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 setPassword(java.lang.String password)
          The password to get logged in.
abstract  void setReasons(KeyValueCollection reasons)
          Additional data intended to specify reasons for and results of actions taken by the user.
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 setUserID(java.lang.String userID)
          The user ID for the involved mailbox.
 
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 RequestLoginMailBox create()
Creates instance of RequestLoginMailBox with no parameters set.

Returns:
instance of RequestLoginMailBox

create

public static RequestLoginMailBox create(java.lang.String thisDN,
                                         java.lang.String userID,
                                         java.lang.String password,
                                         KeyValueCollection reasons,
                                         KeyValueCollection extensions)
Creates instance of RequestLoginMailBox with all parameters set.

Parameters:
thisDN - DN of the controlling agent or Route Point.
userID - The directory number of the mailbox number.
password - Password that allows the agent to be logged in.
reasons - Additional data intended to specify reasons for and results of actions taken by the user.
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 RequestLoginMailBox

create

public static RequestLoginMailBox create(java.lang.String thisDN)
Creates instance of RequestLoginMailBox with required parameters set.

Parameters:
thisDN - DN of the controlling agent or Route Point.
Returns:
instance of RequestLoginMailBox

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.


getUserID

public abstract java.lang.String getUserID()
The user ID for the involved mailbox.


setUserID

public abstract void setUserID(java.lang.String userID)
The user ID for the involved mailbox.


getPassword

public abstract java.lang.String getPassword()
The password to get logged in.


setPassword

public abstract void setPassword(java.lang.String password)
The password to get logged in.


getReasons

public abstract KeyValueCollection getReasons()
Additional data intended to specify reasons for and results of actions taken by the user.

Returns:
property value

setReasons

public abstract void setReasons(KeyValueCollection reasons)
Additional data intended to specify reasons for and results of actions taken by the user.

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