Consultingwerk.SmartFramework.Repository.Object.ObjectMasterDataAccess

Namespace:

Consultingwerk.SmartFramework.Repository.Object

Class

ObjectMasterDataAccess

Parent classes:

Progress.Lang.Object

Consultingwerk.OERA.DataAccess

Consultingwerk.SmartFramework.SmartDataAccess

Consultingwerk.SmartFramework.Repository.Object.ObjectMasterDataAccess

Inherits:

Consultingwerk.SmartFramework.SmartDataAccess

Implements:

Consultingwerk.OERA.IDataAccess, Consultingwerk.OERA.IDataAccessCanFind, Consultingwerk.OERA.IDataAccessCountRecords, IDSQueryStringSource, Consultingwerk.OERA.IProvidesSmartRecordInformation

Consultingwerk.SmartFramework.Repository.Object.ObjectMasterBusinessEntity

Top Method Summary

	Options	Name	Purpose
		ActivateRelationeSmartObjectMastereSmartLinkRelation ()	Activates at eSmartObjectMastereSmartLinkRelation DATA-RELATION
		ActivateRelationeSmartObjectMastereSmartObjectInstanceRelation ()	Activates at eSmartObjectMastereSmartObjectInstanceRelation DATA-RELATION
		ActivateRelationeSmartObjectMastereSmartPageRelation ()	Activates at eSmartObjectMastereSmartPageRelation 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
		CHARACTER BuildDataSourceQueryString (handle, IFetchDataRequest, character)	Returns the Query String to be used for the DATA-SOURCE of a ProDataset member buffer
		CommitChanges (handle)	This procedure is called from saveChanges in the DA to do the actual database commit and any transaction-related validation logic for a buffer.
		DefineReadEvents ()	TO-DO: Subscribe to ProDataset Event Handlers using SET-CALLBACK as needed
		DetachDataSources ()	Detaches the DATA-SOURCE objects to the ProDataset Buffers
		FetchData (IFetchDataRequest)	Fetch data from the data source
		FetchDataByKeyTable2 (IFetchDataByKeyTableParameter)	Allows retrieve multiple DB records from a Business Entity based on a temp-table with key values
		FetchDataByStaticQuery (IFetchDataByStaticQueryRequest)	Fetches data for single table, using a static query
		FetchObjectMasterWithAttributeValues (FindObjectMasterWithAttributeValuesParameter)	Returns a dataset with Object Master records that have the given attribute values
		FetchSmartObjectMasterByObjectMasterGuid (character, character)	FetchData method for static query
		FetchSmartObjectMasterByObjectName (character, character)	FetchData method for static query
		FilleSmartLinkOfeSmartObjectMaster (character, character, logical)	Fill child tables method for static query
		FilleSmartObjectInstanceOfeSmartObjectMaster (character, character, logical)	Fill child tables method for static query
		FilleSmartPageOfeSmartObjectMaster (character, character, logical)	Fill child tables method for static query
		CHARACTER GetObjectMasterGuidFromInstanceGuid (character)	Returns the Object Master Guid based on an Object Instance GUID
		CHARACTER GetObjectMasterGuidFromObjectName (character)	Returns the ObjectMasterGuid from on ObjectName
		HANDLE InsertToDataSourceQuery (handle, IFetchDataRequest, character)	Creates a new Query to be used as a DATA-SOURCE for a ProDataset member buffer
		MovePage (MovePageParameter)	Moves a page in a container
		ObjectIsA (ObjectIsAParameter)	Returns if the object master is a child of the given class
		SaveRowChanges (handle)	Overridable method that executes SAVE-ROW-CHANGES on the before buffer
		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).

Top Constructor Summary

	Options	Name	Purpose
		ObjectMasterDataAccess (handle)	Constructor for the ObjectMasterDataAccess class

Method Detail

Top

ActivateRelationeSmartObjectMastereSmartLinkRelation ()

Purpose:	Activates at eSmartObjectMastereSmartLinkRelation DATA-RELATION
Notes:

Top

ActivateRelationeSmartObjectMastereSmartObjectInstanceRelation ()

Purpose:	Activates at eSmartObjectMastereSmartObjectInstanceRelation DATA-RELATION
Notes:

Top

ActivateRelationeSmartObjectMastereSmartPageRelation ()

Purpose:	Activates at eSmartObjectMastereSmartPageRelation 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:
dsObjectMaster	DATASET dsObjectMaster
	DATASET to bind to

Top

CHARACTER BuildDataSourceQueryString (handle, IFetchDataRequest, character)

Purpose:	Returns the Query String to be used for the DATA-SOURCE of a ProDataset
	member buffer
Notes:	Wrapper to the access to the DSQueryString class to simplify overriding
	the query manipulation in a custom Data Access class or customer
	DataAccess base class override
	This method is used to provide the query string for non top-level buffers
	The returned Query String is based on the Query String that was provided
	(by the consumer) and the Source Default Query of the Data Access object

Parameters:
phBufferHandle	HANDLE
	The Handle of the ProDataset member buffer
poFetchDataRequest	Consultingwerk.OERA.IFetchDataRequest
	The FetchDataRequest object of the current request
pcQueryString	CHARACTER
	The query string provided by the consumer
Returns	CHARACTER
	The Query String to be used for the data source of the ProDataset member buffer

Top

CommitChanges (handle)

