Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgTreatment

java.lang.Object
  extended by com.genesyslab.platform.applicationblocks.com.CfgBase
      extended by com.genesyslab.platform.applicationblocks.com.CfgObject
          extended by com.genesyslab.platform.applicationblocks.com.objects.CfgTreatment
All Implemented Interfaces:
ICfgBase, ICfgObject, java.lang.Cloneable

public class CfgTreatment
extends CfgObject

Treatments, which are most often used in automated outbound campaigns, tell Outbound Contact Server (OCS) how to respond to an unsuccessful call result (a call that does not reach the intended party). For example, the response to an unsuccessful connection may be to redial, and the response to a successful connection may be to play a message.

A Treatment Sequence is a group of treatment objects that all contain the same Call Result value. Treatments in a sequence are applied to a call in their numerical order (see the Treatment property Number in Sequence).

One Treatment can be associated with several CallingLists (see CfgCallingList ).

Deletion of Treatment X will cause the following events set out in the order of arrival:



See also:

CfgDeltaTreatment

CfgCallingList


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgTreatment(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgTreatment(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgTreatment(IConfService confService, org.w3c.dom.Node xmlData, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
 
Method Summary
 java.lang.Integer getAttempts()
          An attempt number to which the action should be performed.
 CfgCallActionCode getCallActionCode()
          A call action code.
 GctiCallState getCallResult()
          A call result related to this treatment.
 java.lang.Integer getCycleAttempt()
          An maximum number of sequential attempts the treatment can be applied to dn.
 java.util.Calendar getDateTime()
          A time and date when another attempt must be applied again to dn.
 java.lang.Integer getDBID()
          An identifier of this object in the Configuration Database.
 java.lang.String getDescription()
          A pointer to treatment action description.
 CfgDN getDestDN()
           
 java.lang.Integer getDestDNDBID()
          Retrieves the dbid of the object that is being linked to by the DestDN property.
 java.lang.Integer getIncrement()
          The time in interval in minutes which increments the interval after each attempt.
 java.lang.Integer getInterval()
          A time interval in minutes between attempts.
 java.lang.String getName()
          A pointer to treatment action name.
 java.lang.Integer getRange()
          Parameter defining a time range.
 CfgRecActionCode getRecActionCode()
          A record action code.
 CfgObjectState getState()
          Current object state.
 CfgTenant getTenant()
          A unique identifier of the CfgTenant to which this treatment action is allocated.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 KeyValueCollection getUserProperties()
          A pointer to the list of user-defined properties.Parameter userProperties has the following structure: Each key-value pair of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary list, that also has the TKVList structure and specifies the properties defined within that section.
 void save()
          Synchronizes changes in the class with Configuration Server.
 void setAttempts(java.lang.Integer value)
          An attempt number to which the action should be performed.
 void setCallActionCode(CfgCallActionCode value)
          A call action code.
 void setCallResult(GctiCallState value)
          A call result related to this treatment.
 void setCycleAttempt(java.lang.Integer value)
          An maximum number of sequential attempts the treatment can be applied to dn.
 void setDateTime(java.util.Calendar value)
          A time and date when another attempt must be applied again to dn.
 void setDBID(java.lang.Integer value)
          An identifier of this object in the Configuration Database.
 void setDescription(java.lang.String value)
          A pointer to treatment action description.
 void setDestDN(CfgDN value)
           
 void setDestDNDBID(int dbid)
           
 void setIncrement(java.lang.Integer value)
          The time in interval in minutes which increments the interval after each attempt.
 void setInterval(java.lang.Integer value)
          A time interval in minutes between attempts.
 void setName(java.lang.String value)
          A pointer to treatment action name.
 void setRange(java.lang.Integer value)
          Parameter defining a time range.
 void setRecActionCode(CfgRecActionCode value)
          A record action code.
 void setState(CfgObjectState value)
          Current object state.
 void setTenant(CfgTenant value)
          A unique identifier of the CfgTenant to which this treatment action is allocated.
 void setTenantDBID(int dbid)
          A unique identifier of the CfgTenant to which this treatment action is allocated.
 void setUserProperties(KeyValueCollection value)
          A pointer to the list of user-defined properties.Parameter userProperties has the following structure: Each key-value pair of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary list, that also has the TKVList structure and specifies the properties defined within that section.
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgObject
clone, delete, doSetFolderId, ensureDataBackup, getFolderId, getObjectDbid, getObjectPath, getObjectType, refresh, reloadObjectWithNewData, reloadObjectWithNewData, removeAccount, resetDataBackup, retrieveAccountPermissions, retrieveACL, retrievePermissions, setAccountPermissions, setAccountPermissions, setFolderId, update, updateACL
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgBase
equals, flushChildrenContent, getConfigurationService, getData, getEndpoint, getLinkListCollection, getLinkValue, getLogger, getMetaData, getParent, getProperty, getProperty, getProperty, getRawObjectData, hashCode, initStruct, isSaved, lockObject, resolveLink, setProperty, toString, toStringProperties, toXml, updateChildrenSavedState
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.genesyslab.platform.applicationblocks.com.ICfgBase
getEndpoint, getProperty, getRawObjectData, setProperty, toXml
 

Field Detail

OBJECT_TYPE

public static final CfgObjectType OBJECT_TYPE
Constructor Detail

CfgTreatment

public CfgTreatment(IConfService confService,
                    ConfObject objData,
                    boolean isSaved,
                    java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. It is internally used by COM AB for objects deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol object data structure
isSaved - indicator of the object saved state
additionalParameters - additional parameters from configuration protocol message

CfgTreatment

public CfgTreatment(IConfService confService,
                    org.w3c.dom.Node xmlData,
                    java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. It is internally used by COM AB for objects deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing object data
additionalParameters - additional parameters from configuration protocol message

CfgTreatment

public CfgTreatment(IConfService confService)
This constructor is intended for creation of detached objects.

Parameters:
confService - configuration service instance
Method Detail

save

public void save()
          throws ConfigException
Synchronizes changes in the class with Configuration Server.

Specified by:
save in interface ICfgObject
Overrides:
save in class CfgObject
Throws:
ConfigException - in case of protocol level exception, data transformation, or server side constraints

getDBID

public final java.lang.Integer getDBID()
An identifier of this object in the Configuration Database. Generated by Configuration Server and is unique within an object type. Identifiers of deleted objects are not used again. Read-only.

Returns:
property value or null

setDBID

public final void setDBID(java.lang.Integer value)
An identifier of this object in the Configuration Database. Generated by Configuration Server and is unique within an object type. Identifiers of deleted objects are not used again. Read-only.

Parameters:
value - new property value
See Also:
getDBID()

getTenant

public final CfgTenant getTenant()
A unique identifier of the CfgTenant to which this treatment action is allocated. Mandatory.Once specified, cannot be changed.

Returns:
instance of referred object or null

setTenant

public final void setTenant(CfgTenant value)
A unique identifier of the CfgTenant to which this treatment action is allocated. Mandatory.Once specified, cannot be changed.

Parameters:
value - new property value
See Also:
getTenant()

setTenantDBID

public final void setTenantDBID(int dbid)
A unique identifier of the CfgTenant to which this treatment action is allocated. Mandatory.Once specified, cannot be changed.

Parameters:
dbid - DBID identifier of referred object
See Also:
getTenant()

getTenantDBID

public final java.lang.Integer getTenantDBID()
Retrieves the dbid of the object that is being linked to by the Tenant property.

Returns:
DBID identifier of referred object or null

getName

public final java.lang.String getName()
A pointer to treatment action name. Mandatory.

Returns:
property value or null

setName

public final void setName(java.lang.String value)
A pointer to treatment action name. Mandatory.

Parameters:
value - new property value
See Also:
getName()

getDescription

public final java.lang.String getDescription()
A pointer to treatment action description.

Returns:
property value or null

setDescription

public final void setDescription(java.lang.String value)
A pointer to treatment action description.

Parameters:
value - new property value
See Also:
getDescription()

getCallResult

public final GctiCallState getCallResult()
A call result related to this treatment. Refer to GctiCallState in Variable Types of Common APIs. Mandatory.

Returns:
property value or null

setCallResult

public final void setCallResult(GctiCallState value)
A call result related to this treatment. Refer to GctiCallState in Variable Types of Common APIs. Mandatory.

Parameters:
value - new property value
See Also:
getCallResult()

getRecActionCode

public final CfgRecActionCode getRecActionCode()
A record action code. Refer to CfgRecActionCode in User Defined Variable Types.

Returns:
property value or null

setRecActionCode

public final void setRecActionCode(CfgRecActionCode value)
A record action code. Refer to CfgRecActionCode in User Defined Variable Types.

Parameters:
value - new property value
See Also:
getRecActionCode()

getAttempts

public final java.lang.Integer getAttempts()
An attempt number to which the action should be performed.

Returns:
property value or null

setAttempts

public final void setAttempts(java.lang.Integer value)
An attempt number to which the action should be performed.

Parameters:
value - new property value
See Also:
getAttempts()

getDateTime

public final java.util.Calendar getDateTime()
A time and date when another attempt must be applied again to dn. The parameter is used if recActionCode is set to CFGRACRetryAtDate. Refer to time_t from time.h of ANSI C library.

Returns:
property value or null

setDateTime

public final void setDateTime(java.util.Calendar value)
A time and date when another attempt must be applied again to dn. The parameter is used if recActionCode is set to CFGRACRetryAtDate. Refer to time_t from time.h of ANSI C library.

Parameters:
value - new property value
See Also:
getDateTime()

getCycleAttempt

public final java.lang.Integer getCycleAttempt()
An maximum number of sequential attempts the treatment can be applied to dn. The parameter is used if recActionCode is set to CFGRACCycle.

Returns:
property value or null

setCycleAttempt

public final void setCycleAttempt(java.lang.Integer value)
An maximum number of sequential attempts the treatment can be applied to dn. The parameter is used if recActionCode is set to CFGRACCycle.

Parameters:
value - new property value
See Also:
getCycleAttempt()

getInterval

public final java.lang.Integer getInterval()
A time interval in minutes between attempts. The parameter is used if recActionCode is set either to CFGRACCycle or CFGRACRetryIn.

Returns:
property value or null

setInterval

public final void setInterval(java.lang.Integer value)
A time interval in minutes between attempts. The parameter is used if recActionCode is set either to CFGRACCycle or CFGRACRetryIn.

Parameters:
value - new property value
See Also:
getInterval()

getIncrement

public final java.lang.Integer getIncrement()
The time in interval in minutes which increments the interval after each attempt. The parameter is used if recActionCode is set either to CFGRACCycle.

Returns:
property value or null

setIncrement

public final void setIncrement(java.lang.Integer value)
The time in interval in minutes which increments the interval after each attempt. The parameter is used if recActionCode is set either to CFGRACCycle.

Parameters:
value - new property value
See Also:
getIncrement()

getCallActionCode

public final CfgCallActionCode getCallActionCode()
A call action code. Refer to CfgCallActionCode in User Defined Variable Types. The callActionCode can be applied to following call results only. (Refer to GctiCallState in Variable Types of Common APIs):

Returns:
property value or null

setCallActionCode

public final void setCallActionCode(CfgCallActionCode value)
A call action code. Refer to CfgCallActionCode in User Defined Variable Types. The callActionCode can be applied to following call results only. (Refer to GctiCallState in Variable Types of Common APIs):

Parameters:
value - new property value
See Also:
getCallActionCode()

getDestDN

public final CfgDN getDestDN()

setDestDN

public final void setDestDN(CfgDN value)

setDestDNDBID

public final void setDestDNDBID(int dbid)

getDestDNDBID

public final java.lang.Integer getDestDNDBID()
Retrieves the dbid of the object that is being linked to by the DestDN property.

Returns:
DBID identifier of referred object or null

getState

public final CfgObjectState getState()
Current object state. Mandatory. Refer to CfgObjectState

Returns:
property value or null

setState

public final void setState(CfgObjectState value)
Current object state. Mandatory. Refer to CfgObjectState

Parameters:
value - new property value
See Also:
getState()

getUserProperties

public final KeyValueCollection getUserProperties()
A pointer to the list of user-defined properties.Parameter userProperties has the following structure: Each key-value pair of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary list, that also has the TKVList structure and specifies the properties defined within that section.

Returns:
property value or null

setUserProperties

public final void setUserProperties(KeyValueCollection value)
A pointer to the list of user-defined properties.Parameter userProperties has the following structure: Each key-value pair of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary list, that also has the TKVList structure and specifies the properties defined within that section.

Parameters:
value - new property value
See Also:
getUserProperties()

getRange

public final java.lang.Integer getRange()
Parameter defining a time range.

Returns:
property value or null

setRange

public final void setRange(java.lang.Integer value)
Parameter defining a time range.

Parameters:
value - new property value
See Also:
getRange()

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.