Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgCampaignGroup

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

public class CfgCampaignGroup
extends CfgObject

CfgCampaignGroup objects contain information about Campaign groups.

See also:

CfgDeltaCampaignGroup

CfgCampaign

CfgAgentGroup

CfgPlaceGroup


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgCampaignGroup(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgCampaignGroup(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgCampaignGroup(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
 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.
 java.lang.Integer getDBID()
          An identifier of this object in the Configuration Database.
 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()
          Retrieves dbids of objects that are being linked to by the Servers property.
 java.util.Collection<CfgApplication> getServers()
          

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

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

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

 void setCampaignDBID(int dbid)
          

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

 void setDBID(java.lang.Integer value)
          An identifier of this object in the Configuration Database.
 void setDescription(java.lang.String value)
          A pointer to campaign group description.
 void setDialMode(CfgDialMode value)
          

A dial mode dedicated for this group.

 void setGroupDBID(java.lang.Integer value)
          

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

 void setGroupType(CfgObjectType value)
          

A group type.

 void setInteractionQueue(CfgScript value)
          A unique identifier of the Script of type CFGInteractionQueue for this campaign group.
 void setInteractionQueueDBID(int dbid)
          A unique identifier of the Script of type CFGInteractionQueue for this campaign group.
 void setIVRProfile(CfgGVPIVRProfile value)
          

A unique identifier of the object Optional.

 void setIVRProfileDBID(int dbid)
          

A unique identifier of the object Optional.

 void setMaxQueueSize(java.lang.Integer value)
          Maximal number of unprocessed Interactions submitted to Interaction Server or GVP OBN Manager.
 void setMinRecBuffSize(java.lang.Integer value)
          A record buffering parameter.
 void setName(java.lang.String value)
          A pointer to the campaign group name.
 void setNumOfChannels(java.lang.Integer value)
          Maximum number of outbound channels that can be used by this group at one time.
 void setOperationMode(CfgOperationMode value)
          

An operation mode.

 void setOptMethod(CfgOptimizationMethod value)
          An optimization method.
 void setOptMethodValue(java.lang.Integer value)
          The value of optimization method specified by optMethod property.
 void setOptRecBuffSize(java.lang.Integer value)
          A record buffering parameter.
 void setOrigDN(CfgDN value)
          

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

 void setOrigDNDBID(int dbid)
          

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

 void setScript(CfgScript value)
          A unique identifier of the Script for group/campaign.
 void setScriptDBID(int dbid)
          A unique identifier of the Script for group/campaign.
 void setServerDBIDs(java.util.Collection<java.lang.Integer> value)
          Sets dbids collection of objects that are being linked to by the Servers property.
 void setServers(java.util.Collection<CfgApplication> value)
          

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

 void setState(CfgObjectState value)
          Current object state.
 void setTenant(CfgTenant value)
          

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

 void setTenantDBID(int dbid)
          

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

 void setTrunkGroupDN(CfgDN value)
           
 void setTrunkGroupDNDBID(int dbid)
           
 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

CfgCampaignGroup

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

CfgCampaignGroup

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

CfgCampaignGroup

public CfgCampaignGroup(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()

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

setCampaign

public final void setCampaign(CfgCampaign value)

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

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

setCampaignDBID

public final void setCampaignDBID(int dbid)

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

Parameters:
dbid - DBID identifier of referred object
See Also:
getCampaign()

getCampaignDBID

public final java.lang.Integer getCampaignDBID()
Retrieves the dbid of the object that is being linked to by the Campaign property.

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

setTenant

public final void setTenant(CfgTenant value)

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

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 group is allocated. Read-only. Its value is populated from the associated Campaign object

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

Returns:
property value or null

setName

public final void setName(java.lang.String value)
A pointer to the campaign group name. Mandatory. Must be unique within the Campaign.

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

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

setGroupDBID

public final void setGroupDBID(java.lang.Integer value)

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

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

getGroupType

public final CfgObjectType getGroupType()

A group type. Read only. See CfgObjectType

Returns:
property value or null

setGroupType

public final void setGroupType(CfgObjectType value)

A group type. Read only. See CfgObjectType

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

getDescription

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

Returns:
property value or null

setDescription

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

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

getServers

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

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

setServers

public final void setServers(java.util.Collection<CfgApplication> value)

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.

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

getServerDBIDs

public final java.util.Collection<java.lang.Integer> getServerDBIDs()
Retrieves dbids of objects that are being linked to by the Servers property. It's a snapshot collection containing original values. Modification of this collection instance will not affect actual value of the objects' property.

Returns:
collection of DBID identifiers of referred objects or null

setServerDBIDs

public final void setServerDBIDs(java.util.Collection<java.lang.Integer> value)
Sets dbids collection of objects that are being linked to by the Servers property.

Parameters:
value - collection of DBID identifiers of referred objects

getIVRProfile

public final CfgGVPIVRProfile getIVRProfile()

A unique identifier of the object Optional.

Returns:
instance of referred object or null

setIVRProfile

public final void setIVRProfile(CfgGVPIVRProfile value)

A unique identifier of the object Optional.

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

setIVRProfileDBID

public final void setIVRProfileDBID(int dbid)

A unique identifier of the object Optional.

Parameters:
dbid - DBID identifier of referred object
See Also:
getIVRProfile()

getIVRProfileDBID

public final java.lang.Integer getIVRProfileDBID()
Retrieves the dbid of the object that is being linked to by the IVRProfile property.

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

setDialMode

public final void setDialMode(CfgDialMode value)

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

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

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

setOrigDN

public final void setOrigDN(CfgDN value)

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.

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

setOrigDNDBID

public final void setOrigDNDBID(int dbid)

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.

Parameters:
dbid - DBID identifier of referred object
See Also:
getOrigDN()

getOrigDNDBID

public final java.lang.Integer getOrigDNDBID()
Retrieves the dbid of the object that is being linked to by the OrigDN property.

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

setNumOfChannels

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

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

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

setOperationMode

public final void setOperationMode(CfgOperationMode value)

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

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

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

setMinRecBuffSize

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

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

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

setOptRecBuffSize

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

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

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

setMaxQueueSize

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

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

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

setOptMethod

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

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

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

setOptMethodValue

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

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

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

setInteractionQueue

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

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

setInteractionQueueDBID

public final void setInteractionQueueDBID(int dbid)
A unique identifier of the Script of type CFGInteractionQueue for this campaign group. Optional.

Parameters:
dbid - DBID identifier of referred object
See Also:
getInteractionQueue()

getInteractionQueueDBID

public final java.lang.Integer getInteractionQueueDBID()
Retrieves the dbid of the object that is being linked to by the InteractionQueue property.

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

setScript

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

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

setScriptDBID

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

getTrunkGroupDN

public final CfgDN getTrunkGroupDN()

setTrunkGroupDN

public final void setTrunkGroupDN(CfgDN value)

setTrunkGroupDNDBID

public final void setTrunkGroupDNDBID(int dbid)

getTrunkGroupDNDBID

public final java.lang.Integer getTrunkGroupDNDBID()
Retrieves the dbid of the object that is being linked to by the TrunkGroupDN property.

Returns:
DBID identifier of referred object 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.