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

Inherits: Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
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.AbstractModelClassGeneratorPlugin
+ Consultingwerk.Framework.Enum.DialogResultEnum AskQuestion (character, character, character) Ask a question
Overrides Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin:AskQuestion (character, character, character)
# LOGICAL CheckDirectoriesExist () Validates that the target folders exists of prompts for create
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
# CHARACTER CheckTemplatePath (character) Verifies the path to a template file
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
# CHARACTER FindOutputFolder () Returns the output folder (source code folder for business logic)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
# LONGCHAR GenerateConstructors (character) Returns the code for the search constructors
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
# GenerateModelClasses () Generates the Model Classes
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
+ GenerateModelClasses (dataset) Generates the Model Classes
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
+ GenerateModelClasses (dataset, GenerateModelClassesEnum) Generates the Model Classes
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
+ GenerateModelClasses (dataset, GenerateModelClassesEnum, character, character) Generates the Model Classes
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
# GenerateModelClasses (GenerateModelClassesEnum) Generates the Model Classes
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
# GenerateModelClasses (GenerateModelClassesEnum, character, character) Generates the Model Classes
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
# GenerateModelInterfaces (GenerateModelClassesEnum) Generates Interfaces for the Model Classes
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
# GenerateModelInterfaces (GenerateModelClassesEnum, character, character) Generates Interfaces for the Model Classes
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
# LONGCHAR GenerateModelMethods () Generates methods for the datasetmodel_generated class
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
# LONGCHAR GenerateNewFilterMethods () Generates the source code for the NewFilter methods
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
# GetCustomPropertyNamesHandler (Object, GetCustomPropertyNamesEventArgs) Event handler for the GetCustomPropertyNamesHandler event of the BusinessEntityDatasetController
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
# GetCustomPropertyValuesHandler (Object, GetCustomPropertyValuesEventArgs) Event handler for the GetCustomPropertyNamesHandler event of the BusinessEntityDatasetController
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
# LOGICAL IsPluginActive () Returns if the Plugin is active (not disabled)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
# OnGetDatasetModelMembers (GetDatasetModelMembersEventArgs) Raises the GetDatasetModelMembers
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
# OnGetTableModelMembers (GetTableModelMembersEventArgs) Raises the GetTableModelMembers
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
# ShowWarningMessage (character, character) Shows a warning message
Overrides Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin:ShowWarningMessage (character, character)
+ 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.
# UpdateBusinessEntityAnnotations () Updates the Annotations @DatasetModel and @TableModel Annotations
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
# UpdateSearchConstructors (character, character) Updates the search constructors in an existing dataset model class
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
# ValidateSearchCodeIndexes () Validates that the indexes flagged with "Default Search Code Generation" do not cause constructors with duplicate signatures
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin

Top Event Summary
Options Name Purpose
+ GetDatasetModelMembers (Object, GetDatasetModelMembersEventArgs) Raised when generating properties/methods for the TableModel_Generated
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
+ GetTableModelMembers (Object, GetTableModelMembersEventArgs) Raised when generating properties/methods for the TableModel_Generated
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin

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


Method Detail
Top

PROTECTED AfterGenerateSourceHandler (Object, EventArgs)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
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

PUBLIC Consultingwerk.Framework.Enum.DialogResultEnum AskQuestion (character, character, character)
Overrides Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin: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

PROTECTED LOGICAL CheckDirectoriesExist ()
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
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.AbstractModelClassGeneratorPlugin
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.AbstractModelClassGeneratorPlugin
Purpose: Returns the output folder (source code folder for business logic)
Notes:

Returns CHARACTER
The output folder
Top

PROTECTED LONGCHAR GenerateConstructors (character)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
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

PROTECTED GenerateModelClasses ()
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
Purpose: Generates the Model Classes
Notes:

Top

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

PUBLIC GenerateModelClasses (dataset, GenerateModelClassesEnum)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
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 GenerateModelClassesEnum
The GenerateModelClassesEnum value indicating if the generator will generate classes, Interfaces or Read-Only Interfaces
Top

