Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgCallingList

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

public class CfgCallingList
extends CfgObject

Calling Lists are references to tables of information about the numbers to call during an outbound campaign. These objects also specify conditions that Outbound Contact applications observe when working with these Calling Lists.

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



See also:

CfgDeltaCallingList

CfgTableAccess

CfgFilter

CfgCampaign


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgCallingList(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgCallingList(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgCallingList(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 getDBID()
          An identifier of this object in the Configuration Database.
 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()
          Retrieves dbids of objects that are being linked to by the Treatments property.
 java.util.Collection<CfgTreatment> getTreatments()
          A pointer to list of identifiers of CfgTreatment dedicated to the calling list.
 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 setDBID(java.lang.Integer value)
          An identifier of this object in the Configuration Database.
 void setDescription(java.lang.String value)
          A pointer to the calling list description.
 void setFilter(CfgFilter value)
          A unique identifier of CfgFilter of this calling list.
 void setFilterDBID(int dbid)
          A unique identifier of CfgFilter of this calling list.
 void setLogTableAccess(CfgTableAccess value)
          A unique identifier of logTableAccess.
 void setLogTableAccessDBID(int dbid)
          A unique identifier of logTableAccess.
 void setMaxAttempts(java.lang.Integer value)
          A maximum number of attempts the single record can be dialed for one campaign (total).
 void setName(java.lang.String value)
          A pointer to the calling list name.
 void setScript(CfgScript value)
          A unique identifier of the CfgScript for this calling list.
 void setScriptDBID(int dbid)
          A unique identifier of the CfgScript for this calling list.
 void setState(CfgObjectState value)
          Current object state.
 void setTableAccess(CfgTableAccess value)
          A unique identifier of the table the calling list refers to.
 void setTableAccessDBID(int dbid)
          A unique identifier of the table the calling list refers to.
 void setTenant(CfgTenant value)
          A unique identifier of the CfgTenant to which this calling list is allocated.
 void setTenantDBID(int dbid)
          A unique identifier of the CfgTenant to which this calling list is allocated.
 void setTimeFrom(java.lang.Integer value)
          An earliest time when dial can be done.
 void setTimeUntil(java.lang.Integer value)
          An latest time when dial can be done.
 void setTreatmentDBIDs(java.util.Collection<java.lang.Integer> value)
          Sets dbids collection of objects that are being linked to by the Treatments property.
 void setTreatments(java.util.Collection<CfgTreatment> value)
          A pointer to list of identifiers of CfgTreatment dedicated to the calling list.
 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

CfgCallingList

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

CfgCallingList

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

CfgCallingList

public CfgCallingList(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 calling list 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 calling list 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 calling list 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 the calling list name. Mandatory. Must be unique within the Configuration Database.

Returns:
property value or null

setName

public final void setName(java.lang.String value)
A pointer to the calling list name. Mandatory. Must be unique within the Configuration Database.

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

getDescription

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

Returns:
property value or null

setDescription

public final void setDescription(java.lang.String value)
A pointer to the calling list description.

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

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

setTableAccess

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

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

setTableAccessDBID

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

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

getTableAccessDBID

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

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

setFilter

public final void setFilter(CfgFilter value)
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.

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

setFilterDBID

public final void setFilterDBID(int dbid)
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.

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

getFilterDBID

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

Returns:
DBID identifier of referred object or null

getTreatments

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

Returns:
list of configuration objects or null

setTreatments

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

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

getTreatmentDBIDs

public final java.util.Collection<java.lang.Integer> getTreatmentDBIDs()
Retrieves dbids of objects that are being linked to by the Treatments property. It's a snapshot collection containing original values. Modification of this collection instance will not affect actual value of the objects' property.

Returns:
collection of DBID identifiers of referred objects or null

setTreatmentDBIDs

public final void setTreatmentDBIDs(java.util.Collection<java.lang.Integer> value)
Sets dbids collection of objects that are being linked to by the Treatments property.

Parameters:
value - collection of DBID identifiers of referred objects

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

setLogTableAccess

public final void setLogTableAccess(CfgTableAccess value)
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.

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

setLogTableAccessDBID

public final void setLogTableAccessDBID(int dbid)
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.

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

getLogTableAccessDBID

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

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

setTimeFrom

public final void setTimeFrom(java.lang.Integer value)
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.

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

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

setTimeUntil

public final void setTimeUntil(java.lang.Integer value)
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.

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

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

setMaxAttempts

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

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

getScript

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

Returns:
instance of referred object or null

setScript

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

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

setScriptDBID

public final void setScriptDBID(int dbid)
A unique identifier of the CfgScript for this calling list. Optional.

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

getScriptDBID

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

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.