Purpose:	This procedure is called from saveChanges in the DA
	to do the actual database commit and any transaction-related
	validation logic for a buffer.
Notes:

Parameters:
phBuffer	HANDLE
	The handle of the buffer to commit

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, note that the callback methods need to be
	PUBLIC and need to have the Dataset defined as an INPUT Parameter.
	Errors thrown from or raised in the FILL call-back methods of the
	DataAccess class (SET-CALLBACK) will stop the Dataset from getting
	filled / filled further. However errors thrown from the call-back
	methods are not thrown from the FILL() method further up into a
	catch block or to the client.
	See http://knowledgebase.progress.com/articles/Article/P188375
Sample:	BUFFER eCustomer:SET-CALLBACK (Consultingwerk.DatasetBufferCallbackEnum:AfterFill,
"eCustomerAfterFill":U)	U) .

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

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

FetchDataByKeyTable2 (IFetchDataByKeyTableParameter)

Purpose:	Allows retrieve multiple DB records from a Business Entity based on
	a temp-table with key values
Notes:

Parameters:
poParameter	Consultingwerk.OERA.IFetchDataByKeyTableParameter
	The IFetchDataByKeyTableParameter with the data 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

FetchObjectMasterWithAttributeValues (FindObjectMasterWithAttributeValuesParameter)

Purpose:	Returns a dataset with Object Master records that have the given attribute values
Notes:

Parameters:
poAttributes	Consultingwerk.SmartFramework.Repository.Object.FindObjectMasterWithAttributeValuesParameter
	The FindObjectMasterWithAttributeValuesParameter instance with the data with this call

Top

FetchSmartObjectMasterByObjectMasterGuid (character, character)

Purpose:	FetchData method for static query
Notes:

Parameters:
pcObjectMasterGuid	CHARACTER
	The ObjectMasterGuid value
pcChildTables	CHARACTER
	a list of the child tables to fill

Top

FetchSmartObjectMasterByObjectName (character, character)

Purpose:	FetchData method for static query
Notes:

Parameters:
pcObjectName	CHARACTER
	The ObjectName value
pcChildTables	CHARACTER
	a list of the child tables to fill

Top

FilleSmartLinkOfeSmartObjectMaster (character, character, logical)

Purpose:	Fill child tables method for static query
Notes:

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

Top

FilleSmartObjectInstanceOfeSmartObjectMaster (character, character, logical)

Purpose:	Fill child tables method for static query
Notes:

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

Top

FilleSmartPageOfeSmartObjectMaster (character, character, logical)

Purpose:	Fill child tables method for static query
Notes:

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

Top

CHARACTER GetObjectMasterGuidFromInstanceGuid (character)

Purpose:	Returns the Object Master Guid based on an Object Instance GUID
Notes:

Parameters:
pcInstanceGuid	CHARACTER
	The Object Instance Guid
Returns	CHARACTER
	The ObjectMasterGuid value or ?

Top

CHARACTER GetObjectMasterGuidFromObjectName (character)

Purpose:	Returns the ObjectMasterGuid from on ObjectName
Notes:

Parameters:
pcObjectName	CHARACTER
	The Object Name value
Returns	CHARACTER
	The ObjectMasterGuid value or ?

Top

HANDLE InsertToDataSourceQuery (handle, IFetchDataRequest, character)

Purpose:	Creates a new Query to be used as a DATA-SOURCE for a ProDataset
	member buffer
Notes:	Wrapper to the access to the DSQueryString class to simplify overriding
	the query manipulation in a custom Data Access class or customer
	DataAccess base class override
	This Query is prepared based on the Query String that was provided
	(by the consumer) and the Source Default Query of the Data Access object

Parameters:
phBufferHandle	HANDLE
	The Handle of the ProDataset member buffer
poFetchDataRequest	Consultingwerk.OERA.IFetchDataRequest
	The FetchDataRequest object of the current request
pcQueryString	CHARACTER
	The query string provided by the consumer
Returns	HANDLE
	The handle of the Query that was created

Top

MovePage (MovePageParameter)

Purpose:	Moves a page in a container
Notes:

Parameters:
poParameter	Consultingwerk.SmartFramework.Repository.Object.MovePageParameter
	The Parameter Object for this method

Top

ObjectIsA (ObjectIsAParameter)

Purpose:	Returns if the object master is a child of the given class
Notes:

Parameters:
poParameter	Consultingwerk.SmartFramework.Repository.Object.ObjectIsAParameter
	The Parameter Object for this method

Top

SaveRowChanges (handle)

Purpose:	Overridable method that executes SAVE-ROW-CHANGES on the before buffer
Notes:	Called from CommitChanges

Parameters:
phBeforeBuffer	HANDLE
	The handle of the before buffer

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
TO-DO:	Provide code for alternative mapping

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
TO-DO:	Provide code to return the DATA-SOURCE root query string

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

Constructor Detail

Top

ObjectMasterDataAccess (handle)

Purpose:	Constructor for the ObjectMasterDataAccess 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 dsObjectMaster

Member tables: eSmartObjectMaster, eSmartLink, eSmartObjectInstance, eSmartPage

Temp-Table Detail

Temp-Table eSmartLink

Defined in:

Temp-Table eSmartObjectInstance

Defined in:

Temp-Table eSmartObjectMaster

Defined in:

Temp-Table eSmartPage

Defined in:

info@consultingwerk.de http://www.consultingwerk.de 13.04.2026 10:26:48