Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaCallingList

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.CfgDeltaCallingList
All Implemented Interfaces:
ICfgBase, ICfgDelta, ICfgObject, java.lang.Cloneable

public class CfgDeltaCallingList
extends CfgDelta

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


Constructor Summary
CfgDeltaCallingList(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaCallingList(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaCallingList(IConfService confService, org.w3c.dom.Node xmlData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
 
Method Summary
 java.util.Collection<java.lang.Integer> getAddedTreatmentDBIDs()
          A pointer to list of identifiers of CfgTreatment dedicated to the calling list.
 java.util.Collection<CfgTreatment> getAddedTreatments()
          A pointer to list of identifiers of CfgTreatment dedicated to the calling list.
 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.
 KeyValueCollection getChangedUserProperties()
          A pointer to the list of user-defined properties whose values have been changed.
 java.lang.Integer getDBID()
          The DBID of the target CfgCallingList configuration object.
 java.util.Collection<java.lang.Integer> getDeletedTreatmentDBIDs()
          A pointer to the list of deleted treatments.
 java.util.Collection<CfgTreatment> getDeletedTreatments()
          A pointer to the list of deleted treatments.
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 java.lang.String getDescription()
          A pointer to the calling list description.
 CfgFilter getFilter()
          A unique identifier of CfgFilter of this calling list.
 java.lang.Integer getFilterDBID()
          Retrieves the dbid of the object that is being linked to by the Filter property.
 CfgTableAccess getLogTableAccess()
          A unique identifier of logTableAccess.
 java.lang.Integer getLogTableAccessDBID()
          Retrieves the dbid of the object that is being linked to by the LogTableAccess property.
 java.lang.Integer getMaxAttempts()
          A maximum number of attempts the single record can be dialed for one campaign (total).
 java.lang.String getName()
          A pointer to the calling list name.
 CfgScript getScript()
          A unique identifier of the CfgScript for this calling list.
 java.lang.Integer getScriptDBID()
          Retrieves the dbid of the object that is being linked to by the Script property.
 CfgObjectState getState()
          Current object state.
 CfgTableAccess getTableAccess()
          A unique identifier of the table the calling list refers to.
 java.lang.Integer getTableAccessDBID()
          Retrieves the dbid of the object that is being linked to by the TableAccess property.
 CfgTenant getTenant()
          A unique identifier of the CfgTenant to which this calling list is allocated.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 java.lang.Integer getTimeFrom()
          An earliest time when dial can be done.
 java.lang.Integer getTimeUntil()
          An latest time when dial can be done.
 java.util.Collection<java.lang.Integer> getTreatmentDBIDs()
          Deprecated.  
 CfgCallingList retrieveCfgCallingList()
          Read base CfgCallingList 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

CfgDeltaCallingList

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

Parameters:
confService - configuration service instance

CfgDeltaCallingList

public CfgDeltaCallingList(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

CfgDeltaCallingList

public CfgDeltaCallingList(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 CfgCallingList configuration object.

Returns:
target object DBID

retrieveCfgCallingList

public final CfgCallingList retrieveCfgCallingList()
                                            throws ConfigException
Read base CfgCallingList 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 calling list 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 the calling list name. Mandatory. Must be unique within the Configuration Database.

Returns:
property value or null

getDescription

public final java.lang.String getDescription()
A pointer to the calling list description.

Returns:
property value or null

getTableAccess

public final CfgTableAccess getTableAccess()
A unique identifier of the table the calling list refers to. Reference to CfgTableAccess object of CFGTTCallingList type can be used only. Mandatory.

Returns:
instance of referred object or null

getTableAccessDBID

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

Returns:
DBID identifier of referred object or null

getFilter

public final CfgFilter getFilter()
A unique identifier of CfgFilter of this calling list. Optional. If specified, the filter format must have reference to the format the table access refers to.

Returns:
instance of referred object or null

getFilterDBID

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

Returns:
DBID identifier of referred object or null

getAddedTreatments

public final java.util.Collection<CfgTreatment> getAddedTreatments()
A pointer to list of identifiers of CfgTreatment dedicated to the calling list. Optional.

Returns:
list of configuration objects or null

getAddedTreatmentDBIDs

public final java.util.Collection<java.lang.Integer> getAddedTreatmentDBIDs()
A pointer to list of identifiers of CfgTreatment dedicated to the calling list. Optional.

Returns:
collection of DBID identifiers of referred objects or null

getTreatmentDBIDs

@Deprecated
public final java.util.Collection<java.lang.Integer> getTreatmentDBIDs()
Deprecated. 

See Also:
getAddedTreatmentDBIDs()

getLogTableAccess

public final CfgTableAccess getLogTableAccess()
A unique identifier of logTableAccess. It is recommended to dedicate single logTableAccessDBID to all CallingLists associated with one Campaign. . Reference to CfgTableAccess object of CFGTTLogTable type can be used only. Optional.

Returns:
instance of referred object or null

getLogTableAccessDBID

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

Returns:
DBID identifier of referred object or null

getTimeFrom

public final java.lang.Integer getTimeFrom()
An earliest time when dial can be done. The value is measured in seconds since 00:00:00 of current day. Default value is 08:00:00. Overwrites the settings in database table specified in field CFGFrom. Mandatory.

Returns:
property value or null

getTimeUntil

public final java.lang.Integer getTimeUntil()
An latest time when dial can be done. The value is measured in seconds since 00:00:00 of current day. Default value is 18:00:00. Overwrites the settings in database table specified in field CFGUntil. Mandatory.

Returns:
property value or null

getMaxAttempts

public final java.lang.Integer getMaxAttempts()
A maximum number of attempts the single record can be dialed for one campaign (total). Default value is 10. Mandatory.

Returns:
property value or null

getScript

public final CfgScript getScript()
A unique identifier of the CfgScript for this calling list. Optional.

Returns:
instance of referred object or null

getScriptDBID

public final java.lang.Integer getScriptDBID()
Retrieves the dbid of the object that is being linked to by the Script 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

getDeletedTreatments

public final java.util.Collection<CfgTreatment> getDeletedTreatments()
A pointer to the list of deleted treatments.

Returns:
list of configuration objects or null

getDeletedTreatmentDBIDs

public final java.util.Collection<java.lang.Integer> getDeletedTreatmentDBIDs()
A pointer to the list of deleted treatments.

Returns:
collection of DBID identifiers of referred objects 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.