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

Inherits: Progress.Lang.Object
Inherited by: Consultingwerk.BusinessEntityDesigner.Plugins.ModelClassGeneratorPlugin Consultingwerk.BusinessEntityDesigner.Server.Plugins.ModelClassGeneratorServerPlugin
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
A Consultingwerk.Framework.Enum.DialogResultEnum AskQuestion (character, character, character) Ask a question
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 business logic)
LONGCHAR GenerateConstructors (character) Returns the code for the search constructors
GenerateModelClasses () Generates the Model Classes
GenerateModelClasses (dataset) Generates the Model Classes
GenerateModelClasses (dataset, GenerateModelClassesEnum) Generates the Model Classes
GenerateModelClasses (dataset, GenerateModelClassesEnum, character, character) Generates the Model Classes
GenerateModelClasses (GenerateModelClassesEnum) Generates the Model Classes
GenerateModelClasses (GenerateModelClassesEnum, character, character) Generates the Model Classes
GenerateModelInterfaces (GenerateModelClassesEnum) Generates Interfaces for the Model Classes
GenerateModelInterfaces (GenerateModelClassesEnum, character, character) Generates Interfaces for the Model Classes
LONGCHAR GenerateModelMethods () Generates methods for the datasetmodel_generated class
LONGCHAR GenerateNewFilterMethods () Generates the source code for the NewFilter methods
LONGCHAR GenerateNewFilterMethodsForStaticQueries () Generates the source code for the NewFilter methods
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)
OnGetDatasetModelMembers (GetDatasetModelMembersEventArgs) Raises the GetDatasetModelMembers
OnGetTableModelMembers (GetTableModelMembersEventArgs) Raises the GetTableModelMembers
A ShowWarningMessage (character, character) Shows a warning message
UpdateBusinessEntityAnnotations () Updates the Annotations @DatasetModel and @TableModel Annotations
UpdateSearchConstructors (character, character) Updates the search constructors in an existing dataset model class
ValidateDesignHandler (CancelableEventArgs) Event handler for the ValidateDesign event of the BusinessEntityGenerator
ValidateSearchCodeIndexes () Validates that the indexes flagged with "Default Search Code Generation" do not cause constructors with duplicate signatures

Top Event Summary
Options Name Purpose
GetDatasetModelMembers (Object, GetDatasetModelMembersEventArgs) Raised when generating properties/methods for the TableModel_Generated
GetTableModelMembers (Object, GetTableModelMembersEventArgs) Raised when generating properties/methods for the TableModel_Generated

Top Property Summary
Options Name Purpose
LOGICAL IsStaticDataAccessQueryActive
LOGICAL IsTableQueryBuilderActive
Consultingwerk.BusinessEntityDesigner.Common.IBusinessEntityDesignerPluginManager PluginManager
LOGICAL SilentMode
CHARACTER SuffixDatasetModel
CHARACTER SuffixTableModel
CHARACTER SuffixTableModelFilter
CHARACTER SuffixTableModelSort


Method Detail
Top

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

Consultingwerk.Framework.Enum.DialogResultEnum AskQuestion (character, character, character)
Purpose: Ask a question
Notes: Uses the message dialog API in a simplified way

Parameters:
pcMessage CHARACTER
The question text to display
pcMessageTitle CHARACTER
The Title of the message/question dialog
pcMessageDetail CHARACTER
The Details of the message/question that can be expanded by the user if needed
Returns Consultingwerk.Framework.Enum.DialogResultEnum
The DialogResultEnum matching the response of the user
Top

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

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

CHARACTER FindOutputFolder ()
Purpose: Returns the output folder (source code folder for business logic)
Notes:

Returns CHARACTER
The output folder
Top

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

Parameters:
pcClassName CHARACTER
The name of the class
Returns LONGCHAR
The source code for the search constructors
Top

GenerateModelClasses ()
Purpose: Generates the Model Classes
Notes:

Top

GenerateModelClasses (dataset)
Purpose: Generates the Model 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

GenerateModelClasses (dataset, GenerateModelClassesEnum)
Purpose: Generates the Model 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
poGenerate Consultingwerk.BusinessEntityDesigner.Plugins.GenerateModelClassesEnum
The GenerateModelClassesEnum value indicating if the generator will generate classes, Interfaces or Read-Only Interfaces
Top

GenerateModelClasses (dataset, GenerateModelClassesEnum, character, character)
Purpose: Generates the Model 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
poGenerate Consultingwerk.BusinessEntityDesigner.Plugins.GenerateModelClassesEnum
The GenerateModelClassesEnum value indicating if the generator will generate classes, Interfaces or Read-Only Interfaces
pcPackageName CHARACTER
The name of the DatasetModel package, ? to build based on TableModel package
pcClassName CHARACTER
The name of the DatasetModel class, ? to build based on Dataset Name
Top

GenerateModelClasses (GenerateModelClassesEnum)
Purpose: Generates the Model Classes
Notes:

Parameters:
poGenerate Consultingwerk.BusinessEntityDesigner.Plugins.GenerateModelClassesEnum
The GenerateModelClassesEnum value indicating if the generator will generate classes, Interfaces or Read-Only Interfaces
Top

