Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestPrivateService
extends Message

Passes information and request services (such as Split Call, Set Feature, change T-Server behavior, and so on) that are supported only by certain T-Servers, and which are not covered by general feature requests.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestPrivateService create()
          Creates instance of RequestPrivateService with no parameters set.
static RequestPrivateService create(java.lang.Integer privateMsgID, java.lang.String thisDN)
          Creates instance of RequestPrivateService with required parameters set.
static RequestPrivateService create(java.lang.Integer privateMsgID, java.lang.String thisDN, ConnectionId connID, KeyValueCollection userData, KeyValueCollection reasons, KeyValueCollection extensions)
          Creates instance of RequestPrivateService 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.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  KeyValueCollection getUserData()
          Call-related user data.
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 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.
abstract  void setUserData(KeyValueCollection userData)
          Call-related user data.
 
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 RequestPrivateService create()
Creates instance of RequestPrivateService with no parameters set.

Returns:
instance of RequestPrivateService

create

public static RequestPrivateService create(java.lang.Integer privateMsgID,
                                           java.lang.String thisDN,
                                           ConnectionId connID,
                                           KeyValueCollection userData,
                                           KeyValueCollection reasons,
                                           KeyValueCollection extensions)
Creates instance of RequestPrivateService 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.
userData - Call-related user data.
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 RequestPrivateService

create

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

Parameters:
privateMsgID - Service identifier for the information being passed.
thisDN - DN of the controlling agent or Route Point.
Returns:
instance of RequestPrivateService

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.


getUserData

public abstract KeyValueCollection getUserData()
Call-related user data.

Returns:
property value

setUserData

public abstract void setUserData(KeyValueCollection userData)
Call-related user data.

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