Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaPlace

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

public class CfgDeltaPlace
extends CfgDelta

The changes to make to a CfgPlace object.


Constructor Summary
CfgDeltaPlace(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaPlace(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaPlace(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> getAddedDNDBIDs()
          A pointer to the list of identifiers of the telephony objects that are assigned to this place.
 java.util.Collection<CfgDN> getAddedDNs()
          A pointer to the list of identifiers of the telephony objects that are assigned to this place.
 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 ( CfgScript ) associated with this place.
 java.lang.Integer getCapacityRuleDBID()
          Retrieves the dbid of the object that is being linked to by the CapacityRule 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 (CfgObjectiveTable) with which this Place 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 CfgPlace configuration object.
 java.util.Collection<java.lang.Integer> getDeletedDNDBIDs()
          A pointer to the list of identifiers of the telephony objects that have been removed from this place.
 java.util.Collection<CfgDN> getDeletedDNs()
          A pointer to the list of identifiers of the telephony objects that have been removed from this place.
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 java.util.Collection<java.lang.Integer> getDNDBIDs()
          Deprecated.  
 java.lang.String getName()
          A pointer to the name of the place.
 CfgFolder getSite()
          A unique identifier of Site (CfgFolder) with which this Place 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 place belongs to.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 CfgPlace retrieveCfgPlace()
          Read base CfgPlace 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

CfgDeltaPlace

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

Parameters:
confService - configuration service instance

CfgDeltaPlace

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

CfgDeltaPlace

public CfgDeltaPlace(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 CfgPlace configuration object.

Returns:
target object DBID

retrieveCfgPlace

public final CfgPlace retrieveCfgPlace()
                                throws ConfigException
Read base CfgPlace configuration object caused this event.

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

getTenant

public final CfgTenant getTenant()
A unique identifier of the Tenant that this place 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 the name of the place. Mandatory. Must be unique within the tenant.

Returns:
property value or null

getAddedDNs

public final java.util.Collection<CfgDN> getAddedDNs()
A pointer to the list of identifiers of the telephony objects that are assigned to this place. When used as an entry in CfgDeltaPlace (see below), it is a pointer to a list of identifiers of the objects added to the existing list. DNs assigned to the place must belong to the tenant specified by tenantDBID above. One DN cannot be assigned to more than one place. DNs of the following types cannot be included into a place: CFGACDQueue, CFGRoutingPoint, CFGVirtACDQueue, CFGVirtRoutingPoint, CFGTrunk, CFGTrunkGroup, CFGTieLine, CFGTieLineGroup, CFGExtRoutingPoint and CFGRoutingQueue. CFGDestinationLabel, CFGServiceNumber,CFGAccessResource.

Returns:
list of configuration objects or null

getAddedDNDBIDs

public final java.util.Collection<java.lang.Integer> getAddedDNDBIDs()
A pointer to the list of identifiers of the telephony objects that are assigned to this place. When used as an entry in CfgDeltaPlace (see below), it is a pointer to a list of identifiers of the objects added to the existing list. DNs assigned to the place must belong to the tenant specified by tenantDBID above. One DN cannot be assigned to more than one place. DNs of the following types cannot be included into a place: CFGACDQueue, CFGRoutingPoint, CFGVirtACDQueue, CFGVirtRoutingPoint, CFGTrunk, CFGTrunkGroup, CFGTieLine, CFGTieLineGroup, CFGExtRoutingPoint and CFGRoutingQueue. CFGDestinationLabel, CFGServiceNumber,CFGAccessResource.

Returns:
collection of DBID identifiers of referred objects or null

getDNDBIDs

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

See Also:
getAddedDNDBIDs()

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 ( CfgScript ) associated with this place.

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 (CfgFolder) with which this Place 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 (CfgObjectiveTable) with which this Place 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

getDeletedDNs

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

Returns:
list of configuration objects or null

getDeletedDNDBIDs

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

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.