|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.voice.protocol.tserver.requests.party.RequestApplyTreatment
public abstract class RequestApplyTreatment
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static RequestApplyTreatment create()
public static RequestApplyTreatment create(java.lang.String thisDN, ConnectionId connID, TreatmentType treatmentType, KeyValueCollection treatmentParameters, KeyValueCollection extensions, KeyValueCollection reasons)
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.
public static RequestApplyTreatment create(java.lang.String thisDN, ConnectionId connID, TreatmentType treatmentType)
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.
public abstract java.lang.Integer getReferenceID()
public abstract void setReferenceID(java.lang.Integer referenceID)
public abstract void setReferenceID(int referenceID)
public abstract java.lang.String getThisDN()
public abstract void setThisDN(java.lang.String thisDN)
public abstract ConnectionId getConnID()
public abstract void setConnID(ConnectionId connID)
public abstract TreatmentType getTreatmentType()
public abstract void setTreatmentType(TreatmentType treatmentType)
treatmentType
- new value of the propertypublic abstract KeyValueCollection getTreatmentParameters()
public abstract void setTreatmentParameters(KeyValueCollection treatmentParameters)
treatmentParameters
- new value of the propertypublic abstract KeyValueCollection getExtensions()
public abstract void setExtensions(KeyValueCollection extensions)
extensions
- new value of the propertypublic abstract KeyValueCollection getReasons()
public abstract void setReasons(KeyValueCollection reasons)
reasons
- new value of the property
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |