Namespace: Consultingwerk.BusinessEntityDesigner.Plugins
Class 
DataRelationAdvisorPlugin Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.BusinessEntityDesigner.Plugins.DataRelationAdvisorPlugin

Inherits: Progress.Lang.Object
Implements: Consultingwerk.BusinessEntityDesigner.IBusinessEntityDesignerPlugin


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



Top Method Summary
Options Name Purpose
CollectSourceIndexes () Collects the indexes of the source database tables of all temp-tables of the design in the ttDataRelationSourceIndex temp-table
LOGICAL ConfirmSingleCandidate (character) Asks the developer if the single data-relation candidate should be added to the design
INTEGER CountCandidates () Returns the number of data-relation candidates
CreateDataRelation (character, character, character) Creates the data-relation between the two temp-tables
Shutdown () Method called when the Business Entity Designer will get closed
Startup (dataset, BusinessEntityDatasetController, BusinessEntityDesignerForm, UltraToolbarsManager) Method called when the Business Entity Designer is starting and has loaded the plugin.
TempTableAddedToDesignHandler (Object, TempTableAddedToDesignEventArgs) Event handler for the TempTableAddedToDesign event of the BusinessEntityDatasetController


Method Detail
Top

CollectSourceIndexes ()
Purpose: Collects the indexes of the source database tables of all
temp-tables of the design in the ttDataRelationSourceIndex
temp-table
Notes: The index selection (IndexSelectionPlugin) typically keeps only
a few of the database indexes in the temp-table design, so the
detection would miss a matching index that is not part of the
temp-table - e.g. the CustOrder index of the Order table when
only the OrderNum index was added to eOrder.
Only the first source table of a temp-table is considered, and
the field names are the DATABASE field names - the candidate
service maps them to the temp-table field names

Top

LOGICAL ConfirmSingleCandidate (character)
Purpose: Asks the developer if the single data-relation candidate should
be added to the design
Notes:

Parameters:
pcChildTempTableName CHARACTER
The name of the temp-table that has been added to the design
Returns LOGICAL
Logical value indicating if the data-relation should be created
Top

INTEGER CountCandidates ()
Purpose: Returns the number of data-relation candidates
Notes:

Returns INTEGER
The number of records in the ttDataRelationCandidate temp-table
Top

CreateDataRelation (character, character, character)
Purpose: Creates the data-relation between the two temp-tables
Notes: The relation is created through the BusinessEntityDatasetController,
so that the relation naming, the IDataRelationCustomizer service and
the connector on the design canvas are handled as if the developer
had dragged the relation. The relation fields determined by the
advisor win over the ones assigned by the IDataRelationFieldsService

Parameters:
pcParentTempTableName CHARACTER
The name of the source (parent) temp-table
pcChildTempTableName CHARACTER
The name of the child temp-table
pcRelationFields CHARACTER
The relation fields that have been presented to the developer
Top

Shutdown ()
Purpose: Method called when the Business Entity Designer will get closed
Notes:

Top

Startup (dataset, BusinessEntityDatasetController, BusinessEntityDesignerForm, UltraToolbarsManager)
Purpose: Method called when the Business Entity Designer is starting and
has loaded the plugin.
Notes: Passes references to some key components of the Designer to
the plugin, use this to initialize the plugin, subscribe to events

Parameters:
dsBusinessEntity DATASET dsBusinessEntity
Business Entity with the Design dataset, called with the BIND keyword
poController Consultingwerk.BusinessEntityDesigner.UI.BusinessEntityDatasetController
The BusinessEntityDatasetController
poForm Consultingwerk.BusinessEntityDesigner.UI.BusinessEntityDesignerForm
The main Form of the BusinessEntityDesigner
poToolbar Infragistics.Win.UltraWinToolbars.UltraToolbarsManager
The reference to the UltraToolbarsManager used by the BusinessEntityDesigner
Top

TempTableAddedToDesignHandler (Object, TempTableAddedToDesignEventArgs)
Purpose: Event handler for the TempTableAddedToDesign event of the
BusinessEntityDatasetController
Notes: Detects the possible data-relations for the new temp-table and
creates the data-relation the developer has confirmed. The new
temp-table stays part of the design in every case

Parameters:
sender Progress.Lang.Object
The reference to the object that raised the event
e Consultingwerk.BusinessEntityDesigner.Services.TempTableAddedToDesignEventArgs
The TempTableAddedToDesignEventArgs with the data for this event


ProDataset Detail

ProDataset dsBusinessEntity

Member tables: eBusinessEntity, eDataRelation, eDataRelationProperties, eTable, eField, eFieldProperties, eIndex, eIndexProperties, eTableProperties, eBusinessEntityProperties


Temp-Table Detail

Temp-Table eBusinessEntity

Defined in:

Temp-Table eBusinessEntityProperties

Defined in:

Temp-Table eDataRelation

Defined in:

Temp-Table eDataRelationProperties

Defined in:

Temp-Table eField

Defined in:

Temp-Table eFieldProperties

Defined in:

Temp-Table eIndex

Defined in:

Temp-Table eIndexProperties

Defined in:

Temp-Table eTable

Defined in:

Temp-Table eTableProperties

Defined in:


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       16.08.2026 16:54:53