Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaTreatment

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.CfgDelta
              extended by com.genesyslab.platform.applicationblocks.com.objects.CfgDeltaTreatment
All Implemented Interfaces:
ICfgBase, ICfgDelta, ICfgObject, java.lang.Cloneable

public class CfgDeltaTreatment
extends CfgDelta

CfgDeltaTreatment is applicable for Configuration Library/Server release 5.1.5xx and later.


Constructor Summary
CfgDeltaTreatment(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaTreatment(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaTreatment(IConfService confService, org.w3c.dom.Node xmlData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
 
Method Summary
 KeyValueCollection getAddedUserProperties()
          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.
 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.
 KeyValueCollection getChangedUserProperties()
          A pointer to the list of user-defined properties whose values have been changed.
 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()
          The DBID of the target CfgTreatment configuration object.
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 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.
 CfgTreatment retrieveCfgTreatment()
          Read base CfgTreatment configuration object caused this event.
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgDelta
ensureDataBackup, retrieveObject, save, toStringProperties, update
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgObject
clone, delete, doSetFolderId, getFolderId, getObjectDbid, getObjectPath, getObjectType, refresh, reloadObjectWithNewData, reloadObjectWithNewData, removeAccount, resetDataBackup, retrieveAccountPermissions, retrieveACL, retrievePermissions, setAccountPermissions, setAccountPermissions, setFolderId, 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, 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
 

Constructor Detail

CfgDeltaTreatment

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

Parameters:
confService - configuration service instance

CfgDeltaTreatment

public CfgDeltaTreatment(IConfService confService,
                         ConfObjectDelta objData)
This constructor is intended for creation of delta objects from configuration protocol messages. It is internally used by COM AB for delta objects deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol object delta data

CfgDeltaTreatment

public CfgDeltaTreatment(IConfService confService,
                         org.w3c.dom.Node xmlData)
This constructor is intended for creation of delta objects from configuration protocol messages. It is internally used by COM AB for delta objects deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing object delta data
Method Detail

getDBID

public final java.lang.Integer getDBID()
The DBID of the target CfgTreatment configuration object.

Returns:
target object DBID

retrieveCfgTreatment

public final CfgTreatment retrieveCfgTreatment()
                                        throws ConfigException
Read base CfgTreatment configuration object caused this event.

Returns:
configuration object read
Throws:
ConfigException - in case of problem while object reading

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

getTenantDBID

public final java.lang.Integer getTenantDBID()
Retrieves the dbid of the object that is being linked to by the Tenant property. Configuration server provides it only if the property value has been changed.

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

getDescription

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

Returns:
property value or null

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

getRecActionCode

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

Returns:
property value or null

getAttempts

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

Returns:
property value or null

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

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

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

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

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

getDestDN

public final CfgDN getDestDN()

getDestDNDBID

public final java.lang.Integer getDestDNDBID()
Retrieves the dbid of the object that is being linked to by the DestDN property. Configuration server provides it only if the property value has been changed.

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

getAddedUserProperties

public final KeyValueCollection getAddedUserProperties()
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

getRange

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

Returns:
property value or null

getDeletedUserProperties

public final KeyValueCollection getDeletedUserProperties()
A pointer to the list of deleted user-defined properties. Has the same structure as parameter userProperties.

Returns:
property value or null

getChangedUserProperties

public final KeyValueCollection getChangedUserProperties()
A pointer to the list of user-defined properties whose values have been changed. Has the same structure as parameter userProperties

Returns:
property value or null

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.