|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.applicationblocks.com.CfgBase
com.genesyslab.platform.applicationblocks.com.CfgObject
com.genesyslab.platform.applicationblocks.com.objects.CfgTableAccess
public class CfgTableAccess
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
).
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 |
---|
public static final CfgObjectType OBJECT_TYPE
Constructor Detail |
---|
public CfgTableAccess(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
confService
- configuration service instanceobjData
- configuration protocol object data structureisSaved
- indicator of the object saved stateadditionalParameters
- additional parameters from configuration protocol messagepublic CfgTableAccess(IConfService confService, org.w3c.dom.Node xmlData, java.lang.Object[] additionalParameters)
confService
- configuration service instancexmlData
- XML object containing object dataadditionalParameters
- additional parameters from configuration protocol messagepublic CfgTableAccess(IConfService confService)
confService
- configuration service instanceMethod Detail |
---|
public void save() throws ConfigException
save
in interface ICfgObject
save
in class CfgObject
ConfigException
- in case of protocol level exception, data transformation,
or server side constraintspublic final java.lang.Integer getDBID()
public final void setDBID(java.lang.Integer value)
value
- new property valuegetDBID()
public final CfgTenant getTenant()
CfgTenant
to which this table access is allocated. Mandatory. Once specified,
cannot be changed.
public final void setTenant(CfgTenant value)
CfgTenant
to which this table access is allocated. Mandatory. Once specified,
cannot be changed.
value
- new property valuegetTenant()
public final void setTenantDBID(int dbid)
CfgTenant
to which this table access is allocated. Mandatory. Once specified,
cannot be changed.
dbid
- DBID identifier of referred objectgetTenant()
public final java.lang.Integer getTenantDBID()
public final java.lang.String getName()
public final void setName(java.lang.String value)
value
- new property valuegetName()
public final CfgTableType getType()
CfgTableType
of
User Defined Variable Types. Mandatory. Once specified, cannot be
changed.
public final void setType(CfgTableType value)
CfgTableType
of
User Defined Variable Types. Mandatory. Once specified, cannot be
changed.
value
- new property valuegetType()
public final java.lang.String getDescription()
public final void setDescription(java.lang.String value)
value
- new property valuegetDescription()
public final CfgApplication getDbAccess()
CfgApplication
of type CFGDBServer
(DB Access Point) through which the table can be accessed.
Mandatory.
public final void setDbAccess(CfgApplication value)
CfgApplication
of type CFGDBServer
(DB Access Point) through which the table can be accessed.
Mandatory.
value
- new property valuegetDbAccess()
public final void setDbAccessDBID(int dbid)
CfgApplication
of type CFGDBServer
(DB Access Point) through which the table can be accessed.
Mandatory.
dbid
- DBID identifier of referred objectgetDbAccess()
public final java.lang.Integer getDbAccessDBID()
public final CfgFormat getFormat()
CfgFormat
of this table. Once specified cannot be changed. The property is
mandatory for all table types except
CFGTTLogTable
. See CfgTableType
.
public final void setFormat(CfgFormat value)
CfgFormat
of this table. Once specified cannot be changed. The property is
mandatory for all table types except
CFGTTLogTable
. See CfgTableType
.
value
- new property valuegetFormat()
public final void setFormatDBID(int dbid)
CfgFormat
of this table. Once specified cannot be changed. The property is
mandatory for all table types except
CFGTTLogTable
. See CfgTableType
.
dbid
- DBID identifier of referred objectgetFormat()
public final java.lang.Integer getFormatDBID()
public final java.lang.String getDbTableName()
public final void setDbTableName(java.lang.String value)
value
- new property valuegetDbTableName()
public final CfgFlag getIsCachable()
CfgFlag
.
public final void setIsCachable(CfgFlag value)
CfgFlag
.
value
- new property valuegetIsCachable()
public final java.lang.Integer getUpdateTimeout()
isCachable
set
to true only.
public final void setUpdateTimeout(java.lang.Integer value)
isCachable
set
to true only.
value
- new property valuegetUpdateTimeout()
public final CfgObjectState getState()
CfgObjectState
public final void setState(CfgObjectState value)
CfgObjectState
value
- new property valuegetState()
public final KeyValueCollection getUserProperties()
public final void setUserProperties(KeyValueCollection value)
value
- new property valuegetUserProperties()
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |