Platform SDK Java 8.5 API Reference

com.genesyslab.platform.voice.protocol.tserver.requests.party
Class RequestApplyTreatment

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

public abstract class RequestApplyTreatment
extends Message

On behalf of the telephony object specified by the parameter dn, applies a treatment specified by treatment to a call specified by conn_id.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestApplyTreatment create()
          Creates instance of RequestApplyTreatment with no parameters set.
static RequestApplyTreatment create(java.lang.String thisDN, ConnectionId connID, TreatmentType treatmentType)
          Creates instance of RequestApplyTreatment with required parameters set.
static RequestApplyTreatment create(java.lang.String thisDN, ConnectionId connID, TreatmentType treatmentType, KeyValueCollection treatmentParameters, KeyValueCollection extensions, KeyValueCollection reasons)
          Creates instance of RequestApplyTreatment 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  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 getTreatmentParameters()
          The additional parameters associated with the treatment type.
abstract  TreatmentType getTreatmentType()
          The type of the treatment applied to the telephony object in question.
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 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 setTreatmentParameters(KeyValueCollection treatmentParameters)
          The additional parameters associated with the treatment type.
abstract  void setTreatmentType(TreatmentType treatmentType)
          The type of the treatment applied to the telephony object in question.
 
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 RequestApplyTreatment create()
Creates instance of RequestApplyTreatment with no parameters set.

Returns:
instance of RequestApplyTreatment

create

public static RequestApplyTreatment create(java.lang.String thisDN,
                                           ConnectionId connID,
                                           TreatmentType treatmentType,
                                           KeyValueCollection treatmentParameters,
                                           KeyValueCollection extensions,
                                           KeyValueCollection reasons)
Creates instance of RequestApplyTreatment with all parameters set.

Parameters:
thisDN - DN of the controlling agent or Route Point.
connID - Connection identifier of the current call handled by the DN.
treatmentType - The type of the treatment applied to the telephony object in question.
treatmentParameters - The additional parameters associated with the treatment type.
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.
reasons - Additional data intended to specify reasons for and results of actions taken by the user.
Returns:
instance of RequestApplyTreatment

create

public static RequestApplyTreatment create(java.lang.String thisDN,
                                           ConnectionId connID,
                                           TreatmentType treatmentType)
Creates instance of RequestApplyTreatment with required parameters set.

Parameters:
thisDN - DN of the controlling agent or Route Point.
connID - Connection identifier of the current call handled by the DN.
treatmentType - The type of the treatment applied to the telephony object in question.
Returns:
instance of RequestApplyTreatment

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.


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.


getTreatmentType

public abstract TreatmentType getTreatmentType()
The type of the treatment applied to the telephony object in question.

Returns:
property value

setTreatmentType

public abstract void setTreatmentType(TreatmentType treatmentType)
The type of the treatment applied to the telephony object in question.

Parameters:
treatmentType - new value of the property

getTreatmentParameters

public abstract KeyValueCollection getTreatmentParameters()
The additional parameters associated with the treatment type.

Returns:
property value

setTreatmentParameters

public abstract void setTreatmentParameters(KeyValueCollection treatmentParameters)
The additional parameters associated with the treatment type.

Parameters:
treatmentParameters - 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

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

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.