Top Method Summary
Options Name Purpose
Consultingwerk.SmartFramework.System.TableDatasetModel FindSmartTable (character) Returns a TableDatasetModel positioned on the SmartTable record of the given database table
CHARACTER GetQualifiedTableName (TableDatasetModel) Returns the qualified name (database.table) of the SmartTable record the model is positioned on
Consultingwerk.SmartFramework.System.SmartTableRegistrationResult GetRegistration (character) Returns the current Business Entity registration of a database table
LOGICAL IsRegistrationUpdateRequired (character, character, logical) Returns if a registration needs to be written
Consultingwerk.SmartFramework.System.SmartTableRegistrationResult UpdateRegistration (character, character, character, logical, logical) Updates the Business Entity registration of a database table


Method Detail
Top

Consultingwerk.SmartFramework.System.TableDatasetModel FindSmartTable (character)

Purpose: Returns a TableDatasetModel positioned on the SmartTable record
of the given database table
Notes: The SmartTable TableModel is not available when no record exists
for the table. The caller is responsible for deleting the model

Parameters:
pcDatabaseTableName CHARACTER
The name of the database table, optionally qualified with the database name (e.g. Sports2000.Customer)
Returns Consultingwerk.SmartFramework.System.TableDatasetModel
The TableDatasetModel positioned on the SmartTable record
Top

CHARACTER GetQualifiedTableName (TableDatasetModel)

Purpose: Returns the qualified name (database.table) of the SmartTable
record the model is positioned on
Notes:

Parameters:
poTable Consultingwerk.SmartFramework.System.TableDatasetModel
The TableDatasetModel positioned on the SmartTable record
Returns CHARACTER
The qualified table name
Top

Consultingwerk.SmartFramework.System.SmartTableRegistrationResult GetRegistration (character)

Purpose: Returns the current Business Entity registration of a database table
Notes: The SmartTableFound property of the returned result is false when
no SmartTable record exists for the database table

Parameters:
pcDatabaseTableName CHARACTER
The name of the database table, optionally qualified with the database name (e.g. Sports2000.Customer)
Returns Consultingwerk.SmartFramework.System.SmartTableRegistrationResult
The SmartTableRegistrationResult describing the current registration
Top

LOGICAL IsRegistrationUpdateRequired (character, character, logical)

Purpose: Returns if a registration needs to be written
Notes: Nothing is written when no Business Entity name is passed, when
the same Business Entity is registered already or when a different
Business Entity is registered and overwriting was not requested

Parameters:
pcCurrentValue CHARACTER
The currently registered Business Entity name
pcNewValue CHARACTER
The Business Entity name to register
plOverwrite LOGICAL
Logical value indicating if an existing registration should be overwritten
Returns LOGICAL
Logical value indicating if the registration needs to be written
Top

Consultingwerk.SmartFramework.System.SmartTableRegistrationResult UpdateRegistration (character, character, character, logical, logical)

Purpose: Updates the Business Entity registration of a database table
Notes: A registration is only written when a Business Entity name is
passed for it. Unless the matching overwrite flag is set, the
registration is only written when it is not set yet (SCL-5822)

Parameters:
pcDatabaseTableName CHARACTER
The name of the database table, optionally qualified with the database name (e.g. Sports2000.Customer)
pcMaintenanceBusinessEntity CHARACTER
The name of the maintenance Business Entity to register, empty to leave the registration unchanged
pcQueryBusinessEntity CHARACTER
The name of the query Business Entity to register, empty to leave the registration unchanged
plOverwriteMaintenanceBusinessEntity LOGICAL
Logical value indicating if an existing maintenance Business Entity registration should be overwritten
plOverwriteQueryBusinessEntity LOGICAL
Logical value indicating if an existing query Business Entity registration should be overwritten
Returns Consultingwerk.SmartFramework.System.SmartTableRegistrationResult
The SmartTableRegistrationResult describing the registration after the update


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       19.09.2026 10:16:25