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

Inherits: Progress.Lang.Object
Inherited by: Consultingwerk.BusinessEntityDesigner.Plugins.ImplementsInterfacesPlugin Consultingwerk.BusinessEntityDesigner.Server.Plugins.ImplementsInterfacesServerPlugin
ABSTRACT


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



Top Method Summary
Options Name Purpose
GenerationFinishedHandler (Object, EventArgs) Event handler for the GenerationFinished event of the BusinessEntityGenerator
CHARACTER GetBusinessEntityClassFileName () Returns the file name of the Business Entity class
CHARACTER GetBusinessEntityClassName () Returns the fully qualified class name of the Business Entity
CHARACTER GetDatasetModelClassFileName () Returns the file name of the generated DatasetModel class
CHARACTER GetDatasetModelClassName () Returns the fully qualified class name of the generated DatasetModel class
Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin GetModelClassGeneratorPlugin () Returns the reference to the Model Class Generator plugin
CHARACTER GetSuffixDatasetModel () Returns the DatasetModel class name suffix
CHARACTER GetSuffixTableModel () Returns the TableModel class name suffix
CHARACTER GetTableModelClassFileName (character) Returns the file name of the generated TableModel class of the given temp-table
CHARACTER GetTableModelClassName (character) Returns the fully qualified class name of the generated TableModel class of the given temp-table
ProcessImplementsInterfaces () Syncs the IMPLEMENTS phrase of every class a design property exists for
ProcessTargetFile (character, character) Syncs the IMPLEMENTS phrase of a single target class file to the given interface list
CHARACTER ResolveBaseFolder (character) Resolves the given base folder setting against the file system
ShutdownInternal () Uninitializes the plugin instance and unsubscribes from events
StartupInternal () Initializes the plugin instance and subscribes to required events

Top Property Summary
Options Name Purpose
CHARACTER BusinessEntityInterfacesProperty
CHARACTER DatasetModelInterfacesProperty
Consultingwerk.BusinessEntityDesigner.Common.IBusinessEntityDesignerPluginManager PluginManager
CHARACTER TableModelInterfacesProperty


Method Detail
Top

GenerationFinishedHandler (Object, EventArgs)
Purpose: Event handler for the GenerationFinished event of the
BusinessEntityGenerator
Notes: The generated model classes have been rewritten from the
templates at this point, so the IMPLEMENTS phrases are
re-applied at the very end of the generation run

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

CHARACTER GetBusinessEntityClassFileName ()
Purpose: Returns the file name of the Business Entity class
Notes: The Business Entity class is located in the source code base
folder of the Business Entity Designer settings

Returns CHARACTER
The file name of the Business Entity class
Top

CHARACTER GetBusinessEntityClassName ()
Purpose: Returns the fully qualified class name of the Business Entity
Notes:

Returns CHARACTER
The fully qualified class name of the Business Entity
Top

CHARACTER GetDatasetModelClassFileName ()
Purpose: Returns the file name of the generated DatasetModel class
Notes: The model classes are located in the include files base
folder of the Business Entity Designer settings

Returns CHARACTER
The file name of the generated DatasetModel class
Top

CHARACTER GetDatasetModelClassName ()
Purpose: Returns the fully qualified class name of the generated
DatasetModel class
Notes: Follows the naming rules of the Model Class Generator plugin:
the package of the first temp-table's entity class, the
dataset name without the ds prefix, the DatasetModel suffix
and the _Generated suffix

Returns CHARACTER
The fully qualified class name of the generated DatasetModel class
Top

Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin GetModelClassGeneratorPlugin ()
Purpose: Returns the reference to the Model Class Generator plugin
Notes: Returns the unknown value when the plugin manager is not
available or the plugin is not loaded

Returns Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractModelClassGeneratorPlugin
The reference to the Model Class Generator plugin or ?
Top

CHARACTER GetSuffixDatasetModel ()
Purpose: Returns the DatasetModel class name suffix
Notes: Honours a customized suffix of the Model Class Generator
plugin when its reference can be resolved through the plugin
manager

Returns CHARACTER
The DatasetModel class name suffix
Top

CHARACTER GetSuffixTableModel ()
Purpose: Returns the TableModel class name suffix
Notes: Honours a customized suffix of the Model Class Generator
plugin when its reference can be resolved through the plugin
manager

Returns CHARACTER
The TableModel class name suffix
Top

CHARACTER GetTableModelClassFileName (character)
Purpose: Returns the file name of the generated TableModel class of the
given temp-table
Notes: The model classes are located in the include files base
folder of the Business Entity Designer settings

Parameters:
pcTempTableName CHARACTER
The name of the temp-table
Returns CHARACTER
The file name of the generated TableModel class
Top

CHARACTER GetTableModelClassName (character)
Purpose: Returns the fully qualified class name of the generated
TableModel class of the given temp-table
Notes: Follows the naming rules of the Model Class Generator plugin:
the entity package and class name of the temp-table, the
TableModel suffix and the _Generated suffix

Parameters:
pcTempTableName CHARACTER
The name of the temp-table
Returns CHARACTER
The fully qualified class name of the generated TableModel class
Top

ProcessImplementsInterfaces ()
Purpose: Syncs the IMPLEMENTS phrase of every class a design property
exists for
Notes: Target class files that do not exist are skipped. A failure
while processing a single file is reported via the status
manager but does not abort the processing of the remaining
files

Top

ProcessTargetFile (character, character)
Purpose: Syncs the IMPLEMENTS phrase of a single target class file to
the given interface list
Notes: A missing target file is skipped silently - e.g. the model
classes when the Model Class Generator plugin is not active.
A failure is reported via the status manager but is contained
to this file

Parameters:
pcFileName CHARACTER
The name of the target class file
pcInterfaces CHARACTER
The comma-delimited list of interfaces the class should implement
Top

CHARACTER ResolveBaseFolder (character)
Purpose: Resolves the given base folder setting against the file system
Notes: Mirrors the folder resolution of the Business Entity Generator -
an empty setting resolves to the working directory

Parameters:
pcBaseFolder CHARACTER
The base folder setting to resolve
Returns CHARACTER
The resolved base folder including a trailing slash, or an empty string
Top

ShutdownInternal ()
Purpose: Uninitializes the plugin instance and unsubscribes from events
Notes: Called by derived classes from their Shutdown method

Top

StartupInternal ()
Purpose: Initializes the plugin instance and subscribes to required events
Notes: Called by derived classes from their Startup method



Property Detail
Top

CHARACTER BusinessEntityInterfacesProperty

Returns CHARACTER
Top

CHARACTER DatasetModelInterfacesProperty

Returns CHARACTER
Top

Consultingwerk.BusinessEntityDesigner.Common.IBusinessEntityDesignerPluginManager PluginManager

Returns Consultingwerk.BusinessEntityDesigner.Common.IBusinessEntityDesignerPluginManager
Top

CHARACTER TableModelInterfacesProperty

Returns CHARACTER


Temp-Table Detail


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       04.09.2026 19:36:08