|
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.CfgCampaign
public class CfgCampaign
Campaigns are structures for organizing and managing an automated process of making outbound calls to the destinations specified in Calling Lists.
Field Summary | |
---|---|
static CfgObjectType |
OBJECT_TYPE
|
Constructor Summary | |
---|---|
CfgCampaign(IConfService confService)
This constructor is intended for creation of detached objects. |
|
CfgCampaign(IConfService confService,
ConfObject objData,
boolean isSaved,
java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. |
|
CfgCampaign(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.util.Collection<CfgCallingListInfo> |
getCallingLists()
A pointer to list of calling lists info dedicated to campaign(every item of this list is structured as
CfgCallingListInfo
). |
java.util.Collection<CfgCampaignGroupInfo> |
getCampaignGroups()
Not in use starting from 7.5 release. |
java.lang.Integer |
getDBID()
An identifier of this object in the Configuration Database. |
java.lang.String |
getDescription()
A pointer to the campaign description. |
java.lang.String |
getName()
A pointer to the campaign name. |
CfgScript |
getScript()
A unique identifier of the campaign
CfgScript
. |
java.lang.Integer |
getScriptDBID()
Retrieves the dbid of the object that is being linked to by the Script property. |
CfgObjectState |
getState()
Current object state. |
CfgTenant |
getTenant()
A unique identifier of the
CfgTenant
to which this campaign is allocated. |
java.lang.Integer |
getTenantDBID()
Retrieves the dbid of the object that is being linked to by the Tenant property. |
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 |
setCallingLists(java.util.Collection<CfgCallingListInfo> value)
A pointer to list of calling lists info dedicated to campaign(every item of this list is structured as
CfgCallingListInfo
). |
void |
setCampaignGroups(java.util.Collection<CfgCampaignGroupInfo> value)
Not in use starting from 7.5 release. |
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 campaign description. |
void |
setName(java.lang.String value)
A pointer to the campaign name. |
void |
setScript(CfgScript value)
A unique identifier of the campaign
CfgScript
. |
void |
setScriptDBID(int dbid)
A unique identifier of the campaign
CfgScript
. |
void |
setState(CfgObjectState value)
Current object state. |
void |
setTenant(CfgTenant value)
A unique identifier of the
CfgTenant
to which this campaign is allocated. |
void |
setTenantDBID(int dbid)
A unique identifier of the
CfgTenant
to which this campaign is allocated. |
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 CfgCampaign(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 CfgCampaign(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 CfgCampaign(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 campaign is allocated. Mandatory. Once specified,
cannot be changed.
public final void setTenant(CfgTenant value)
CfgTenant
to which this campaign is allocated. Mandatory. Once specified,
cannot be changed.
value
- new property valuegetTenant()
public final void setTenantDBID(int dbid)
CfgTenant
to which this campaign 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 java.util.Collection<CfgCallingListInfo> getCallingLists()
CfgCallingListInfo
).
public final void setCallingLists(java.util.Collection<CfgCallingListInfo> value)
CfgCallingListInfo
).
value
- new property valuegetCallingLists()
public final java.util.Collection<CfgCampaignGroupInfo> getCampaignGroups()
CfgCampaignGroup
objects under the Campaigns
public final void setCampaignGroups(java.util.Collection<CfgCampaignGroupInfo> value)
CfgCampaignGroup
objects under the Campaigns
value
- new property valuegetCampaignGroups()
public final CfgScript getScript()
CfgScript
. Optional.
public final void setScript(CfgScript value)
CfgScript
. Optional.
value
- new property valuegetScript()
public final void setScriptDBID(int dbid)
CfgScript
. 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 |