Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaGroup

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

public class CfgDeltaGroup
extends CfgDelta

The changes to make to a CfgGroup object.


Constructor Summary
CfgDeltaGroup(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaGroup(IConfService confService, ConfStructure objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaGroup(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> getAddedManagerDBIDs()
          A pointer to the list of the identifiers of the CfgPerson objects that serve as supervisors of this group.
 java.util.Collection<CfgPerson> getAddedManagers()
          A pointer to the list of the identifiers of the CfgPerson objects that serve as supervisors of this group.
 java.util.Collection<java.lang.Integer> getAddedRouteDNDBIDs()
          A pointer to the list of identifiers of the telephony objects from which calls can be routed/diverted to this group.
 java.util.Collection<CfgDN> getAddedRouteDNs()
          A pointer to the list of identifiers of the telephony objects from which calls can be routed/diverted to this group.
 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.
 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.
 KeyValueCollection getChangedUserProperties()
          A pointer to the list of user-defined properties whose values have been changed.
 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()
          The DBID of the target CfgGroup configuration object.
 java.util.Collection<java.lang.Integer> getDeletedManagerDBIDs()
          A pointer to the list of identifiers of the Person objects that have been deleted from this group.
 java.util.Collection<CfgPerson> getDeletedManagers()
          A pointer to the list of identifiers of the Person objects that have been deleted from this group.
 java.util.Collection<java.lang.Integer> getDeletedRouteDNDBIDs()
          A pointer to the list of identifiers of the telephony objects that have been deleted from this group.
 java.util.Collection<CfgDN> getDeletedRouteDNs()
          A pointer to the list of identifiers of the telephony objects that have been deleted from this group.
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 java.util.Collection<java.lang.Integer> getManagerDBIDs()
          Deprecated.  
 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()
          Deprecated.  
 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.
 
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

CfgDeltaGroup

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

Parameters:
confService - configuration service instance

CfgDeltaGroup

public CfgDeltaGroup(IConfService confService,
                     ConfStructure 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

CfgDeltaGroup

public CfgDeltaGroup(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 CfgGroup configuration object.

Returns:
target object DBID

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

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

Returns:
property value or null

getAddedManagers

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

getAddedManagerDBIDs

public final java.util.Collection<java.lang.Integer> getAddedManagerDBIDs()
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:
collection of DBID identifiers of referred objects or null

getManagerDBIDs

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

See Also:
getAddedManagerDBIDs()

getAddedRouteDNs

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

getAddedRouteDNDBIDs

public final java.util.Collection<java.lang.Integer> getAddedRouteDNDBIDs()
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:
collection of DBID identifiers of referred objects or null

getRouteDNDBIDs

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

See Also:
getAddedRouteDNDBIDs()

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

getCapacityTableDBID

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

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

getQuotaTableDBID

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

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

getCapacityRuleDBID

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

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

getSiteDBID

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

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

getContractDBID

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

Returns:
DBID identifier of referred object or null

getDeletedManagers

public final java.util.Collection<CfgPerson> getDeletedManagers()
A pointer to the list of identifiers of the Person objects that have been deleted from this group.

Returns:
list of configuration objects or null

getDeletedManagerDBIDs

public final java.util.Collection<java.lang.Integer> getDeletedManagerDBIDs()
A pointer to the list of identifiers of the Person objects that have been deleted from this group.

Returns:
collection of DBID identifiers of referred objects or null

getDeletedRouteDNs

public final java.util.Collection<CfgDN> getDeletedRouteDNs()
A pointer to the list of identifiers of the telephony objects that have been deleted from this group.

Returns:
list of configuration objects or null

getDeletedRouteDNDBIDs

public final java.util.Collection<java.lang.Integer> getDeletedRouteDNDBIDs()
A pointer to the list of identifiers of the telephony objects that have been deleted from this group.

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.