Platform SDK Java 8.5 API Reference

com.genesyslab.platform.voice.protocol.tserver.requests.special
Class RequestNetworkPrivateService

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

public abstract class RequestNetworkPrivateService
extends Message

The Network Private Service.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestNetworkPrivateService create()
          Creates instance of RequestNetworkPrivateService with no parameters set.
static RequestNetworkPrivateService create(java.lang.Integer privateMsgID, java.lang.String thisDN, ConnectionId connID)
          Creates instance of RequestNetworkPrivateService with required parameters set.
static RequestNetworkPrivateService create(java.lang.Integer privateMsgID, java.lang.String thisDN, ConnectionId connID, java.lang.String homeLocation, KeyValueCollection reasons, KeyValueCollection extensions)
          Creates instance of RequestNetworkPrivateService with all parameters set.
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.String getHomeLocation()
          A pointer to the name of the host where T-Server is running.
abstract  java.lang.Integer getPrivateMsgID()
          Service identifier for the information being passed.
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  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 setHomeLocation(java.lang.String homeLocation)
          A pointer to the name of the host where T-Server is running.
abstract  void setPrivateMsgID(int privateMsgID)
          Service identifier for the information being passed.
abstract  void setPrivateMsgID(java.lang.Integer privateMsgID)
          Service identifier for the information being passed.
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.
 
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 RequestNetworkPrivateService create()
Creates instance of RequestNetworkPrivateService with no parameters set.

Returns:
instance of RequestNetworkPrivateService

create

public static RequestNetworkPrivateService create(java.lang.Integer privateMsgID,
                                                  java.lang.String thisDN,
                                                  ConnectionId connID,
                                                  java.lang.String homeLocation,
                                                  KeyValueCollection reasons,
                                                  KeyValueCollection extensions)
Creates instance of RequestNetworkPrivateService with all parameters set.

Parameters:
privateMsgID - Service identifier for the information being passed.
thisDN - DN of the controlling agent or Route Point.
connID - Connection identifier of the current call handled by the DN.
homeLocation - A pointer to the name of the host where T-Server is running.
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 RequestNetworkPrivateService

create

public static RequestNetworkPrivateService create(java.lang.Integer privateMsgID,
                                                  java.lang.String thisDN,
                                                  ConnectionId connID)
Creates instance of RequestNetworkPrivateService with required parameters set.

Parameters:
privateMsgID - Service identifier for the information being passed.
thisDN - DN of the controlling agent or Route Point.
connID - Connection identifier of the current call handled by the DN.
Returns:
instance of RequestNetworkPrivateService

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.


getPrivateMsgID

public abstract java.lang.Integer getPrivateMsgID()
Service identifier for the information being passed.

Returns:
property value

setPrivateMsgID

public abstract void setPrivateMsgID(java.lang.Integer privateMsgID)
Service identifier for the information being passed.

Parameters:
privateMsgID - new value of the property

setPrivateMsgID

public abstract void setPrivateMsgID(int privateMsgID)
Service identifier for the information being passed.

Parameters:
privateMsgID - new value of the property

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.


getHomeLocation

public abstract java.lang.String getHomeLocation()
A pointer to the name of the host where T-Server is running.

Returns:
property value

setHomeLocation

public abstract void setHomeLocation(java.lang.String homeLocation)
A pointer to the name of the host where T-Server is running.

Parameters:
homeLocation - new value of the property

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.