Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgCampaign

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

public class CfgCampaign
extends CfgObject

Campaigns are structures for organizing and managing an automated process of making outbound calls to the destinations specified in Calling Lists.

See also:

CfgDeltaCampaign

CfgCampaignGroup

CfgCallingList


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

OBJECT_TYPE

public static final CfgObjectType OBJECT_TYPE
Constructor Detail

CfgCampaign

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

CfgCampaign

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

CfgCampaign

public CfgCampaign(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 campaign 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 campaign 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 campaign 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 campaign name. Mandatory.

Returns:
property value or null

setName

public final void setName(java.lang.String value)
A pointer to the campaign name. Mandatory.

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

getDescription

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

Returns:
property value or null

setDescription

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

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

getCallingLists

public final 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 ).

Returns:
list of structures or null

setCallingLists

public final 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 ).

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

getCampaignGroups

public final java.util.Collection<CfgCampaignGroupInfo> getCampaignGroups()
Not in use starting from 7.5 release. Campaign Groups are represented as CfgCampaignGroup objects under the Campaigns

Returns:
list of structures or null

setCampaignGroups

public final void setCampaignGroups(java.util.Collection<CfgCampaignGroupInfo> value)
Not in use starting from 7.5 release. Campaign Groups are represented as CfgCampaignGroup objects under the Campaigns

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

getScript

public final CfgScript getScript()
A unique identifier of the campaign CfgScript . Optional.

Returns:
instance of referred object or null

setScript

public final void setScript(CfgScript value)
A unique identifier of the campaign CfgScript . Optional.

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

setScriptDBID

public final void setScriptDBID(int dbid)
A unique identifier of the campaign CfgScript . 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.