Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgGroup

java.lang.Object
  extended by com.genesyslab.platform.applicationblocks.com.CfgBase
      extended by com.genesyslab.platform.applicationblocks.com.CfgStructure
          extended by com.genesyslab.platform.applicationblocks.com.objects.CfgGroup
All Implemented Interfaces:
ICfgBase, ICfgStructure

public class CfgGroup
extends CfgStructure

A group.

For special requirements that apply to the entities of CfgGroup when it is used as part of an access group, see the description of parameter groupInfo of type CfgAccessGroup in section Access Control Functions and Data Types.

See also:

CfgDeltaGroup


Constructor Summary
CfgGroup(IConfService confService, ConfStructure objData, ICfgObject parent)
          This constructor is intended for creation of structures from external or imported XML data.
CfgGroup(IConfService confService, ICfgObject parent)
          This constructor is intended for creation of detached objects.
CfgGroup(IConfService confService, org.w3c.dom.Node xmlData, ICfgObject parent)
          This constructor is intended for creation of structures from external or imported XML data.
 
Method Summary
 CfgScript getCapacityRule()
          A unique identifier of the capacity rule ( Script ) associated with this group.
 java.lang.Integer getCapacityRuleDBID()
          Retrieves the dbid of the object that is being linked to by the CapacityRule property.
 CfgStatTable getCapacityTable()
          A unique identifier of the Stat Table of CFGCapacityTable type associated with this group.
 java.lang.Integer getCapacityTableDBID()
          Retrieves the dbid of the object that is being linked to by the CapacityTable property.
 CfgObjectiveTable getContract()
          A unique identifier of Cost Contract ( Objective Table ) with which this Group is associated.
 java.lang.Integer getContractDBID()
          Retrieves the dbid of the object that is being linked to by the Contract property.
 java.lang.Integer getDBID()
          An identifier of this object in the Configuration Database.
 java.util.Collection<java.lang.Integer> getManagerDBIDs()
          Retrieves dbids of objects that are being linked to by the Managers property.
 java.util.Collection<CfgPerson> getManagers()
          A pointer to the list of the identifiers of the CfgPerson objects that serve as supervisors of this group.
 java.lang.String getName()
          A pointer to name of the group.
 CfgStatTable getQuotaTable()
          A unique identifier of the Stat Table of CFGQuotaTable type associated with this group.
 java.lang.Integer getQuotaTableDBID()
          Retrieves the dbid of the object that is being linked to by the QuotaTable property.
 java.util.Collection<java.lang.Integer> getRouteDNDBIDs()
          Retrieves dbids of objects that are being linked to by the RouteDNs property.
 java.util.Collection<CfgDN> getRouteDNs()
          A pointer to the list of identifiers of the telephony objects from which calls can be routed/diverted to this group.
 CfgFolder getSite()
          A unique identifier of Site ( Folder ) with which this Group is associated.
 java.lang.Integer getSiteDBID()
          Retrieves the dbid of the object that is being linked to by the Site property.
 CfgObjectState getState()
          Current object state.
 CfgTenant getTenant()
          A unique identifier of the Tenant that this group belongs to.
 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 setCapacityRule(CfgScript value)
          A unique identifier of the capacity rule ( Script ) associated with this group.
 void setCapacityRuleDBID(int dbid)
          A unique identifier of the capacity rule ( Script ) associated with this group.
 void setCapacityTable(CfgStatTable value)
          A unique identifier of the Stat Table of CFGCapacityTable type associated with this group.
 void setCapacityTableDBID(int dbid)
          A unique identifier of the Stat Table of CFGCapacityTable type associated with this group.
 void setContract(CfgObjectiveTable value)
          A unique identifier of Cost Contract ( Objective Table ) with which this Group is associated.
 void setContractDBID(int dbid)
          A unique identifier of Cost Contract ( Objective Table ) with which this Group is associated.
 void setDBID(java.lang.Integer value)
          An identifier of this object in the Configuration Database.
 void setManagerDBIDs(java.util.Collection<java.lang.Integer> value)
          Sets dbids collection of objects that are being linked to by the Managers property.
 void setManagers(java.util.Collection<CfgPerson> value)
          A pointer to the list of the identifiers of the CfgPerson objects that serve as supervisors of this group.
 void setName(java.lang.String value)
          A pointer to name of the group.
 void setQuotaTable(CfgStatTable value)
          A unique identifier of the Stat Table of CFGQuotaTable type associated with this group.
 void setQuotaTableDBID(int dbid)
          A unique identifier of the Stat Table of CFGQuotaTable type associated with this group.
 void setRouteDNDBIDs(java.util.Collection<java.lang.Integer> value)
          Sets dbids collection of objects that are being linked to by the RouteDNs property.
 void setRouteDNs(java.util.Collection<CfgDN> value)
          A pointer to the list of identifiers of the telephony objects from which calls can be routed/diverted to this group.
 void setSite(CfgFolder value)
          A unique identifier of Site ( Folder ) with which this Group is associated.
 void setSiteDBID(int dbid)
          A unique identifier of Site ( Folder ) with which this Group is associated.
 void setState(CfgObjectState value)
          Current object state.
 void setTenant(CfgTenant value)
          A unique identifier of the Tenant that this group belongs to.
 void setTenantDBID(int dbid)
          A unique identifier of the Tenant that this group belongs to.
 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.CfgStructure
