Consultingwerk.BusinessEntityDesigner.Plugins.EntityClassGeneratorPlugin

Namespace:

Consultingwerk.BusinessEntityDesigner.Plugins

Class

EntityClassGeneratorPlugin

Parent classes:

Progress.Lang.Object

Consultingwerk.BusinessEntityDesigner.Plugins.EntityClassGeneratorPlugin

Inherits:

Progress.Lang.Object

Implements:

Consultingwerk.BusinessEntityDesigner.IBusinessEntityDesignerPlugin

File:	EntityClassGeneratorPlugin
Purpose:	Business Entity Designer Plugin that integrates the
	Generator for ORM value classes.
Description:	The Plugin generates Entity classes and related code
	whenever the Business Entity is generated or regenerated.
	Entity class code generation can be suspended by setting
	the "EntityClassGenerator.Disabled" custom property to "false".
Author(s):	Mike Fechner / Consultingwerk Ltd.
Created:	Mon Apr 02 22:03:43 CEST 2012

Top Method Summary

	Options	Name	Purpose
		AfterGenerateSourceHandler (Object, EventArgs)	Event handler for the AfterGenerateSource event of the BusinessEntityDatasetController
		CHARACTER CheckTemplatePath (character)	Verifies the path to a template file
		CHARACTER FindOutputFolder ()	Returns the output folder (source code folder for business logic)
		GenerateEntityClasses ()	Generates the Entity Classes
		GenerateEntityClasses (dataset)	Generates the Entity Classes
		GetCustomPropertyNamesHandler (Object, GetCustomPropertyNamesEventArgs)	Event handler for the GetCustomPropertyNamesHandler event of the BusinessEntityDatasetController
		GetCustomPropertyValuesHandler (Object, GetCustomPropertyValuesEventArgs)	Event handler for the GetCustomPropertyNamesHandler event of the BusinessEntityDatasetController
		Shutdown ()	Method called when the Business Entity Designer will get closed
		Startup (dataset, BusinessEntityDatasetController, BusinessEntityDesignerForm, UltraToolbarsManager)	Method called when the Business Entity Designer is starting and has loaded the plugin.

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

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

GenerateEntityClasses ()

Purpose:	Generates the Entity Classes
Notes:

Top

GenerateEntityClasses (dataset)

Purpose:	Generates the Entity 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

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

Shutdown ()

Purpose:	Method called when the Business Entity Designer will get closed
Notes:

Top

Startup (dataset, BusinessEntityDatasetController, BusinessEntityDesignerForm, UltraToolbarsManager)

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.Services.BusinessEntityDatasetController
	The BusinessEntityDatasetController
poForm	Consultingwerk.BusinessEntityDesigner.UI.BusinessEntityDesignerForm
	The main Form of the BusinessEntityDesigner
poToolbar	Infragistics.Win.UltraWinToolbars.UltraToolbarsManager
	The reference to the UltraToolbarsManager used by the BusinessEntityDesigner

ProDataset Detail

ProDataset dsBusinessEntity Member tables: eBusinessEntity, eDataRelation, eDataRelationProperties, eTable, eField, eFieldProperties, eIndex, eIndexProperties, eTableProperties, eBusinessEntityProperties