Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin

Namespace:

Consultingwerk.BusinessEntityDesigner.Common.Plugins

Class

AbstractTableQueryBuilderGeneratorPlugin

Parent classes:

Progress.Lang.Object

Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractTableQueryBuilderGeneratorPlugin

Inherits:

Progress.Lang.Object

Inherited by:

Consultingwerk.BusinessEntityDesigner.Plugins.TableQueryBuilderGeneratorPlugin Consultingwerk.BusinessEntityDesigner.Server.Plugins.TableQueryBuilderGeneratorServerPlugin

ABSTRACT

Top Method Summary

	Options	Name	Purpose
		AfterGenerateSourceHandler (Object, EventArgs)	Event handler for the AfterGenerateSource event of the BusinessEntityDatasetController
		LOGICAL CheckDirectoriesExist ()	Validates that the target folders exists of prompts for create
		CHARACTER CheckTemplatePath (character)	Verifies the path to a template file
		CHARACTER FindOutputFolder ()	Returns the output folder (source code folder for shared code)
		LONGCHAR GenerateConstructors (character)	Returns the code for the search constructors
		GenerateFieldEnumQueryPredicate (character, character, character, character, character, character, character, character)	Generates a single field query predicate class
		GenerateFieldQueryPredicate (character, character, character, character, character, character)	Generates a single field query predicate class
		GenerateQueryClasses ()	Generates the Query 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
		LOGICAL IsPluginActive ()	Returns if the Plugin is active (not disabled)
		TableQueryBuilderClasses (dataset)	Generates the Table Query Builder Classes
		ValidateSearchCodeIndexes ()	Validates that the indexes flagged with "Default Search Code Generation" do not cause constructors with duplicate signatures

Top Property Summary

	Options	Name	Purpose
		LOGICAL SilentMode
		CHARACTER SuffixTableQuery

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

LOGICAL CheckDirectoriesExist ()

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

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 shared code)
Notes:

Returns	CHARACTER
	The output folder

Top

LONGCHAR GenerateConstructors (character)

Purpose:	Returns the code for the search constructors
Notes:

Parameters:
pcTempTableName	CHARACTER
	The name of the current temp-table
Returns	LONGCHAR
	The source code for the search constructors

Top

GenerateFieldEnumQueryPredicate (character, character, character, character, character, character, character, character)

Purpose:	Generates a single field query predicate class
Notes:

Parameters:
pcPackageName	CHARACTER
	The package for the table query class
pcTableQueryName	CHARACTER
	The name of the table query class
pcFieldName	CHARACTER
	The field for which the predicate is generated
pcEnumType	CHARACTER
	The Data Type of the enum representing the field
pcDataType	CHARACTER
	The Data Type of the field
pcTemplateFileName	CHARACTER
	The file name of the template
pcBusinessEntityPackage	CHARACTER
	The name of the Business Entity Package
pcBusinessEntityName	CHARACTER
	The name of the Business Entity

Top

GenerateFieldQueryPredicate (character, character, character, character, character, character)

Purpose:	Generates a single field query predicate class
Notes:

Parameters:
pcPackageName	CHARACTER
	The package for the table query class
pcTableQueryName	CHARACTER
	The name of the table query class
pcDataType	CHARACTER
	The Data Type used for the class name to generate
pcTemplateFileName	CHARACTER
	The file name of the template
pcBusinessEntityPackage	CHARACTER
	The name of the Business Entity Package
pcBusinessEntityName	CHARACTER
	The name of the Business Entity

Top

GenerateQueryClasses ()

Purpose:	Generates the Query Classes
Notes:

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

LOGICAL IsPluginActive ()

Purpose:	Returns if the Plugin is active (not disabled)
Notes:

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

Top

TableQueryBuilderClasses (dataset)

Purpose:	Generates the Table Query Builder Classes
Notes:	This routine is intended to be used from outside of the Business Entity
	designer (automatic source code generation, unit testing)