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

Inherits: Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
Implements: Consultingwerk.BusinessEntityDesigner.Server.Plugins.IBusinessEntityDesignerServerPlugin


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
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
# LOGICAL CheckDirectoriesExist () Validates that the target folders exists of prompts for create
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
# CHARACTER CheckTemplatePath (character) Verifies the path to a template file
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
# CHARACTER FindOutputFolder () Returns the output folder (source code folder for shared code)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
# LONGCHAR GenerateConstructors (character) Returns the code for the search constructors
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
# GenerateFieldEnumQueryPredicate (character, character, character, character, character, character, character, character) Generates a single field query predicate class
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
# GenerateFieldQueryPredicate (character, character, character, character, character, character) Generates a single field query predicate class
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
# GenerateQueryClasses () Generates the Query Classes
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
# GetCustomPropertyNamesHandler (Object, GetCustomPropertyNamesEventArgs) Event handler for the GetCustomPropertyNamesHandler event of the BusinessEntityDatasetController
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
# GetCustomPropertyValuesHandler (Object, GetCustomPropertyValuesEventArgs) Event handler for the GetCustomPropertyNamesHandler event of the BusinessEntityDatasetController
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
# LOGICAL IsPluginActive () Returns if the Plugin is active (not disabled)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
+ Shutdown () Method called when the Business Entity Designer will get closed
+ Startup (dataset, IBusinessEntityDatasetController, IBusinessEntityDesignerPluginManager) Method called when the Business Entity Designer is starting and has loaded the plugin.
+ TableQueryBuilderClasses (dataset) Generates the Table Query Builder Classes
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
# ValidateSearchCodeIndexes () Validates that the indexes flagged with "Default Search Code Generation" do not cause constructors with duplicate signatures
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin

Top Property Summary
Options Name Purpose
+ LOGICAL SilentMode
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
# CHARACTER SuffixTableQuery
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin


Method Detail
Top

PROTECTED AfterGenerateSourceHandler (Object, EventArgs)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
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 ()
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
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)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
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 ()
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
Purpose: Returns the output folder (source code folder for shared code)
Notes:

Returns CHARACTER
The output folder
Top

PROTECTED LONGCHAR GenerateConstructors (character)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
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)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
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)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
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 ()
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
Purpose: Generates the Query Classes
Notes:

Top

PROTECTED GetCustomPropertyNamesHandler (Object, GetCustomPropertyNamesEventArgs)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
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 GetCustomPropertyNamesEventArgs
The GetCustomPropertyNamesEventArgs with the data for this event
Top

PROTECTED GetCustomPropertyValuesHandler (Object, GetCustomPropertyValuesEventArgs)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
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 GetCustomPropertyValuesEventArgs
The GetCustomPropertyNamesEventArgs with the data for this event
Top

PROTECTED LOGICAL IsPluginActive ()
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
Purpose: Returns if the Plugin is active (not disabled)
Notes:

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

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

Top

PUBLIC Startup (dataset, IBusinessEntityDatasetController, IBusinessEntityDesignerPluginManager)
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.Common.IBusinessEntityDatasetController
The BusinessEntityDatasetController
poPluginManager Consultingwerk.BusinessEntityDesigner.Common.IBusinessEntityDesignerPluginManager
The reference to the Plugin Manager
Top

PUBLIC TableQueryBuilderClasses (dataset)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
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 ()
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin
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
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin

Returns LOGICAL
Top

PROTECTED CHARACTER SuffixTableQuery
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin

Returns CHARACTER


©2006-2025 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       16.09.2025 09:10:30