|
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.CfgCampaignGroup
public class CfgCampaignGroup
CfgCampaignGroup
objects contain information about Campaign
groups.
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 |
---|
public static final CfgObjectType OBJECT_TYPE
Constructor Detail |
---|
public CfgCampaignGroup(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 CfgCampaignGroup(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 CfgCampaignGroup(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 CfgCampaign getCampaign()
CfgCampaign
to which this campaign group is allocated. Mandatory. Once specified,
cannot be changed.
public final void setCampaign(CfgCampaign value)
CfgCampaign
to which this campaign group is allocated. Mandatory. Once specified,
cannot be changed.
value
- new property valuegetCampaign()
public final void setCampaignDBID(int dbid)
CfgCampaign
to which this campaign group is allocated. Mandatory. Once specified,
cannot be changed.
dbid
- DBID identifier of referred objectgetCampaign()
public final java.lang.Integer getCampaignDBID()
public final CfgTenant getTenant()
CfgTenant
to which this campaign group is allocated. Read-only. Its value is populated from the associated Campaign object
public final void setTenant(CfgTenant value)
CfgTenant
to which this campaign group is allocated. Read-only. Its value is populated from the associated Campaign object
value
- new property valuegetTenant()
public final void setTenantDBID(int dbid)
CfgTenant
to which this campaign group is allocated. Read-only. Its value is populated from the associated Campaign object
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.Integer getGroupDBID()
Agents
or group of
Places
. Mandatory.
public final void setGroupDBID(java.lang.Integer value)
Agents
or group of
Places
. Mandatory.
value
- new property valuegetGroupDBID()
public final CfgObjectType getGroupType()
CfgObjectType
public final void setGroupType(CfgObjectType value)
CfgObjectType
value
- new property valuegetGroupType()
public final java.lang.String getDescription()
public final void setDescription(java.lang.String value)
value
- new property valuegetDescription()
public final java.util.Collection<CfgApplication> getServers()
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.
public final void setServers(java.util.Collection<CfgApplication> value)
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.
value
- new property valuegetServers()
public final java.util.Collection<java.lang.Integer> getServerDBIDs()
public final void setServerDBIDs(java.util.Collection<java.lang.Integer> value)
value
- collection of DBID identifiers of referred objectspublic final CfgGVPIVRProfile getIVRProfile()
object
Optional.
public final void setIVRProfile(CfgGVPIVRProfile value)
object
Optional.
value
- new property valuegetIVRProfile()
public final void setIVRProfileDBID(int dbid)
object
Optional.
dbid
- DBID identifier of referred objectgetIVRProfile()
public final java.lang.Integer getIVRProfileDBID()
public final CfgDialMode getDialMode()
CFGDMPredict.
See type
CfgDialMode
.
Mandatory.
public final void setDialMode(CfgDialMode value)
CFGDMPredict.
See type
CfgDialMode
.
Mandatory.
value
- new property valuegetDialMode()
public final CfgDN getOrigDN()
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.
public final void setOrigDN(CfgDN value)
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.
value
- new property valuegetOrigDN()
public final void setOrigDNDBID(int dbid)
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.
dbid
- DBID identifier of referred objectgetOrigDN()
public final java.lang.Integer getOrigDNDBID()
public final java.lang.Integer getNumOfChannels()
public final void setNumOfChannels(java.lang.Integer value)
value
- new property valuegetNumOfChannels()
public final CfgOperationMode getOperationMode()
CFGOMManual
.
Refer to
CfgOperationMode
of User Defined Variable Types. Mandatory.
public final void setOperationMode(CfgOperationMode value)
CFGOMManual
.
Refer to
CfgOperationMode
of User Defined Variable Types. Mandatory.
value
- new property valuegetOperationMode()
public final java.lang.Integer getMinRecBuffSize()
4.
Cannot be set to 0.
Mandatory.
public final void setMinRecBuffSize(java.lang.Integer value)
4.
Cannot be set to 0.
Mandatory.
value
- new property valuegetMinRecBuffSize()
public final java.lang.Integer getOptRecBuffSize()
minRecBuffSize
.
public final void setOptRecBuffSize(java.lang.Integer value)
minRecBuffSize
.
value
- new property valuegetOptRecBuffSize()
public final java.lang.Integer getMaxQueueSize()
public final void setMaxQueueSize(java.lang.Integer value)
value
- new property valuegetMaxQueueSize()
public final CfgOptimizationMethod getOptMethod()
CFGOMBusyFactor
. Refer to
CfgOptimizationMethod
of User Defined Variable Types. Mandatory.
public final void setOptMethod(CfgOptimizationMethod value)
CFGOMBusyFactor
. Refer to
CfgOptimizationMethod
of User Defined Variable Types. Mandatory.
value
- new property valuegetOptMethod()
public final java.lang.Integer getOptMethodValue()
CFGOptimizationMethod
of User Defined Variable
Types for ranges and default values.
public final void setOptMethodValue(java.lang.Integer value)
CFGOptimizationMethod
of User Defined Variable
Types for ranges and default values.
value
- new property valuegetOptMethodValue()
public final CfgScript getInteractionQueue()
Script
of type CFGInteractionQueue
for this campaign group. Optional.
public final void setInteractionQueue(CfgScript value)
Script
of type CFGInteractionQueue
for this campaign group. Optional.
value
- new property valuegetInteractionQueue()
public final void setInteractionQueueDBID(int dbid)
Script
of type CFGInteractionQueue
for this campaign group. Optional.
dbid
- DBID identifier of referred objectgetInteractionQueue()
public final java.lang.Integer getInteractionQueueDBID()
public final CfgScript getScript()
Script
for group/campaign. Optional.
public final void setScript(CfgScript value)
Script
for group/campaign. Optional.
value
- new property valuegetScript()
public final void setScriptDBID(int dbid)
Script
for group/campaign. 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()
public final CfgDN getTrunkGroupDN()
public final void setTrunkGroupDN(CfgDN value)
public final void setTrunkGroupDNDBID(int dbid)
public final java.lang.Integer getTrunkGroupDNDBID()
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |