Namespace: Consultingwerk.SmartComponents.Interfaces
Interface 
ISmartDataSource Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implemented by: Consultingwerk.SmartComponents.Base.SmartDataAdapter, Consultingwerk.SmartComponents.Base.SmartDatasetAdapter, Consultingwerk.SmartComponents.Implementation.SmartBusinessEntityAdapter, Consultingwerk.SmartComponents.Implementation.SmartDataObjectAdapter, Consultingwerk.SmartComponents.Implementation.SmartDatasetChildAdapter, Consultingwerk.SmartComponents.Implementation.SmartTempTableAdapter, Consultingwerk.SmartComponents.Tools.OERABusinessEntityTester.SmartBusinessEntityAdapterTester

File:ISmartDataSource
Purpose:Interface for components providing data to other components
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sat Jan 17 17:02:07 CET 2009
Purpose: Event fired whenever the QueryPosition has changed (i.e. Add or
Delete and Grids etc. need to update the current position)
Notes:

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



Top Method Summary
Options Name Purpose
+ BeginUpdateState (ISmartDataTarget) The Message to for instance Disable a Browser is send to all SmartDataTargets except the calling one
+ CancelCreateRecord () Invoked from the SmartDataTarget to cancel the creation of a new row
+ CreateRecord () Invoked from the SmartDataTarget to create a new row row
+ DeleteRow () The DeleteRow is an abstract method - that means that it needs to be overridden in a class that inherits from this base class.
+ DeregisterSmartDataTarget (ISmartDataTarget) Deregister a SmartDataTarget with the SmartDataSource. Usually done when a SmartDataTarget is deleted and the SmartDataSource is still running
+ EndUpdateState (ISmartDataTarget) The Message to for instance enable a Browser is send to all SmartDataTargets except the calling one.
+ CHARACTER GetFieldValues (character) Returns a CHR(1) delimited list of field values from the DataSource
+ RegisterSmartDataTarget (ISmartDataTarget) Register a SmartDataTarget with the SmartDataSource. This Method is called by Classes implementing the ISmartDataTarget Interface when a new SmartDataSource is set.
+ LOGICAL RetrieveData () RetrieveData is an abstract method - that means that it needs to be overridden in a class that inherits from the base class.
+ UpdateRow () The UpdateRow is an abstract method - that means that it needs to be overridden in a class that inherits from this base class.

Top Event Summary
Options Name Purpose
+ AfterQueryPositionChanged DELEGATE System.EventHandler Event fired whenever the QueryPosition has changed (i.e. Add or Delete and Grids etc. need to update the current position)
+ BeginUpdateState (Object, DataSourceUpdateStateEventArgs) Event fired when a DataTarget of this SmartDataSource enters Update State
+ BindingSourceChanged (Object, BindingSourceChangedEventArgs) Event fired whenever the SmartDataAdapters BindingSource property changes
+ CurrentChanged DELEGATE System.EventHandler Raised whenever the Data Adapter is positioned on a new row.
+ EndUpdateState (Object, DataSourceUpdateStateEventArgs) Event fired when a DataTarget of this SmartDataSource leaves Update State

Top Property Summary
Options Name Purpose
+ LOGICAL Available
+ Progress.Data.BindingSource BindingSource
+ CHARACTER SmartDataSourceState


Method Detail
Top

PUBLIC BeginUpdateState (ISmartDataTarget)
Purpose: The Message to for instance Disable a Browser is send to all
SmartDataTargets except the calling one
Notes: This Method is called from the SmartViewerControl derived Class when
starting to Modify or Add data.
Enforced by Interface ISmartDataSource.

Parameters:
poSmartDataTarget Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget
The reference to the ISmartDataTarget which is in UpdateState now
Top

PUBLIC CancelCreateRecord ()
Purpose: Invoked from the SmartDataTarget to cancel the creation of a new
row
Notes:

Top

PUBLIC CreateRecord ()
Purpose: Invoked from the SmartDataTarget to create a new row row
Notes:

Top

PUBLIC DeleteRow ()
Purpose: The DeleteRow is an abstract method - that means that it needs
to be overridden in a class that inherits from this base class.
Notes: Do NOT call SUPER:DeleteRow() in the overriding method.

Top