getParent, updateChildrenSavedState
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgBase
clone, ensureDataBackup, equals, flushChildrenContent, getConfigurationService, getData, getEndpoint, getLinkListCollection, getLinkValue, getLogger, getMetaData, getProperty, getProperty, getProperty, getRawObjectData, hashCode, initStruct, isSaved, lockObject, reloadObjectWithNewData, resolveLink, setProperty, toString, toStringProperties, toXml
 
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

CfgGroup

public CfgGroup(IConfService confService,
                ConfStructure objData,
                ICfgObject parent)
This constructor is intended for creation of structures from external or imported XML data. It is internally used by COM AB for objects and structures deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol structure data
parent - instance of configuration object as a parent for this structure instance

CfgGroup

public CfgGroup(IConfService confService,
                org.w3c.dom.Node xmlData,
                ICfgObject parent)
This constructor is intended for creation of structures from external or imported XML data. It is internally used by COM AB for objects and structures deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing structure data
parent - instance of configuration object as a parent for this structure instance

CfgGroup

public CfgGroup(IConfService confService,
                ICfgObject parent)
This constructor is intended for creation of detached objects.

Parameters:
confService - configuration service instance
parent - instance of configuration object as a parent for this structure instance
Method Detail

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 Tenant that this group belongs to. 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 Tenant that this group belongs to. 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 Tenant that this group belongs to. 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 name of the group. Mandatory. See comments to CfgAgentGroup , CfgPlaceGroup, and CfgDNGroup .

Returns:
property value or null

setName

public final void setName(java.lang.String value)
A pointer to name of the group. Mandatory. See comments to CfgAgentGroup , CfgPlaceGroup, and CfgDNGroup .

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

getManagers

public final java.util.Collection<CfgPerson> getManagers()
A pointer to the list of the identifiers of the CfgPerson objects that serve as supervisors of this group. Applicable for CfgAgentGroup only. When used as an entry in CfgDeltaGroup, it is a pointer to a list of identifiers of the Persons added to the existing list. A person assigned as a supervisor to this Group should belong either to the same Tenant as the Group or to the Tenant Environment.

Returns:
list of configuration objects or null

setManagers

public final void setManagers(java.util.Collection<CfgPerson> value)
A pointer to the list of the identifiers of the CfgPerson objects that serve as supervisors of this group. Applicable for CfgAgentGroup only. When used as an entry in CfgDeltaGroup, it is a pointer to a list of identifiers of the Persons added to the existing list. A person assigned as a supervisor to this Group should belong either to the same Tenant as the Group or to the Tenant Environment.

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

getManagerDBIDs

public final java.util.Collection<java.lang.Integer> getManagerDBIDs()
Retrieves dbids of objects that are being linked to by the Managers 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

setManagerDBIDs

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

Parameters:
value - collection of DBID identifiers of referred objects

getRouteDNs

