|
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.objects.CfgCallingList
public class CfgCallingList
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:
callingLists
of all campaigns
that included Calling List X
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 |
---|
public static final CfgObjectType OBJECT_TYPE
Constructor Detail |
---|
public CfgCallingList(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
confService
- configuration service instanceobjData
- configuration protocol object data structureisSaved
- indicator of the object saved stateadditionalParameters
- additional parameters from configuration protocol messagepublic CfgCallingList(IConfService confService, org.w3c.dom.Node xmlData, java.lang.Object[] additionalParameters)
confService
- configuration service instancexmlData
- XML object containing object dataadditionalParameters
- additional parameters from configuration protocol messagepublic CfgCallingList(IConfService confService)
confService
- configuration service instanceMethod Detail |
---|
public void save() throws ConfigException
save
in interface ICfgObject
save
in class CfgObject
ConfigException
- in case of protocol level exception, data transformation,
or server side constraintspublic final java.lang.Integer getDBID()
public final void setDBID(java.lang.Integer value)
value
- new property valuegetDBID()
public final CfgTenant getTenant()
CfgTenant
to which this calling list is allocated. Mandatory. Once specified,
cannot be changed.
public final void setTenant(CfgTenant value)
CfgTenant
to which this calling list is allocated. Mandatory. Once specified,
cannot be changed.
value
- new property valuegetTenant()
public final void setTenantDBID(int dbid)
CfgTenant
to which this calling list is allocated. Mandatory. Once specified,
cannot be changed.
dbid
- DBID identifier of referred objectgetTenant()
public final java.lang.Integer getTenantDBID()
public final java.lang.String getName()
public final void setName(java.lang.String value)
value
- new property valuegetName()
public final java.lang.String getDescription()
public final void setDescription(java.lang.String value)
value
- new property valuegetDescription()
public final CfgTableAccess getTableAccess()
CfgTableAccess
object of CFGTTCallingList
type can be used only. Mandatory.
public final void setTableAccess(CfgTableAccess value)
CfgTableAccess
object of CFGTTCallingList
type can be used only. Mandatory.
value
- new property valuegetTableAccess()
public final void setTableAccessDBID(int dbid)
CfgTableAccess
object of CFGTTCallingList
type can be used only. Mandatory.
dbid
- DBID identifier of referred objectgetTableAccess()
public final java.lang.Integer getTableAccessDBID()
public final CfgFilter getFilter()
CfgFilter
of this calling list. Optional. If specified, the filter format
must have reference to the format the table access refers to.
public final void setFilter(CfgFilter value)
CfgFilter
of this calling list. Optional. If specified, the filter format
must have reference to the format the table access refers to.
value
- new property valuegetFilter()
public final void setFilterDBID(int dbid)
CfgFilter
of this calling list. Optional. If specified, the filter format
must have reference to the format the table access refers to.
dbid
- DBID identifier of referred objectgetFilter()
public final java.lang.Integer getFilterDBID()
public final java.util.Collection<CfgTreatment> getTreatments()
CfgTreatment
dedicated to the calling
list. Optional.
public final void setTreatments(java.util.Collection<CfgTreatment> value)
CfgTreatment
dedicated to the calling
list. Optional.
value
- new property valuegetTreatments()
public final java.util.Collection<java.lang.Integer> getTreatmentDBIDs()
public final void setTreatmentDBIDs(java.util.Collection<java.lang.Integer> value)
value
- collection of DBID identifiers of referred objectspublic final CfgTableAccess getLogTableAccess()
CfgTableAccess
object of
CFGTTLogTable
type can be used only. Optional.
public final void setLogTableAccess(CfgTableAccess value)
CfgTableAccess
object of
CFGTTLogTable
type can be used only. Optional.
value
- new property valuegetLogTableAccess()
public final void setLogTableAccessDBID(int dbid)
CfgTableAccess
object of
CFGTTLogTable
type can be used only. Optional.
dbid
- DBID identifier of referred objectgetLogTableAccess()
public final java.lang.Integer getLogTableAccessDBID()
public final java.lang.Integer getTimeFrom()
public final void setTimeFrom(java.lang.Integer value)
value
- new property valuegetTimeFrom()
public final java.lang.Integer getTimeUntil()
public final void setTimeUntil(java.lang.Integer value)
value
- new property valuegetTimeUntil()
public final java.lang.Integer getMaxAttempts()
public final void setMaxAttempts(java.lang.Integer value)
value
- new property valuegetMaxAttempts()
public final CfgScript getScript()
CfgScript
for this calling list. Optional.
public final void setScript(CfgScript value)
CfgScript
for this calling list. Optional.
value
- new property valuegetScript()
public final void setScriptDBID(int dbid)
CfgScript
for this calling list. Optional.
dbid
- DBID identifier of referred objectgetScript()
public final java.lang.Integer getScriptDBID()
public final CfgObjectState getState()
CfgObjectState
public final void setState(CfgObjectState value)
CfgObjectState
value
- new property valuegetState()
public final KeyValueCollection getUserProperties()
public final void setUserProperties(KeyValueCollection value)
value
- new property valuegetUserProperties()
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |