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

Inherits: Progress.Lang.Object
Inherited by: Consultingwerk.BusinessEntityDesigner.Plugins.BusinessEntityDescriptorPlugin Consultingwerk.BusinessEntityDesigner.Server.Plugins.BusinessEntityDescriptorServerPlugin
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
Progress.Json.ObjectModel.JsonObject GetBusinessEntityDescriptorFromClass () Returns the Business Entity Descriptor defined by the @BusinessEntityView annotations of the Business Entity class file
CHARACTER GetBusinessEntityDescriptorValue () Returns the value of the BusinessEntityDescriptor design property
GetCustomPropertyDocumentationHandler (Object, GetCustomPropertyDocumentationEventArgs) Event handler for the GetCustomPropertyDocumentation event of the Business Entity Dataset Controller
GetCustomPropertyNamesHandler (Object, GetCustomPropertyNamesEventArgs) Event handler for the GetCustomPropertyNames event of the Business Entity Dataset Controller
CHARACTER GetFieldNames (character) Returns the comma-delimited list of the field names of the given temp-table
CHARACTER GetQualifiedFieldNames () Returns the comma-delimited list of the field names of the design, qualified with the temp-table name
Progress.Json.ObjectModel.JsonObject GetTableDescriptorFromClass (character) Returns the Table Descriptor defined by the @BusinessEntityTable annotation of the given temp-table in the Business Entity class file
CHARACTER GetTableDescriptorValue (character) Returns the value of the TableDescriptor design property of the given temp-table
CHARACTER GetTableNames () Returns the comma-delimited list of the temp-table names of the design
Progress.Json.ObjectModel.JsonObject ParseDescriptorProperty (character, character) Parses the JSON value of a descriptor design property
ProcessDescriptorAnnotations () Syncs the @BusinessEntityView and @BusinessEntityTable annotations of the Business Entity class to the descriptor design properties
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
StartupInternal (IBusinessEntityDatasetController) Initializes the plugin instance and subscribes to required events
SubscribeCustomPropertyEvents (IBusinessEntityDatasetController) Subscribes the custom property event handlers to the events of the Business Entity Dataset Controller
UnsubscribeCustomPropertyEvents () Unsubscribes the custom property event handlers from the events of the Business Entity Dataset Controller
ValidateDescriptors () Validates the descriptor design properties of the design
ValidateDesignHandler (CancelableEventArgs) Event handler for the ValidateDesign event of the BusinessEntityGenerator

Top Property Summary
Options Name Purpose
CHARACTER BusinessEntityDescriptorDocumentation
CHARACTER TableDescriptorDocumentation


Method Detail
Top

GenerationFinishedHandler (Object, EventArgs)
Purpose: Event handler for the GenerationFinished event of the
BusinessEntityGenerator
Notes: The Business Entity class has been written at this point, so
the descriptor annotations are synced 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

Progress.Json.ObjectModel.JsonObject GetBusinessEntityDescriptorFromClass ()
Purpose: Returns the Business Entity Descriptor defined by the
@BusinessEntityView annotations of the Business Entity class
file
Notes: Returns the unknown value when the class file does not exist
or contains no @BusinessEntityView annotation

Returns Progress.Json.ObjectModel.JsonObject
The canonical Business Entity Descriptor or ?
Top

CHARACTER GetBusinessEntityDescriptorValue ()
Purpose: Returns the value of the BusinessEntityDescriptor design
property
Notes: Returns the unknown value when no property record exists

Returns CHARACTER
The JSON value of the design property or ?
Top

GetCustomPropertyDocumentationHandler (Object, GetCustomPropertyDocumentationEventArgs)
Purpose: Event handler for the GetCustomPropertyDocumentation event of the
Business Entity Dataset Controller
Notes: SCL-5831. The values of both descriptor properties are JSON, so
they are described by a Markdown file each

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

GetCustomPropertyNamesHandler (Object, GetCustomPropertyNamesEventArgs)
Purpose: Event handler for the GetCustomPropertyNames event of the
Business Entity Dataset Controller
Notes: SCL-5831. Registers the descriptor properties with the generic
Custom Properties editor of the Designer and with the MCP server

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

CHARACTER GetFieldNames (character)
Purpose: Returns the comma-delimited list of the field names of the
given temp-table
Notes:

Parameters:
pcTempTableName CHARACTER
The name of the temp-table
Returns CHARACTER
The comma-delimited list of the field names
Top

CHARACTER GetQualifiedFieldNames ()
Purpose: Returns the comma-delimited list of the field names of the
design, qualified with the temp-table name
Notes:

Returns CHARACTER
The comma-delimited list of the qualified field names
Top

Progress.Json.ObjectModel.JsonObject GetTableDescriptorFromClass (character)
Purpose: Returns the Table Descriptor defined by the @BusinessEntityTable
annotation of the given temp-table in the Business Entity
class file
Notes: Returns the unknown value when the class file does not exist
or contains no @BusinessEntityTable annotation for the
temp-table

Parameters:
pcTempTableName CHARACTER
The name of the temp-table
Returns Progress.Json.ObjectModel.JsonObject
The canonical Table Descriptor or ?
Top

CHARACTER GetTableDescriptorValue (character)
Purpose: Returns the value of the TableDescriptor design property of the
given temp-table
Notes: Returns the unknown value when no property record exists

Parameters:
pcTempTableName CHARACTER
The name of the temp-table
Returns CHARACTER
The JSON value of the design property or ?
Top

CHARACTER GetTableNames ()
Purpose: Returns the comma-delimited list of the temp-table names of the
design
Notes:

Returns CHARACTER
The comma-delimited list of the temp-table names
Top

Progress.Json.ObjectModel.JsonObject ParseDescriptorProperty (character, character)
Purpose: Parses the JSON value of a descriptor design property
Notes: Prefixes the error message with the given context when the
value is not valid JSON

Parameters:
pcJson CHARACTER
The JSON value of the design property
pcContext CHARACTER
The description of the property for the error message
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the descriptor
Top

ProcessDescriptorAnnotations ()
Purpose: Syncs the @BusinessEntityView and @BusinessEntityTable
annotations of the Business Entity class to the descriptor
design properties
Notes: Only the annotations a design property exists for are touched:
the @BusinessEntityView annotations when the
BusinessEntityDescriptor property exists, the
@BusinessEntityTable annotation of a temp-table when its
TableDescriptor property exists. A missing Business Entity
class file is skipped silently. A failure is reported via the
status manager but does not abort the generation

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

Top

StartupInternal (IBusinessEntityDatasetController)
Purpose: Initializes the plugin instance and subscribes to required events
Notes: SCL-5831. Overload used by derived classes that have access to the
controller, so that the descriptor properties are registered with
the custom properties infrastructure of the Designer and of the
MCP server

Parameters:
poController Consultingwerk.BusinessEntityDesigner.Common.IBusinessEntityDatasetController
The reference to the Business Entity Dataset Controller
Top

SubscribeCustomPropertyEvents (IBusinessEntityDatasetController)
Purpose: Subscribes the custom property event handlers to the events of the
Business Entity Dataset Controller
Notes: SCL-5831

Parameters:
poController Consultingwerk.BusinessEntityDesigner.Common.IBusinessEntityDatasetController
The reference to the Business Entity Dataset Controller
Top

UnsubscribeCustomPropertyEvents ()
Purpose: Unsubscribes the custom property event handlers from the events of
the Business Entity Dataset Controller
Notes: SCL-5831

Top

ValidateDescriptors ()
Purpose: Validates the descriptor design properties of the design
Notes: Throws an error describing the first invalid descriptor. A
TableDescriptor property of a temp-table that is no longer
part of the design is ignored

Top

ValidateDesignHandler (CancelableEventArgs)
Purpose: Event handler for the ValidateDesign event of the
BusinessEntityGenerator
Notes: Plugins are supposed to throw errors on validation issues

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


Property Detail
Top

CHARACTER BusinessEntityDescriptorDocumentation

Returns CHARACTER
Top

CHARACTER TableDescriptorDocumentation

Returns CHARACTER


Temp-Table Detail


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       19.09.2026 10:05:51