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

Inherits: Progress.Lang.Object
Inherited by: Consultingwerk.BusinessEntityDesigner.Plugins.TableQueryBuilderGeneratorPlugin Consultingwerk.BusinessEntityDesigner.Server.Plugins.TableQueryBuilderGeneratorServerPlugin
ABSTRACT


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



Top Method Summary
Options Name Purpose
# AfterGenerateSourceHandler (Object, EventArgs) Event handler for the AfterGenerateSource event of the BusinessEntityDatasetController
# LOGICAL CheckDirectoriesExist () Validates that the target folders exists of prompts for create
# CHARACTER CheckTemplatePath (character) Verifies the path to a template file
# CHARACTER FindOutputFolder () Returns the output folder (source code folder for shared code)
# LONGCHAR GenerateConstructors (character) Returns the code for the search constructors
# GenerateFieldEnumQueryPredicate (character, character, character, character, character, character, character, character) Generates a single field query predicate class
# GenerateFieldQueryPredicate (character, character, character, character, character, character) Generates a single field query predicate class
# GenerateQueryClasses () Generates the Query Classes
# GetCustomPropertyNamesHandler (Object, GetCustomPropertyNamesEventArgs) Event handler for the GetCustomPropertyNamesHandler event of the BusinessEntityDatasetController
# GetCustomPropertyValuesHandler (Object, GetCustomPropertyValuesEventArgs) Event handler for the GetCustomPropertyNamesHandler event of the BusinessEntityDatasetController
# LOGICAL IsPluginActive () Returns if the Plugin is active (not disabled)
+ TableQueryBuilderClasses (dataset) Generates the Table Query Builder Classes
# ValidateSearchCodeIndexes () Validates that the indexes flagged with "Default Search Code Generation" do not cause constructors with duplicate signatures

Top Property Summary
Options Name Purpose
+ LOGICAL SilentMode
# CHARACTER SuffixTableQuery


Method Detail
Top

PROTECTED AfterGenerateSourceHandler (Object, EventArgs)
Purpose: Event handler for the AfterGenerateSource event of the
BusinessEntityDatasetController
Notes:

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

PROTECTED LOGICAL CheckDirectoriesExist ()
Purpose: Validates that the target folders exists of prompts for create
Notes:

Returns LOGICAL
Logical value indicating if the folders exists (true) or the generation should be cancelled
Top

PROTECTED CHARACTER CheckTemplatePath (character)
Purpose: Verifies the path to a template file
Notes: Throws an error, when the template file cannot be found

Parameters:
pcFileName CHARACTER
The relative template file name
Returns CHARACTER
The absolute path to the template file
Top

PROTECTED CHARACTER FindOutputFolder ()
Purpose: Returns the output folder (source code folder for shared code)
Notes:

Returns CHARACTER
The output folder
Top

PROTECTED LONGCHAR GenerateConstructors (character)
Purpose: Returns the code for the search constructors
Notes:

Parameters:
pcTempTableName CHARACTER
The name of the current temp-table
Returns LONGCHAR
The source code for the search constructors
Top

PROTECTED GenerateFieldEnumQueryPredicate (character, character, character, character, character, character, character, character)
Purpose: Generates a single field query predicate class
Notes:

Parameters:
pcPackageName CHARACTER
The package for the table query class
pcTableQueryName CHARACTER
The name of the table query class
pcFieldName CHARACTER
The field for which the predicate is generated
pcEnumType CHARACTER
The Data Type of the enum representing the field
pcDataType CHARACTER
The Data Type of the field
pcTemplateFileName CHARACTER
The file name of the template
pcBusinessEntityPackage CHARACTER
The name of the Business Entity Package
pcBusinessEntityName CHARACTER
The name of the Business Entity
Top

PROTECTED GenerateFieldQueryPredicate (character, character, character, character, character, character)
Purpose: Generates a single field query predicate class
Notes:

Parameters:
pcPackageName CHARACTER
The package for the table query class
pcTableQueryName CHARACTER
The name of the table query class
pcDataType CHARACTER
The Data Type used for the class name to generate
pcTemplateFileName CHARACTER
The file name of the template
pcBusinessEntityPackage CHARACTER
The name of the Business Entity Package
pcBusinessEntityName CHARACTER
The name of the Business Entity
Top

PROTECTED GenerateQueryClasses ()
Purpose: Generates the Query Classes
Notes:

Top

PROTECTED GetCustomPropertyNamesHandler (Object, GetCustomPropertyNamesEventArgs)
Purpose: Event handler for the GetCustomPropertyNamesHandler event of the
BusinessEntityDatasetController
Notes:

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

PROTECTED GetCustomPropertyValuesHandler (Object, GetCustomPropertyValuesEventArgs)
Purpose: Event handler for the GetCustomPropertyNamesHandler event of the
BusinessEntityDatasetController
Notes:

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

PROTECTED LOGICAL IsPluginActive ()
Purpose: Returns if the Plugin is active (not disabled)
Notes:

Returns LOGICAL
Logical value indicating if the Plugin is active (not disabled)
Top

PUBLIC TableQueryBuilderClasses (dataset)
Purpose: Generates the Table Query Builder Classes
Notes: This routine is intended to be used from outside of the Business Entity
designer (automatic source code generation, unit testing)

Parameters:
dsBusinessEntity DATASET dsBusinessEntity
Business Entity with the Design dataset, called with the BY-REFERENCE keyword
Top

PROTECTED ValidateSearchCodeIndexes ()
Purpose: Validates that the indexes flagged with "Default Search Code Generation"
do not cause constructors with duplicate signatures
Notes:



Property Detail
Top

PUBLIC LOGICAL SilentMode

Returns LOGICAL
Top

PROTECTED CHARACTER SuffixTableQuery

Returns CHARACTER


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-2025 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       24.10.2025 08:25:37