PUBLIC DeregisterSmartDataTarget (ISmartDataTarget)
Purpose: Deregister a SmartDataTarget with the SmartDataSource. Usually done
when a SmartDataTarget is deleted and the SmartDataSource is still
running
Notes:

Parameters:
poSmartDataTarget Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget
The reference to the ISmartDataTarget to deregister
Top

PUBLIC EndUpdateState (ISmartDataTarget)
Purpose: The Message to for instance enable a Browser is send to all
SmartDataTargets except the calling one.
Notes: This Method is called from the SmartViewerControl derived Class when
starting to Modify or Add data.
Enforced by Interface ISmartDataSource.

Parameters:
poSmartDataTarget Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget
The reference to the ISmartDataTarget that ends the UpdateState
Top

PUBLIC CHARACTER GetFieldValues (character)
Purpose: Returns a CHR(1) delimited list of field values from the
DataSource
Notes:

Parameters:
pcFields CHARACTER
The comma delimited list of fields to return
Returns CHARACTER
The CHR(1) delimited list of field values
Top

PUBLIC RegisterSmartDataTarget (ISmartDataTarget)
Purpose: Register a SmartDataTarget with the SmartDataSource.
This Method is called by Classes implementing the ISmartDataTarget
Interface when a new SmartDataSource is set.
Notes: After a new SmartDataTargetCollection Row is created this routine
tests if there is a valid BindingSource inside the new SmartDataTarget.
If there is one, the BindingSource of the SmartDataAdapter is disposed
and replaced by the one of the SmartDataTarget. A new BindingSource is
then populated to all SmartDataTargets of this SmartDataAdapter.

Parameters:
poSmartDataTarget Consultingwerk.SmartComponents.Interfaces.ISmartDataTarget
The reference to the ISmartDataTarget to add to this SmartDataAdapter
Top

PUBLIC LOGICAL RetrieveData ()
Purpose: RetrieveData is an abstract method - that means that it needs
to be overridden in a class that inherits from the base class.
Notes: Do NOT call SUPER:RetrieveData() in the overriding method.
Remember to test if a BindingSource exists. If not call
CreateBindingSource from the base class.

Returns LOGICAL
Logical value indicating the success of the method, not always used
Top

PUBLIC UpdateRow ()
Purpose: The UpdateRow is an abstract method - that means that it needs
to be overridden in a class that inherits from this base class.
Notes: Do NOT call SUPER:UpdateRow() in the overriding method.



Event Detail
Top

PUBLIC AfterQueryPositionChanged DELEGATE System.EventHandler
Purpose: Event fired whenever the QueryPosition has changed (i.e. Add or
Delete and Grids etc. need to update the current position)
Notes:

Delegate: System.EventHandler
Top

PUBLIC BeginUpdateState (Object, DataSourceUpdateStateEventArgs)
Purpose: Event fired when a DataTarget of this SmartDataSource enters
Update State
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e Consultingwerk.SmartComponents.Implementation.DataSourceUpdateStateEventArgs
The DataSourceUpdateStateEventArgs instance with the data for this event
Top

PUBLIC BindingSourceChanged (Object, BindingSourceChangedEventArgs)
Purpose: Event fired whenever the SmartDataAdapters BindingSource property
changes
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e Consultingwerk.SmartComponents.Base.BindingSourceChangedEventArgs
The BindingSourceChangedEventArgs instance with the data for this event
Top

PUBLIC CurrentChanged DELEGATE System.EventHandler
Purpose: Raised whenever the Data Adapter is positioned on a new row.
Notes: The event is raised, when the BindingSource PositionChanged event
is raised, when the ParentPosition has changed and the Query is closed
etc.

Delegate: System.EventHandler
Top

PUBLIC EndUpdateState (Object, DataSourceUpdateStateEventArgs)
Purpose: Event fired when a DataTarget of this SmartDataSource leaves
Update State
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e Consultingwerk.SmartComponents.Implementation.DataSourceUpdateStateEventArgs
The DataSourceUpdateStateEventArgs instance with the data for this event


Property Detail
Top

PUBLIC LOGICAL Available

Returns LOGICAL
Top

PUBLIC Progress.Data.BindingSource BindingSource

Returns Progress.Data.BindingSource
Top

PUBLIC CHARACTER SmartDataSourceState

Returns CHARACTER


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.12.2024 13:02:29