Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaCampaignGroup

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

public class CfgDeltaCampaignGroup
extends CfgDelta

CfgDeltaCampaignGroup is applicable for Configuration Library/Server release 7.5 and later.


Constructor Summary
CfgDeltaCampaignGroup(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaCampaignGroup(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaCampaignGroup(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<java.lang.Integer> getAddedServerDBIDs()
          

A pointer to the list of unique identifiers to Application objects.

 java.util.Collection<CfgApplication> getAddedServers()
          

A pointer to the list of unique identifiers to Application objects.

 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.
 CfgCampaign getCampaign()
          

A unique identifier of the CfgCampaign to which this campaign group is allocated.

 java.lang.Integer getCampaignDBID()
          Retrieves the dbid of the object that is being linked to by the Campaign property.
 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 CfgCampaignGroup configuration object.
 java.util.Collection<java.lang.Integer> getDeletedServerDBIDs()
          A pointer to the list of deleted applications.
 java.util.Collection<CfgApplication> getDeletedServers()
          A pointer to the list of deleted applications.
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 java.lang.String getDescription()
          A pointer to campaign group description.
 CfgDialMode getDialMode()
          

A dial mode dedicated for this group.

 java.lang.Integer getGroupDBID()
          

A unique identifier of the group of Agents or group of Places .

 CfgObjectType getGroupType()
          

A group type.

 CfgScript getInteractionQueue()
          A unique identifier of the Script of type CFGInteractionQueue for this campaign group.
 java.lang.Integer getInteractionQueueDBID()
          Retrieves the dbid of the object that is being linked to by the InteractionQueue property.
 CfgGVPIVRProfile getIVRProfile()
          

A unique identifier of the object Optional.

 java.lang.Integer getIVRProfileDBID()
          Retrieves the dbid of the object that is being linked to by the IVRProfile property.
 java.lang.Integer getMaxQueueSize()
          Maximal number of unprocessed Interactions submitted to Interaction Server or GVP OBN Manager.
 java.lang.Integer getMinRecBuffSize()
          A record buffering parameter.
 java.lang.String getName()
          A pointer to the campaign group name.
 java.lang.Integer getNumOfChannels()
          Maximum number of outbound channels that can be used by this group at one time.
 CfgOperationMode getOperationMode()
          

An operation mode.

 CfgOptimizationMethod getOptMethod()
          An optimization method.
 java.lang.Integer getOptMethodValue()
          The value of optimization method specified by optMethod property.
 java.lang.Integer getOptRecBuffSize()
          A record buffering parameter.
 CfgDN getOrigDN()
          

A unique identifier of the DN where the dialing should be performed from.

 java.lang.Integer getOrigDNDBID()
          Retrieves the dbid of the object that is being linked to by the OrigDN property.
 CfgScript getScript()
          A unique identifier of the Script for group/campaign.
 java.lang.Integer getScriptDBID()
          Retrieves the dbid of the object that is being linked to by the Script property.
 java.util.Collection<java.lang.Integer> getServerDBIDs()
          Deprecated.  
 CfgObjectState getState()
          Current object state.
 CfgTenant getTenant()
          

A unique identifier of the CfgTenant to which this campaign group is allocated.

 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 CfgDN getTrunkGroupDN()
           
 java.lang.Integer getTrunkGroupDNDBID()
          Retrieves the dbid of the object that is being linked to by the TrunkGroupDN property.
 CfgCampaignGroup retrieveCfgCampaignGroup()
          Read base CfgCampaignGroup 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

CfgDeltaCampaignGroup

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

Parameters:
confService - configuration service instance

CfgDeltaCampaignGroup

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

CfgDeltaCampaignGroup

public CfgDeltaCampaignGroup(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 CfgCampaignGroup configuration object.

Returns:
target object DBID

retrieveCfgCampaignGroup

public final CfgCampaignGroup retrieveCfgCampaignGroup()
                                                throws ConfigException
Read base CfgCampaignGroup configuration object caused this event.

Returns:
configuration object read
Throws:
ConfigException - in case of problem while object reading

getCampaign

public final CfgCampaign getCampaign()

A unique identifier of the CfgCampaign to which this campaign group is allocated. Mandatory. Once specified, cannot be changed.

Returns:
instance of referred object or null

getCampaignDBID

public final java.lang.Integer getCampaignDBID()
Retrieves the dbid of the object that is being linked to by the Campaign property. Configuration server provides it only if the property value has been changed.

Returns:
DBID identifier of referred object or null

getTenant

public final CfgTenant getTenant()

A unique identifier of the CfgTenant to which this campaign group is allocated. Read-only. Its value is populated from the associated Campaign object

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 group name. Mandatory. Must be unique within the Campaign.

Returns:
property value or null

getGroupDBID

public final java.lang.Integer getGroupDBID()

A unique identifier of the group of Agents or group of Places . Mandatory.

Returns:
property value or null

getGroupType

public final CfgObjectType getGroupType()

A group type. Read only. See CfgObjectType

Returns:
property value or null

getDescription

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

Returns:
property value or null

getAddedServers

public final java.util.Collection<CfgApplication> getAddedServers()

A pointer to the list of unique identifiers to Application objects. Optional. Will be used to configure connectivity to Servers associated with this Campaign. Only one Application of specific application type (CfgAppType) is allowed in the list.

Returns:
list of configuration objects or null

getAddedServerDBIDs

public final java.util.Collection<java.lang.Integer> getAddedServerDBIDs()

A pointer to the list of unique identifiers to Application objects. Optional. Will be used to configure connectivity to Servers associated with this Campaign. Only one Application of specific application type (CfgAppType) is allowed in the list.

Returns:
collection of DBID identifiers of referred objects or null

getServerDBIDs

@Deprecated
public final java.util.Collection<java.lang.Integer> getServerDBIDs()
Deprecated. 

See Also:
getAddedServerDBIDs()

getIVRProfile

public final CfgGVPIVRProfile getIVRProfile()

A unique identifier of the object Optional.

Returns:
instance of referred object or null

getIVRProfileDBID

public final java.lang.Integer getIVRProfileDBID()
Retrieves the dbid of the object that is being linked to by the IVRProfile property. Configuration server provides it only if the property value has been changed.

Returns:
DBID identifier of referred object or null

getDialMode

public final CfgDialMode getDialMode()

A dial mode dedicated for this group. Default value is CFGDMPredict. See type CfgDialMode . Mandatory.

Returns:
property value or null

getOrigDN

public final CfgDN getOrigDN()

A unique identifier of the DN where the dialing should be performed from. DNs of following types can be used to specify this parameter: CFGACDQueue and CFGRoutingPoint. Refer to CfgDNType of User Defined Variable Types. Optional.

Returns:
instance of referred object or null

getOrigDNDBID

public final java.lang.Integer getOrigDNDBID()
Retrieves the dbid of the object that is being linked to by the OrigDN property. Configuration server provides it only if the property value has been changed.

Returns:
DBID identifier of referred object or null

getNumOfChannels

public final java.lang.Integer getNumOfChannels()
Maximum number of outbound channels that can be used by this group at one time. Default value is 10. Mandatory.

Returns:
property value or null

getOperationMode

public final CfgOperationMode getOperationMode()

An operation mode. Default value is CFGOMManual . Refer to CfgOperationMode of User Defined Variable Types. Mandatory.

Returns:
property value or null

getMinRecBuffSize

public final java.lang.Integer getMinRecBuffSize()
A record buffering parameter. Default value is 4. Cannot be set to 0. Mandatory.

Returns:
property value or null

getOptRecBuffSize

public final java.lang.Integer getOptRecBuffSize()
A record buffering parameter. Default value is 6. Mandatory. The value of this property must always be greater than minRecBuffSize.

Returns:
property value or null

getMaxQueueSize

public final java.lang.Integer getMaxQueueSize()
Maximal number of unprocessed Interactions submitted to Interaction Server or GVP OBN Manager. Optional.

Returns:
property value or null

getOptMethod

public final CfgOptimizationMethod getOptMethod()
An optimization method. Default value is CFGOMBusyFactor. Refer to CfgOptimizationMethod of User Defined Variable Types. Mandatory.

Returns:
property value or null

getOptMethodValue

public final java.lang.Integer getOptMethodValue()
The value of optimization method specified by optMethod property. Refer to CFGOptimizationMethod of User Defined Variable Types for ranges and default values.

Returns:
property value or null

getInteractionQueue

public final CfgScript getInteractionQueue()
A unique identifier of the Script of type CFGInteractionQueue for this campaign group. Optional.

Returns:
instance of referred object or null

getInteractionQueueDBID

public final java.lang.Integer getInteractionQueueDBID()
Retrieves the dbid of the object that is being linked to by the InteractionQueue property. Configuration server provides it only if the property value has been changed.

Returns:
DBID identifier of referred object or null

getScript

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

getTrunkGroupDN

public final CfgDN getTrunkGroupDN()

getTrunkGroupDNDBID

public final java.lang.Integer getTrunkGroupDNDBID()
Retrieves the dbid of the object that is being linked to by the TrunkGroupDN property. Configuration server provides it only if the property value has been changed.

Returns:
DBID identifier of referred object or null

getDeletedServers

public final java.util.Collection<CfgApplication> getDeletedServers()
A pointer to the list of deleted applications.

Returns:
list of configuration objects or null

getDeletedServerDBIDs

public final java.util.Collection<java.lang.Integer> getDeletedServerDBIDs()
A pointer to the list of deleted applications.

Returns:
collection of DBID identifiers of referred objects 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.