Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgTableAccess

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

public class CfgTableAccess
extends CfgObject

Table Access objects describe database tables of a specified Format and explain how to access these tables through Database Access Points.

One TableAccess can be dedicated to several objects of CfgCallingList type.

A TableAccess cannot be deleted as long as it is associated with at least one CallingList (see CfgCallingList ).

See also:

CfgDeltaTableAccess

CfgFormat


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgTableAccess(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgTableAccess(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgTableAccess(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
 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()
          An identifier of this object in the Configuration Database.
 java.lang.String getDbTableName()
          A pointer to the name of table in data base.
 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.
 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 setDbAccess(CfgApplication value)
          A unique identifier of the CfgApplication of type CFGDBServer (DB Access Point) through which the table can be accessed.
 void setDbAccessDBID(int dbid)
          A unique identifier of the CfgApplication of type CFGDBServer (DB Access Point) through which the table can be accessed.
 void setDBID(java.lang.Integer value)
          An identifier of this object in the Configuration Database.
 void setDbTableName(java.lang.String value)
          A pointer to the name of table in data base.
 void setDescription(java.lang.String value)
          A list pointer to the description of table.
 void setFormat(CfgFormat value)
          A unique identifier of CfgFormat of this table.
 void setFormatDBID(int dbid)
          A unique identifier of CfgFormat of this table.
 void setIsCachable(CfgFlag value)
          An indicator of whether the table data shell be mirrored in application memory.
 void setName(java.lang.String value)
          A pointer to the mnemonic name of table access.
 void setState(CfgObjectState value)
          Current object state.
 void setTenant(CfgTenant value)
          A unique identifier of the CfgTenant to which this table access is allocated.
 void setTenantDBID(int dbid)
          A unique identifier of the CfgTenant to which this table access is allocated.
 void setType(CfgTableType value)
          A type of table.
 void setUpdateTimeout(java.lang.Integer value)
          A timeout between updates of table data in application memory.
 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

OBJECT_TYPE

public static final CfgObjectType OBJECT_TYPE
Constructor Detail

CfgTableAccess

public CfgTableAccess(IConfService confService,
                      ConfObject objData,
                      boolean isSaved,
                      java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. It is internally used by COM AB for objects deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol object data structure
isSaved - indicator of the object saved state
additionalParameters - additional parameters from configuration protocol message

CfgTableAccess

public CfgTableAccess(IConfService confService,
                      org.w3c.dom.Node xmlData,
                      java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. It is internally used by COM AB for objects deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing object data
additionalParameters - additional parameters from configuration protocol message

CfgTableAccess

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

Parameters:
confService - configuration service instance
Method Detail

save

public void save()
          throws ConfigException
Synchronizes changes in the class with Configuration Server.

Specified by:
save in interface ICfgObject
Overrides:
save in class CfgObject
Throws:
ConfigException - in case of protocol level exception, data transformation, or server side constraints

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 CfgTenant to which this table access is allocated. 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 CfgTenant to which this table access is allocated. 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 CfgTenant to which this table access is allocated. 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 the mnemonic name of table access. Mandatory. Must be unique within the Tenant.

Returns:
property value or null

setName

public final void setName(java.lang.String value)
A pointer to the mnemonic name of table access. Mandatory. Must be unique within the Tenant.

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

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

setType

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

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

getDescription

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

Returns:
property value or null

setDescription

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

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

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

setDbAccess

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

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

setDbAccessDBID

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

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

getDbAccessDBID

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

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

setFormat

public final void setFormat(CfgFormat value)
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.

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

setFormatDBID

public final void setFormatDBID(int dbid)
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.

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

getFormatDBID

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

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

setDbTableName

public final void setDbTableName(java.lang.String value)
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.

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

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

setIsCachable

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

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

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

setUpdateTimeout

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

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

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()

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.