GenerateModelClasses (GenerateModelClassesEnum, character, character)
Purpose: Generates the Model Classes
Notes:

Parameters:
poGenerate Consultingwerk.BusinessEntityDesigner.Plugins.GenerateModelClassesEnum
The GenerateModelClassesEnum value indicating if the generator will generate classes, Interfaces or Read-Only Interfaces
pcPackageName CHARACTER
The name of the DatasetModel package, ? to build based on TableModel package
pcClassName CHARACTER
The name of the DatasetModel class, ? to build based on Dataset Name
Top

GenerateModelInterfaces (GenerateModelClassesEnum)
Purpose: Generates Interfaces for the Model Classes
Notes:

Parameters:
poGenerate Consultingwerk.BusinessEntityDesigner.Plugins.GenerateModelClassesEnum
The GenerateModelClassesEnum value indicating if the generator will generate classes, Interfaces or Read-Only Interfaces
Top

GenerateModelInterfaces (GenerateModelClassesEnum, character, character)
Purpose: Generates Interfaces for the Model Classes
Notes:

Parameters:
poGenerate Consultingwerk.BusinessEntityDesigner.Plugins.GenerateModelClassesEnum
The GenerateModelClassesEnum value indicating if the generator will generate classes, Interfaces or Read-Only Interfaces
pcPackageName CHARACTER
The name of the DatasetModel package, ? to build based on TableModel package
pcClassName CHARACTER
The name of the DatasetModel class, ? to build based on Dataset Name
Top

LONGCHAR GenerateModelMethods ()
Purpose: Generates methods for the datasetmodel_generated class
Notes:

Returns LONGCHAR
The source code of the generated methods
Top

LONGCHAR GenerateNewFilterMethods ()
Purpose: Generates the source code for the NewFilter methods
Notes:

Returns LONGCHAR
The source code for the NewFilter methods
Top

LONGCHAR GenerateNewFilterMethodsForStaticQueries ()
Purpose: Generates the source code for the NewFilter methods
Notes:

Returns LONGCHAR
The source code for the NewFilter methods
Top

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

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

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

OnGetDatasetModelMembers (GetDatasetModelMembersEventArgs)
Purpose: Raises the GetDatasetModelMembers
Notes:

Parameters:
e Consultingwerk.BusinessEntityDesigner.Plugins.ModelClassGenerator.GetDatasetModelMembersEventArgs
The GetDatasetModelMembersEventArgs with the data for the event
Top

OnGetTableModelMembers (GetTableModelMembersEventArgs)
Purpose: Raises the GetTableModelMembers
Notes:

Parameters:
e Consultingwerk.BusinessEntityDesigner.Plugins.ModelClassGenerator.GetTableModelMembersEventArgs
The GetTableModelMembersEventArgs with the data for the event
Top

ShowWarningMessage (character, character)
Purpose: Shows a warning message
Notes:

Parameters:
pcMessageText CHARACTER
The warning text
pcMessageTitle CHARACTER
The warning title
Top

UpdateBusinessEntityAnnotations ()
Purpose: Updates the Annotations @DatasetModel and @TableModel Annotations
Notes:

Top

UpdateSearchConstructors (character, character)
Purpose: Updates the search constructors in an existing dataset model class
Notes:

Parameters:
pcClassName CHARACTER
The name of the class
pcFileName CHARACTER
The file name of the dataset model class
Top

ValidateDesignHandler (CancelableEventArgs)
Purpose: Event handler for the ValidateDesign event of the
BusinessEntityGenerator
Notes:

Parameters:
e Consultingwerk.CancelableEventArgs
The CancelableEventArgs with the data for this event
Top

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



Event Detail
Top

GetDatasetModelMembers (Object, GetDatasetModelMembersEventArgs)
Purpose: Raised when generating properties/methods for the TableModel_Generated
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the GetDatasetModelMembers event
e Consultingwerk.BusinessEntityDesigner.Plugins.ModelClassGenerator.GetDatasetModelMembersEventArgs
The GetDatasetModelMembersEventArgs with the data for the event
Top

GetTableModelMembers (Object, GetTableModelMembersEventArgs)
Purpose: Raised when generating properties/methods for the TableModel_Generated
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the GetTableModelMembers event
e Consultingwerk.BusinessEntityDesigner.Plugins.ModelClassGenerator.GetTableModelMembersEventArgs
The GetTableModelMembersEventArgs with the data for the event


Property Detail
Top

LOGICAL IsStaticDataAccessQueryActive

Returns LOGICAL
Top

LOGICAL IsTableQueryBuilderActive

Returns LOGICAL
Top

Consultingwerk.BusinessEntityDesigner.Common.IBusinessEntityDesignerPluginManager PluginManager

Returns Consultingwerk.BusinessEntityDesigner.Common.IBusinessEntityDesignerPluginManager
Top

LOGICAL SilentMode

Returns LOGICAL
Top

CHARACTER SuffixDatasetModel

Returns CHARACTER
Top

CHARACTER SuffixTableModel

Returns CHARACTER
Top

CHARACTER SuffixTableModelFilter

Returns CHARACTER
Top

CHARACTER SuffixTableModelSort

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-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       13.04.2026 10:20:16