|
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.applicationblocks.com.CfgBase
com.genesyslab.platform.applicationblocks.com.CfgObject
com.genesyslab.platform.applicationblocks.com.CfgDelta
com.genesyslab.platform.applicationblocks.com.objects.CfgDeltaTreatment
public class CfgDeltaTreatment
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 |
---|
public CfgDeltaTreatment(IConfService confService)
confService
- configuration service instancepublic CfgDeltaTreatment(IConfService confService, ConfObjectDelta objData)
confService
- configuration service instanceobjData
- configuration protocol object delta datapublic CfgDeltaTreatment(IConfService confService, org.w3c.dom.Node xmlData)
confService
- configuration service instancexmlData
- XML object containing object delta dataMethod Detail |
---|
public final java.lang.Integer getDBID()
public final CfgTreatment retrieveCfgTreatment() throws ConfigException
ConfigException
- in case of problem while object readingpublic final CfgTenant getTenant()
CfgTenant
to which this treatment action is allocated. Mandatory.Once specified,
cannot be changed.
public final java.lang.Integer getTenantDBID()
public final java.lang.String getName()
public final java.lang.String getDescription()
public final GctiCallState getCallResult()
GctiCallState
in Variable Types of
Common
APIs. Mandatory.
public final CfgRecActionCode getRecActionCode()
CfgRecActionCode
in User Defined Variable Types.
public final java.lang.Integer getAttempts()
public final java.util.Calendar getDateTime()
CFGRACRetryAtDate
. Refer to time_t from time.h
of ANSI C library.
public final java.lang.Integer getCycleAttempt()
CFGRACCycle
.
public final java.lang.Integer getInterval()
recActionCode
is set either to CFGRACCycle
or
CFGRACRetryIn
.
public final java.lang.Integer getIncrement()
recActionCode
is set either to CFGRACCycle
.
public final CfgCallActionCode getCallActionCode()
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):
public final CfgDN getDestDN()
public final java.lang.Integer getDestDNDBID()
public final CfgObjectState getState()
CfgObjectState
public final KeyValueCollection getAddedUserProperties()
public final java.lang.Integer getRange()
public final KeyValueCollection getDeletedUserProperties()
public final KeyValueCollection getChangedUserProperties()
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |