Consultingwerk.BusinessEntityDesigner.Plugins.KeyValueObjectGeneratorPlugin

Namespace:

Consultingwerk.BusinessEntityDesigner.Plugins

Class

KeyValueObjectGeneratorPlugin

Parent classes:

Progress.Lang.Object

Consultingwerk.BusinessEntityDesigner.Plugins.KeyValueObjectGeneratorPlugin

Inherits:

Progress.Lang.Object

Implements:

Consultingwerk.BusinessEntityDesigner.IBusinessEntityDesignerPlugin

Top Method Summary

	Options	Name	Purpose
		AfterGenerateSourceHandler (Object, EventArgs)	Method called when the Business Entity Designer has generated the source code
		AfterRegenerateSourceHandler (Object, EventArgs)	Method called when the Business Entity Designer has regenerated the source code
		GenerateValueObjectClass (character, character, character, character, character, character, ModelClassGeneratorPlugin)	Generates a ValueObject class for a primary unique key
		GenerateValueObjectClasses ()	Generates ValueObject classes for primary unique keys
		GenerateValueObjectClasses (dataset)	Generates the ValueObject Classes
		GetFieldsData (character, character, longchar, longchar, longchar, longchar)	Gets the fields data
		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.

Top Property Summary

	Options	Name	Purpose
		CHARACTER Prefix
		CHARACTER Suffix

Method Detail

Top

AfterGenerateSourceHandler (Object, EventArgs)

Purpose:	Method called when the Business Entity Designer has generated the source code
Notes:

Parameters:
sender	Progress.Lang.Object
	The object that raised the event
e	Consultingwerk.EventArgs
	The event arguments

Top

AfterRegenerateSourceHandler (Object, EventArgs)

Purpose:	Method called when the Business Entity Designer has regenerated the source code
Notes:

Parameters:
sender	Progress.Lang.Object
	The object that raised the event
e	Consultingwerk.EventArgs
	The event arguments

Top

GenerateValueObjectClass (character, character, character, character, character, character, ModelClassGeneratorPlugin)

Purpose:	Generates a ValueObject class for a primary unique key
Notes:

Parameters:
pcDatasetPath	CHARACTER
	The dataset path
pcDatasetName	CHARACTER
	The dataset name
pcTempTableName	CHARACTER
	The temporary table name
pcEntityClassName	CHARACTER
	The entity class name
pcEntityPackageName	CHARACTER
	The entity package name
pcIndexFields	CHARACTER
	The index fields
poPlugin	Consultingwerk.BusinessEntityDesigner.Plugins.ModelClassGeneratorPlugin
	The ModelClassGeneratorPlugin

Top

GenerateValueObjectClasses ()

Purpose:	Generates ValueObject classes for primary unique keys
Notes:

Top

GenerateValueObjectClasses (dataset)

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

GetFieldsData (character, character, longchar, longchar, longchar, longchar)

Purpose:	Gets the fields data
Notes:

Parameters:
pcTempTableName	CHARACTER
	The temporary table name
pcIndexFields	CHARACTER
	The index fields
plcProperties	LONGCHAR
	The generated text for the property definitions
plcComments	LONGCHAR
	The generated text for the comments
plcParameters	LONGCHAR
	The generated text for the parameters
plcAssignments	LONGCHAR
	The generated text for the assignments

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

Property Detail

Top

CHARACTER Prefix

Returns	CHARACTER

Top

CHARACTER Suffix

Returns	CHARACTER

ProDataset Detail

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