public final java.util.Collection<CfgDN> getRouteDNs()
A pointer to the list of identifiers of the telephony objects from which calls can be routed/diverted to this group. This list can include DNs whose types are set to CFGExtRoutingPoint, CFGServiceNumber, CFGRoutingQueue, CFGRoutingPoint or CFGACDQueue, CFGVirtACDQueue and CFGVirtRoutingPoint. When used as an entry in CfgDeltaGroup, it is a pointer to a list of identifiers of the DNs added to the existing list.

Returns:
list of configuration objects or null

setRouteDNs

public final void setRouteDNs(java.util.Collection<CfgDN> value)
A pointer to the list of identifiers of the telephony objects from which calls can be routed/diverted to this group. This list can include DNs whose types are set to CFGExtRoutingPoint, CFGServiceNumber, CFGRoutingQueue, CFGRoutingPoint or CFGACDQueue, CFGVirtACDQueue and CFGVirtRoutingPoint. When used as an entry in CfgDeltaGroup, it is a pointer to a list of identifiers of the DNs added to the existing list.

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

getRouteDNDBIDs

public final java.util.Collection<java.lang.Integer> getRouteDNDBIDs()
Retrieves dbids of objects that are being linked to by the RouteDNs 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

setRouteDNDBIDs

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

Parameters:
value - collection of DBID identifiers of referred objects

getCapacityTable

public final CfgStatTable getCapacityTable()
A unique identifier of the Stat Table of CFGCapacityTable type associated with this group.

Returns:
instance of referred object or null

setCapacityTable

public final void setCapacityTable(CfgStatTable value)
A unique identifier of the Stat Table of CFGCapacityTable type associated with this group.

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

setCapacityTableDBID

public final void setCapacityTableDBID(int dbid)
A unique identifier of the Stat Table of CFGCapacityTable type associated with this group.

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

getCapacityTableDBID

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

Returns:
DBID identifier of referred object or null

getQuotaTable

public final CfgStatTable getQuotaTable()
A unique identifier of the Stat Table of CFGQuotaTable type associated with this group.

Returns:
instance of referred object or null

setQuotaTable

public final void setQuotaTable(CfgStatTable value)
A unique identifier of the Stat Table of CFGQuotaTable type associated with this group.

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

setQuotaTableDBID

public final void setQuotaTableDBID(int dbid)
A unique identifier of the Stat Table of CFGQuotaTable type associated with this group.

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

getQuotaTableDBID

public final java.lang.Integer getQuotaTableDBID()
Retrieves the dbid of the object that is being linked to by the QuotaTable 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()

getCapacityRule

public final CfgScript getCapacityRule()
A unique identifier of the capacity rule ( Script ) associated with this group. Applicable for CfgPlaceGroup and CfgAgentGroup only.

Returns:
instance of referred object or null

setCapacityRule

public final void setCapacityRule(CfgScript value)
A unique identifier of the capacity rule ( Script ) associated with this group. Applicable for CfgPlaceGroup and CfgAgentGroup only.

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

setCapacityRuleDBID

public final void setCapacityRuleDBID(int dbid)
A unique identifier of the capacity rule ( Script ) associated with this group. Applicable for CfgPlaceGroup and CfgAgentGroup only.

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

getCapacityRuleDBID

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

Returns:
DBID identifier of referred object or null

getSite

public final CfgFolder getSite()
A unique identifier of Site ( Folder ) with which this Group is associated.

Returns:
instance of referred object or null

setSite

public final void setSite(CfgFolder value)
A unique identifier of Site ( Folder ) with which this Group is associated.

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

setSiteDBID

public final void setSiteDBID(int dbid)
A unique identifier of Site ( Folder ) with which this Group is associated.

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

getSiteDBID

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

Returns:
DBID identifier of referred object or null

getContract

public final CfgObjectiveTable getContract()
A unique identifier of Cost Contract ( Objective Table ) with which this Group is associated.

Returns:
instance of referred object or null

setContract

public final void setContract(CfgObjectiveTable value)
A unique identifier of Cost Contract ( Objective Table ) with which this Group is associated.

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

setContractDBID

public final void setContractDBID(int dbid)
A unique identifier of Cost Contract ( Objective Table ) with which this Group is associated.

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

getContractDBID

public final java.lang.Integer getContractDBID()
Retrieves the dbid of the object that is being linked to by the Contract 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.