Namespace: Consultingwerk.OERA
Interface 
IBufferDataSource Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implemented by: Consultingwerk.OERA.BufferDataSource, Consultingwerk.SmartUnit.OERA.MockBufferDataSource.MockBufferDataSource

File:IBufferSpec
Purpose:Interface for classes encapsulating a dynamic
data-source handle
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Wed Jun 15 20:36:55 CEST 2016
Notes:See http://confluence.consultingwerkcloud.com/wiki/display/SCL/New+API+for+dynamic+DATA-SOURCE+objects

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



Top Method Summary
Options Name Purpose
+ LOGICAL AttachDataSource (handle) Attaches the Data-Source to the ProDataset buffer object handle
+ LOGICAL AttachDataSource (handle, character) Returns the handle of the data-source object
+ Initialize () Initializes the DATA-SOURCE object handle and supporting objects
+ CHARACTER SourceColumn (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 () Returns the default query string (USING OF) that can be used for the SourceDefaultQuery method of the DataAccess class

Top Property Summary
Options Name Purpose
+ HANDLE DataSourceHandle
+ LOGICAL Initialized


Method Detail
Top

PUBLIC LOGICAL AttachDataSource (handle)
Purpose: Attaches the Data-Source to the ProDataset buffer object handle
Notes:

Parameters:
phProDatasetBuffer HANDLE
The handle of the ProDataset buffer
Returns LOGICAL
Logical return value of the ATTACH-DATA-SOURCE method
Top

PUBLIC LOGICAL AttachDataSource (handle, character)
Purpose: Returns the handle of the data-source object
Notes: The implementation is required to remove and white space characters
from pcPairsList that might have been inserted to improve readability
but are not supported by the DATA-SOURCE

Parameters:
phProDatasetBuffer HANDLE
The handle of the ProDataset buffer
pcPairsList CHARACTER
pairs-list An optional character expression that evaluates to a comma-delimited list of field name pairs that specify a mapping between different field names in the data-source object buffer and the ProDataSet temp-table buffer
Returns LOGICAL
Logical return value of the ATTACH-DATA-SOURCE method
Top

PUBLIC Initialize ()
Purpose: Initializes the DATA-SOURCE object handle and supporting objects
Notes:

Top

PUBLIC CHARACTER SourceColumn (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: To be used in the DataAccess:SourceColumn method

Parameters:
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

PUBLIC CHARACTER SourceDefaultQuery ()
Purpose: Returns the default query string (USING OF) that can be used for the
SourceDefaultQuery method of the DataAccess class
Notes: Can not be used, when the buffers cannot be joined using OF

Returns CHARACTER
The query string for the source default query


Property Detail
Top

PUBLIC HANDLE DataSourceHandle

Returns HANDLE
Top

PUBLIC LOGICAL Initialized

Returns LOGICAL


©2006-2019 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.08.2019 23:28:42