Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaTableAccess

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

public class CfgDeltaTableAccess
extends CfgDelta

The CfgDeltaTableAccess is applicable for Configuration Library/Server release 5.1.5xx and later.


Constructor Summary
CfgDeltaTableAccess(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaTableAccess(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaTableAccess(IConfService confService, org.w3c.dom.Node xmlData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
 
Method Summary
 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.
 KeyValueCollection getChangedUserProperties()
          A pointer to the list of user-defined properties whose values have been changed.
 CfgApplication getDbAccess()
          A unique identifier of the CfgApplication of type CFGDBServer (DB Access Point) through which the table can be accessed.
 java.lang.Integer getDbAccessDBID()
          Retrieves the dbid of the object that is being linked to by the DbAccess property.
 java.lang.Integer getDBID()
          The DBID of the target CfgTableAccess configuration object.
 java.lang.String getDbTableName()
          A pointer to the name of table in data base.
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 java.lang.String getDescription()
          A list pointer to the description of table.
 CfgFormat getFormat()
          A unique identifier of CfgFormat of this table.
 java.lang.Integer getFormatDBID()
          Retrieves the dbid of the object that is being linked to by the Format property.
 CfgFlag getIsCachable()
          An indicator of whether the table data shell be mirrored in application memory.
 java.lang.String getName()
          A pointer to the mnemonic name of table access.
 CfgObjectState getState()
          Current object state.
 CfgTenant getTenant()
          A unique identifier of the CfgTenant to which this table access is allocated.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 CfgTableType getType()
          A type of table.
 java.lang.Integer getUpdateTimeout()
          A timeout between updates of table data in application memory.
 CfgTableAccess retrieveCfgTableAccess()
          Read base CfgTableAccess 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

CfgDeltaTableAccess

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

Parameters:
confService - configuration service instance

CfgDeltaTableAccess

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

CfgDeltaTableAccess

public CfgDeltaTableAccess(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 CfgTableAccess configuration object.

Returns:
target object DBID

retrieveCfgTableAccess

public final CfgTableAccess retrieveCfgTableAccess()
                                            throws ConfigException
Read base CfgTableAccess 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 CfgTenant to which this table access is allocated. 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 mnemonic name of table access. Mandatory. Must be unique within the Tenant.

Returns:
property value or null

getType

public final CfgTableType getType()
A type of table. Refer to CfgTableType of User Defined Variable Types. Mandatory. Once specified, cannot be changed.

Returns:
property value or null

getDescription

public final java.lang.String getDescription()
A list pointer to the description of table.

Returns:
property value or null

getDbAccess

public final CfgApplication getDbAccess()
A unique identifier of the CfgApplication of type CFGDBServer (DB Access Point) through which the table can be accessed. Mandatory.

Returns:
instance of referred object or null

getDbAccessDBID

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

Returns:
DBID identifier of referred object or null

getFormat

public final CfgFormat getFormat()
A unique identifier of CfgFormat of this table. Once specified cannot be changed. The property is mandatory for all table types except CFGTTLogTable. See CfgTableType.

Returns:
instance of referred object or null

getFormatDBID

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

Returns:
DBID identifier of referred object or null

getDbTableName

public final java.lang.String getDbTableName()
A pointer to the name of table in data base. Due to restrictions of some database engines the recommended length for property name is 1 to 12 characters. Mandatory.

Returns:
property value or null

getIsCachable

public final CfgFlag getIsCachable()
An indicator of whether the table data shell be mirrored in application memory. See type CfgFlag .

Returns:
property value or null

getUpdateTimeout

public final java.lang.Integer getUpdateTimeout()
A timeout between updates of table data in application memory. Active if parameter isCachable set to true only.

Returns:
property value 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

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.