Namespace: Consultingwerk.SmartFramework.Menu
Class 
MenuDataAccess Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.DataAccess
Consultingwerk.SmartFramework.SmartDataAccess
Consultingwerk.SmartFramework.Menu.MenuDataAccess

Inherits: Consultingwerk.SmartFramework.SmartDataAccess
Implements: Consultingwerk.OERA.IDataAccess, Consultingwerk.OERA.IDataAccessCanFind, Consultingwerk.OERA.IDataAccessCountRecords, IDSQueryStringSource, Consultingwerk.OERA.IProvidesSmartRecordInformation


Consultingwerk.SmartFramework.Menu.MenuBusinessEntity
Consultingwerk.SmartFramework.Menu.MenuBusinessEntity

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
ActivateRelationeSmartMenueSmartFunctionRelation () Activates at eSmartMenueSmartFunctionRelation DATA-RELATION
AttachDataSources () Attaches the DATA-SOURCE objects to the ProDataset Buffers
BindDataset (dataset) Do nothing, just receive the parameter and bind to the received Dataset reference
DefineReadEvents () TO-DO: Subscribe to ProDataset Event Handlers using SET-CALLBACK as needed
DeleteMenuItem (character) Deletes a menu item and it's children
DetachDataSources () Detaches the DATA-SOURCE objects to the ProDataset Buffers
eSmartFunctionBeforeRowFill (dataset) Callback for the BEFORE-ROW-FILL of the eSmartFunction buffer
eSmartMenuAfterFill (dataset) Set calculated fields of eSmartMenu
eSmartMenuCreateBeginTrans () INITIAL the MenuSequence to highest number of sibling records + 1
FetchChildMenuItems (character) Fetches the child menu items
FetchData (IFetchDataRequest) Fetch data from the data source
FetchDataByStaticQuery (IFetchDataByStaticQueryRequest) Fetches data for single table, using a static query
FetchSmartMenuByMenuGuid (character, character) FetchData method for static query
FetchSmartMenuByMenuStructureCode (character, character) FetchData method for static query
FilleSmartFunctionOfeSmartMenu (character, character, logical) Fill child tables method for static query
InitializeFilters (IFetchDataRequest) Initializes the arguments for the BeforeRowFill based filter
SaveChanges () Save changes to physical storage
CHARACTER SourceColumn (character, character) Returns the database field name matching a temp-table field name contained in a consumers query string (query string vs. temp-table definition)
CHARACTER SourceDefaultQuery (character) Returns the base query string used to retrieve data for the temp tables. This query string will be appended by the query provided by the consumer (FetchDataRequest object).
ValidateMoveMenuStructure (MoveMenuStructureParameter) Validates that a Menu Structure node can be moved to the given target node.

Top Constructor Summary
Options Name Purpose
MenuDataAccess (handle) Constructor for the MenuDataAccess class


Method Detail
Top

ActivateRelationeSmartMenueSmartFunctionRelation ()
Purpose: Activates at eSmartMenueSmartFunctionRelation DATA-RELATION
Notes:

Top

AttachDataSources ()
Purpose: Attaches the DATA-SOURCE objects to the ProDataset Buffers
Notes: Overrides ABSTRACT method in Consultingwerk.OERA.DataAccess,
Invoked in FetchData and SaveChanges

Top

BindDataset (dataset)
Purpose: Do nothing, just receive the parameter and bind to the received
Dataset reference
Notes: Invoked from the class constructor

Parameters:
dsMenu DATASET dsMenu
DATASET to bind to
Top

DefineReadEvents ()
Purpose: TO-DO: Subscribe to ProDataset Event Handlers using SET-CALLBACK
as needed
Notes: Overrides ABSTRACT method in Consultingwerk.OERA.DataAccess,
Invoked in FetchData

Top

DeleteMenuItem (character)
Purpose: Deletes a menu item and it's children
Notes:

Parameters:
pcMenuGuid CHARACTER
The GUID of the menu item to delete
Top

DetachDataSources ()
Purpose: Detaches the DATA-SOURCE objects to the ProDataset Buffers
Notes: Overrides ABSTRACT method in Consultingwerk.OERA.DataAccess,
Invoked in FetchData and SaveChanges

Top

eSmartFunctionBeforeRowFill (dataset)
Purpose: Callback for the BEFORE-ROW-FILL of the eSmartFunction buffer
Notes:

Parameters:
dsMenu DATASET dsMenu
The dataset
Top

eSmartMenuAfterFill (dataset)
Purpose: Set calculated fields of eSmartMenu
Notes:

Parameters:
dsMenu DATASET dsMenu
Input of the dataset
Top

eSmartMenuCreateBeginTrans ()
Purpose: INITIAL the MenuSequence to highest number of sibling records + 1
Notes:

Top

FetchChildMenuItems (character)
Purpose: Fetches the child menu items
Notes:

Parameters:
pcParentMenuGuid CHARACTER
The GUID of the Parent Menu Structure
Top

FetchData (IFetchDataRequest)
Purpose: Fetch data from the data source
Notes: poFetchDataRequest:Context property is used to control batching
(forward/backwards) and the FindRowWhere/PreFetchOnFind
The first entry by CHR(1) in the Context is CHR(2) delimited:
1. Entry: RESTART-ROWID(s) - CHR(5) Delimited
2. Entry: Find String
3. Entry: PrefetchOnFind Value
The poFetchDataRequest parameter may also be passed in as a
FetchDataAccessRequest instance allowing further specific arguments
to be passed that are only relevant to the DataAccess class

Parameters:
poFetchDataRequest Consultingwerk.OERA.IFetchDataRequest
The IFetchDataRequest object with the parameters for this call
Top

FetchDataByStaticQuery (IFetchDataByStaticQueryRequest)
Purpose: Fetches data for single table, using a static query
Notes:

Parameters:
poParameter Consultingwerk.OERA.IFetchDataByStaticQueryRequest
The query parameter object
Top

FetchSmartMenuByMenuGuid (character, character)
Purpose: FetchData method for static query
Notes:

Parameters:
pcMenuGuid CHARACTER
The MenuGuid value
pcChildTables CHARACTER
a list of the child tables to fill
Top

FetchSmartMenuByMenuStructureCode (character, character)
Purpose: FetchData method for static query
Notes:

Parameters:
pcMenuStructureCode CHARACTER
The MenuStructureCode value
pcChildTables CHARACTER
a list of the child tables to fill
Top

FilleSmartFunctionOfeSmartMenu (character, character, logical)
Purpose: Fill child tables method for static query
Notes:

Parameters:
pcFunctionGuid CHARACTER
The FunctionGuid value
pcChildTables CHARACTER
The list of child table to fill
plApplyCallback LOGICAL
Whether to apply the buffer read callbacks
Top

InitializeFilters (IFetchDataRequest)
Purpose: Initializes the arguments for the BeforeRowFill based filter
Notes:

Parameters:
poFetchDataRequest Consultingwerk.OERA.IFetchDataRequest
The IFetchDataRequest instance of the current request
Top

SaveChanges ()
Purpose: Save changes to physical storage
Notes: This implementation of data access save traverses all records in order
to:
- Allow the DA to control transactions, which cannot be directly
controlled in distributed BL. Transaction control is a concern of
the BL, but should not be controlled with TRANSACTION keyword.
- Offer a course grained save interface from distributed BL
- The default operation here is just a transaction per record
- This simple sample does not use child relations to traverse
the buffers as the OERI BE example. (A property that controls
update order would give the same effect).
- Traversing of child data from a parent would make sense if done for
one parent record at a time.

Top

CHARACTER SourceColumn (character, character)
Purpose: Returns the database field name matching a temp-table field name
contained in a consumers query string (query string vs. temp-table
definition)
Notes: Call-back used by Consultingwerk.OERA.Query.DSQueryString (part of
DataAccess:FetchData FetchData () query preparation

Parameters:
pcTable CHARACTER
The temp table name to return the source (database table) field name for
pcColumn CHARACTER
The temp table column name to return the source (database table) field name for
Returns CHARACTER
The database field name mapped to the passed in temp-table field
Top

CHARACTER SourceDefaultQuery (character)
Purpose: Returns the base query string used to retrieve data for the temp
tables. This query string will be appended by the query provided by
the consumer (FetchDataRequest object).
Notes: Call-back used by Consultingwerk.OERA.Query.DSQueryString (part of
DataAccess:FetchData FetchData () query preparation

Parameters:
pcTable CHARACTER
The temp table name to return the source default (database) query string for
Returns CHARACTER
The base query string used to retrieve data for the given temp-table
Top

ValidateMoveMenuStructure (MoveMenuStructureParameter)
Purpose: Validates that a Menu Structure node can be
moved to the given target node.
Notes: Throws an error when attempting to move a menu item to a child

Parameters:
poParameter Consultingwerk.SmartFramework.Menu.MoveMenuStructureParameter
The MoveMenuStructureParameter with the data for the operation


Constructor Detail
Top

MenuDataAccess (handle)
Purpose: Constructor for the MenuDataAccess class
Notes: Used by the BusinessEntity, will receive the handle of the dataset
instance form the BusinessEntity as a parameter. Permanently BIND's
to that dataset using the PRIVATE BindDataset Method.

Parameters:
phDataset HANDLE
The handle of the Business Entity dataset


ProDataset Detail

ProDataset dsMenu

Member tables: eSmartMenu, eSmartFunction


Temp-Table Detail

Temp-Table eSmartFunction

Defined in:

Temp-Table eSmartMenu

Defined in:


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