Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaCampaign

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

public class CfgDeltaCampaign
extends CfgDelta

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


Constructor Summary
CfgDeltaCampaign(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaCampaign(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaCampaign(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<CfgCallingListInfo> getAddedCallingLists()
          A pointer to list of calling lists info dedicated to campaign(every item of this list is structured as CfgCallingListInfo ).
 java.util.Collection<CfgCampaignGroupInfo> getAddedCampaignGroups()
          Not in use starting from 7.5 release.
 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.
 java.util.Collection<CfgCallingListInfo> getChangedCallingLists()
          A pointer to the list of changed calling lists(every item of this list is structured as CfgCallingListInfo ).
 java.util.Collection<CfgCampaignGroupInfo> getChangedCampaignGroups()
          Not in use starting from release 7.5
 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 CfgCampaign configuration object.
 java.util.Collection<java.lang.Integer> getDeletedCallingListDBIDs()
          A pointer to the list of deleted calling list DBID(s).
 java.util.Collection<CfgCallingListInfo> getDeletedCallingLists()
          A pointer to the list of deleted calling list DBID(s).
 java.util.Collection<java.lang.Integer> getDeletedCampaignGroupDBIDs()
          Not in use starting from release 7.5
 java.util.Collection<CfgCampaignGroupInfo> getDeletedCampaignGroups()
          Not in use starting from release 7.5
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 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.
 CfgCampaign retrieveCfgCampaign()
          Read base CfgCampaign 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

CfgDeltaCampaign

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

Parameters:
confService - configuration service instance

CfgDeltaCampaign

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

CfgDeltaCampaign

public CfgDeltaCampaign(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 CfgCampaign configuration object.

Returns:
target object DBID

retrieveCfgCampaign

public final CfgCampaign retrieveCfgCampaign()
                                      throws ConfigException
Read base CfgCampaign 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 campaign 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 campaign name. Mandatory.

Returns:
property value or null

getDescription

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

Returns:
property value or null

getAddedCallingLists

public final java.util.Collection<CfgCallingListInfo> getAddedCallingLists()
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

getAddedCampaignGroups

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

Returns:
list of structures or null

getScript

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

getDeletedCallingLists

public final java.util.Collection<CfgCallingListInfo> getDeletedCallingLists()
A pointer to the list of deleted calling list DBID(s).

Returns:
list of configuration objects or null

getDeletedCallingListDBIDs

public final java.util.Collection<java.lang.Integer> getDeletedCallingListDBIDs()
A pointer to the list of deleted calling list DBID(s).

Returns:
collection of DBID identifiers of referred objects or null

getChangedCallingLists

public final java.util.Collection<CfgCallingListInfo> getChangedCallingLists()
A pointer to the list of changed calling lists(every item of this list is structured as CfgCallingListInfo ).

Returns:
list of structures or null

getDeletedCampaignGroups

public final java.util.Collection<CfgCampaignGroupInfo> getDeletedCampaignGroups()
Not in use starting from release 7.5

Returns:
list of configuration objects or null

getDeletedCampaignGroupDBIDs

public final java.util.Collection<java.lang.Integer> getDeletedCampaignGroupDBIDs()
Not in use starting from release 7.5

Returns:
collection of DBID identifiers of referred objects or null

getChangedCampaignGroups

public final java.util.Collection<CfgCampaignGroupInfo> getChangedCampaignGroups()
Not in use starting from release 7.5

Returns:
list of structures 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.