PUBLIC GenerateModelClasses (dataset, GenerateModelClassesEnum, character, character)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
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 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

PROTECTED GenerateModelClasses (GenerateModelClassesEnum)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
Purpose: Generates the Model Classes
Notes:

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

PROTECTED GenerateModelClasses (GenerateModelClassesEnum, character, character)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
Purpose: Generates the Model Classes
Notes:

Parameters:
poGenerate 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

PROTECTED GenerateModelInterfaces (GenerateModelClassesEnum)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
Purpose: Generates Interfaces for the Model Classes
Notes:

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

PROTECTED GenerateModelInterfaces (GenerateModelClassesEnum, character, character)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
Purpose: Generates Interfaces for the Model Classes
Notes:

Parameters:
poGenerate 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

PROTECTED LONGCHAR GenerateModelMethods ()
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
Purpose: Generates methods for the datasetmodel_generated class
Notes:

Returns LONGCHAR
The source code of the generated methods
Top

PROTECTED LONGCHAR GenerateNewFilterMethods ()
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
Purpose: Generates the source code for the NewFilter methods
Notes:

Returns LONGCHAR
The source code for the NewFilter methods
Top

PROTECTED GetCustomPropertyNamesHandler (Object, GetCustomPropertyNamesEventArgs)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
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.AbstractModelClassGeneratorPlugin
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.AbstractModelClassGeneratorPlugin
Purpose: Returns if the Plugin is active (not disabled)
Notes:

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

PROTECTED OnGetDatasetModelMembers (GetDatasetModelMembersEventArgs)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
Purpose: Raises the GetDatasetModelMembers
Notes:

Parameters:
e GetDatasetModelMembersEventArgs
The GetDatasetModelMembersEventArgs with the data for the event
Top

PROTECTED OnGetTableModelMembers (GetTableModelMembersEventArgs)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
Purpose: Raises the GetTableModelMembers
Notes:

Parameters:
e GetTableModelMembersEventArgs
The GetTableModelMembersEventArgs with the data for the event
Top

PROTECTED ShowWarningMessage (character, character)
Overrides Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin:ShowWarningMessage (character, character)
Purpose: Shows a warning message
Notes:

Parameters:
pcMessageText CHARACTER
The warning text
pcMessageTitle CHARACTER
The warning title
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

PROTECTED UpdateBusinessEntityAnnotations ()
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
Purpose: Updates the Annotations @DatasetModel and @TableModel Annotations
Notes:

Top

PROTECTED UpdateSearchConstructors (character, character)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
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

PROTECTED ValidateSearchCodeIndexes ()
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
Purpose: Validates that the indexes flagged with "Default Search Code Generation"
do not cause constructors with duplicate signatures
Notes:



Event Detail
Top

PUBLIC GetDatasetModelMembers (Object, GetDatasetModelMembersEventArgs)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
Purpose: Raised when generating properties/methods for the TableModel_Generated
Notes:

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

PUBLIC GetTableModelMembers (Object, GetTableModelMembersEventArgs)
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
Purpose: Raised when generating properties/methods for the TableModel_Generated
Notes:

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


Property Detail
Top

PUBLIC LOGICAL IsStaticDataAccessQueryActive
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin

Returns LOGICAL
Top

PUBLIC LOGICAL IsTableQueryBuilderActive
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin

Returns LOGICAL
Top

PUBLIC Consultingwerk.BusinessEntityDesigner.Common.IBusinessEntityDesignerPluginManager PluginManager
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin

Returns Consultingwerk.BusinessEntityDesigner.Common.IBusinessEntityDesignerPluginManager
Top

PUBLIC LOGICAL SilentMode
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin

Returns LOGICAL
Top

PUBLIC CHARACTER SuffixDatasetModel
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin

Returns CHARACTER
Top

PUBLIC CHARACTER SuffixTableModel
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin

Returns CHARACTER
Top

PUBLIC CHARACTER SuffixTableModelFilter
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin

Returns CHARACTER
Top

PUBLIC CHARACTER SuffixTableModelSort
Inherited from Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin

Returns CHARACTER


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