Consultingwerk.BusinessEntityDesigner.Generator.BusinessEntityGenerator

Namespace:

Consultingwerk.BusinessEntityDesigner.Generator

Class

BusinessEntityGenerator

Parent classes:

Progress.Lang.Object

Consultingwerk.BusinessEntityDesigner.Generator.BusinessEntityGenerator

Inherits:

Progress.Lang.Object

Implements:

Consultingwerk.BusinessEntityDesigner.Generator.IBusinessEntityGenerator

File:	BusinessEntityGenerator
Purpose:	Generator for Business Entity and Data Access classes
Author(s):	Mike Fechner / Consultingwerk Ltd.
Created:	Sun Oct 17 22:32:09 CEST 2010
	/* Mike Fechner, Consultingwerk Ltd. 01.11.2014
	SCL-516: Dataset is protected to allow access from derived (customer extended) implementations
	of the BusinessEntityGenerator class

Top Method Summary

Options	Name	Purpose
#	Consultingwerk.Framework.Enum.DialogResultEnum AskQuestion (character, character)	Centralized wrapper for question dialogs
#	CHARACTER BuildReceiveDataCodeBlock ()	Builds the source code for the ReceiveData method (Calculated Fields)
+	CHARACTER CaseKeywords (character)	Returns the input string in the selected keyboard casing
+	CHARACTER CaseKeywords (character, character)	Returns the input string in the selected keyboard casing
#	LOGICAL CheckDirectoriesExist (logical)	Verifies that all output directories exist
#	LOGICAL CheckNotWriteProtected (character, logical)	Verifies if files are write protected and optionally prompts if files should be overwritten
#	LOGICAL CheckNotWriteProtected (logical, logical)	Verifies if files are write protected and optionally prompts if files should be overwritten
#	CHARACTER CheckTemplatePath (character)	Locates a template file and throws an Error when the template cannot be located
#	CHARACTER ChildTablesOf (character)	Returns the child tables of the given temp-table
-	ClearRestOfLine (INode, RefactorSession2)	Empties all Nodes sibling and children of the given poNode
+	LOGICAL Compile (dataset)	Complies the generated BusinessEntity, DataAccess and DatasetController classes
#	CompileFile (character, character)	Compiles a file
#	Consultingwerk.BusinessEntityDesigner.Generator.DataAccessStyleEnum DataAccessStyle (character)	Determines the style used for the Data Access class
#	EvaluateFolderNames ()	Evaluates the source and r-code folder names
+	CHARACTER FieldInitialValue (character, character)	Converts the field's initial value based on the current numeric settings
+	Consultingwerk.Studio.ProparseApi.INode FindMethod (IParseUnit, character)	Parses the Business Entity and returns the INode representing the ValidateData method
+	org.prorefactor.core.JPNode FindMethod (ParseUnit, character)	Parses the Business Entity and returns the JPNode representing the ValidateData method
+	FixLineBreak (character)	Fixes the line breaks of the generated source
#	LONGCHAR GenerateAssignSourceBufferAndTables ()	Returns the source code that assigns the SourceBufferNames and SourceTableNames properties
#	GenerateAssignSourceBufferAndTables (character, character)	Returns the source code that assigns the SourceBufferNames and SourceTableNames properties
#	CHARACTER GenerateBusinessEntity ()	Generates the Business Entity
+	LOGICAL GenerateCode (dataset)	Generates the source code
#	CHARACTER GenerateDataAccessObject ()	Generates the Data Access Object
#	GenerateDataAccessObjectDetails (longchar, longchar, longchar, longchar, longchar, CharacterDictionary)	Generates the DataSource Object Details
#	GenerateDataAccessObjectDetails2 (longchar, longchar, longchar, longchar, longchar, CharacterDictionary)	Generates the DataSource Object Details
#	CHARACTER GenerateDataset ()	Generates the dataset include file
#	CHARACTER GenerateDatasetController ()	Generates the dataset controller
+	CHARACTER GenerateFileAnnotation (character, character, character)	Returns the source code for the @FILEANNOTATION@ based on the role of the file and the business entity
#	LONGCHAR GenerateSourceColumnWhen (character)	Returns the WHEN branch for the SourceColumn CASE Statement of a single temp-table
#	CHARACTER GenerateTempTables ()	Generates the temp-table include files
#	CHARACTER GenerateXmlSchema ()	Generates XML schema representation of the Dataset
#	Consultingwerk.Studio.ProparseApi.INode GetAnnotationNode (character, character)	Locates the INode representing an Annotation in the source code
#	Consultingwerk.Studio.ProparseApi.INode GetAnnotationNode (character, character, IParseUnit)	Locates the INode representing an Annotation in the source code
#	GetAnnotationToFrom (character, character, character, character, integer, integer)	Locates the lines a start and end annotation are contained in a source code unit
#	CHARACTER GetAssignSkipDictionaryComplete ()	Returns the full list of all AssignSkipDictionary entries
#	CHARACTER GetAssignSkipDictionaryEntry (character)	Generate the Buffer specific AssignSkipDictionary statement
-	Consultingwerk.Studio.ProparseApi.INode GetEndNodeOfConstructor (IParseUnit)	Finds the END Node of the default Constructor
#	CHARACTER GetFieldMapping (character, integer)	Returns the field mapping pairs for the named temp-table
+	LOGICAL GetRegenerate (character)	Returns if the component identified by the ID should be regenerated
+	Consultingwerk.BusinessEntityDesigner.Generator.ListRegenerateParameter GetRegenerateParameters ()	Returns the list of the regenerate parameters
#	CHARACTER GetTopNavBuffers ()	Returns the comma delimited list of the top-nav buffers of the generated dataset
+	CHARACTER GetUserId ()	Returns the current windows user d
+	CHARACTER GetUserName ()	Returns the current windows user name
+	LOGICAL HasCalculatedFields ()	Returns if the Business Entity design contains calculated fields
+	LOGICAL HasValidations ()	Returns if the Business Entity design contains validations
#	OnAfterWriteFile (AfterWriteFileEventArgs)	Raises the AfterWriteFile event
#	OnGenerateTempTable (GenerateTempTableEventArgs)	Raises the GenerateTempTable event
#	OnProvideRegeneratePrompt (ProvideRegeneratePromptEventArgs)	Raises the ProvideRegeneratePrompt event
#	OnWriteFile (WriteFileEventArgs)	Raises the WriteFile event
#	OpenFilesInIDE (character)	Opens the generated files in the IDE
#	LOGICAL PromptForOverwrite (character)	Prompts for overwriting an existing file
+	Consultingwerk.BusinessEntityDesigner.Generator.AfterWriteFileEventArgs RaiseAfterWriteFileEvent (character, character)	Raises the AfterWriteFile event from the Business Entity Dataset Controller
+	Consultingwerk.BusinessEntityDesigner.Generator.WriteFileEventArgs RaiseWriteFileEvent (character, character)	Raises the WriteFile event from the Business Entity Dataset Controller
+	LOGICAL RegenerateCode (dataset)	Re-generates the source code
#	CHARACTER UnqualifiedTableNames (character)	Returns a list of unqualified table names by removing the database prefix
#	UpdateAssignSkipDictionary (character)	Updates the AssignSkipDictionary entries in the Constructor
#	UpdateAttachDataSource (character)	Updates the Attach Data Source Method
#	CHARACTER UpdateBusinessEntity ()	Updates the Business Entity by merging the current source code with the model
#	UpdateBusinessEntityCalculatedFields (character)	Updates the Business Entity Calculated Fields
#	UpdateBusinessEntityValidation (character)	Updates the Business Entity Validation
#	CHARACTER UpdateDataAccessObject ()	Updates the Data Access Object by merging the current source code with the model
#	UpdateDataSourceDefinition (character)	Updates the Data Source Definition
#	UpdateDetachDataSource (character)	Updates the Detach Data Source Method
#	UpdateEnableParentRelationMethods (character)	Updates the EnableParentRelation methods in the Data Access class
#	UpdateExistingSourceDefaultQuery (character)	Updates the SourceDefault Method
#	UpdateMappingDefinition (character)	Updates the mapping definition
#	UpdateSourceColumn (character)	Updates the SourceColumn Method
#	UpdateSourceDefaultQuery (character)	Updates the SourceDefault Method
#	CHARACTER ValidABLIdentifier (character)	Limits the length of an identifier to 32 characters (ABL maximum)
#	ValidateDesign ()	Validates the Design information
+	ValidateDesign (dataset)	Validates the Design information
#	ValidateUniqueSerializeNames ()	Validates uniqueness of serialize names

Top Constructor Summary

	Options	Name	Purpose
	+	BusinessEntityGenerator ()	Constructor for the BusinessEntityGenerator class

Top Event Summary

Options	Name	Purpose
+	AfterWriteFile (Object, AfterWriteFileEventArgs)	Raised when the Business Entity Designer writes to an output file
+	GenerateTempTable (Object, GenerateTempTableEventArgs)	Raised when the Business Entity Generator generates a temp-table
+	ProvideRegeneratePrompt (Object, ProvideRegeneratePromptEventArgs)	Raised when the Business Entity Generator needs to obtain the list of regenerate prompts
+	WriteFile (Object, WriteFileEventArgs)	Raised when the Business Entity Designer writes to an output file

Top Property Summary

	Options	Name	Purpose
	+	Consultingwerk.BusinessEntityDesigner.Generator.Generated Generated
	+	LOGICAL OpenFilesInIDE
	+	LOGICAL SilentMode
	+	LOGICAL SilentModeUpdateDataAccess
	+	CHARACTER SuffixBusinessEntity
	+	CHARACTER SuffixDataAccess
	+	CHARACTER SuffixDatasetController

Method Detail

Top

PROTECTED Consultingwerk.Framework.Enum.DialogResultEnum AskQuestion (character, character)

Purpose:	Centralized wrapper for question dialogs
Notes:	Allows derived classes to override dialog behavior and eases testing

Parameters:
pcMessage	CHARACTER
	The message text
pcCaption	CHARACTER
	The dialog caption
Returns	Consultingwerk.Framework.Enum.DialogResultEnum
	DialogResultEnum selected by the user

Top

PROTECTED CHARACTER BuildReceiveDataCodeBlock ()

Purpose:	Builds the source code for the ReceiveData method (Calculated Fields)
Notes:

Returns	CHARACTER
	The generated source code for the ReceiveData method

Top

PUBLIC CHARACTER CaseKeywords (character)

Purpose:	Returns the input string in the selected keyboard casing
Notes:	See BusinessEntityDesignerSettings

Parameters:
pcString	CHARACTER
	The string value to fix the casing for
Returns	CHARACTER
	The string in the desired casing

Top

PUBLIC CHARACTER CaseKeywords (character, character)

Purpose:	Returns the input string in the selected keyboard casing
Notes:	See BusinessEntityDesignerSettings

Parameters:
pcString	CHARACTER
	The string value to fix the casing for
pcKeepCase	CHARACTER
	CHR(1) delimited list of strings contained in the pcString that should keep heir casing as provided in this parameter
Returns	CHARACTER
	The string in the desired casing

Top

PROTECTED LOGICAL CheckDirectoriesExist (logical)

Purpose:	Verifies that all output directories exist
Notes:

Parameters:
plIncludeFilesOnly	LOGICAL
	Only verify the directories of the include files
Returns	LOGICAL
	Logical value indicating if the code generation should continue (FALSE will cancel the generator)

Top

PROTECTED LOGICAL CheckNotWriteProtected (character, logical)

Purpose:	Verifies if files are write protected and optionally prompts if files
	should be overwritten
Notes:

Parameters:
pcFileName	CHARACTER
	The name of the file to check
plAskOverwrite	LOGICAL
	Logical flag indicating if the Business Entity Generator should prompt for overwriting files
Returns	LOGICAL
	Logical value indicating if no file is write protected

Top

PROTECTED LOGICAL CheckNotWriteProtected (logical, logical)

Purpose:	Verifies if files are write protected and optionally prompts if files
	should be overwritten
Notes:

Parameters:
plIncludeFilesOnly	LOGICAL
	Logical flag indicating if only the include files should be verified
plAskOverwrite	LOGICAL
	Logical flag indicating if the Business Entity Generator should prompt for overwriting files
Returns	LOGICAL
	Logical value indicating if no file is write protected

Top

PROTECTED CHARACTER CheckTemplatePath (character)

Purpose:	Locates a template file and throws an Error when the template
	cannot be located
Notes:

Parameters:
pcFileName	CHARACTER
	The relative name of the template file
Returns	CHARACTER
	Full pathname of the template

Top

PROTECTED CHARACTER ChildTablesOf (character)

Purpose:	Returns the child tables of the given temp-table
Notes:

Parameters:
pcParentTable	CHARACTER
	The name of the parent table to return the child tables of
Returns	CHARACTER
	Comma delimited list of child temp-tables of the parent table

Top

PRIVATE ClearRestOfLine (INode, RefactorSession2)

Purpose:	Empties all Nodes sibling and children of the given poNode
Notes:	Used to clear the old AssignSkipDictionary statement when refreshing

Parameters:
poNode	Consultingwerk.Studio.ProparseApi.INode
	Node to clear
poRefactorSession	Consultingwerk.Studio.SmartRefactor.RefactorSession2
	Current refactoring session, used to replace node values

Top

PUBLIC LOGICAL Compile (dataset)

Purpose:	Complies the generated BusinessEntity, DataAccess and DatasetController
	classes
Notes:

Parameters:
dsBusinessEntity	DATASET dsBusinessEntity
	The dataset with the Business Entity model
Returns	LOGICAL
	Logical value indicating the success of the operation

Top

PROTECTED CompileFile (character, character)

Purpose:	Compiles a file
Notes:

Parameters:
pcFileName	CHARACTER
	The file name to compile
pcSaveInto	CHARACTER
	The directory to compile into

Top

PROTECTED Consultingwerk.BusinessEntityDesigner.Generator.DataAccessStyleEnum DataAccessStyle (character)

Purpose:	Determines the style used for the Data Access class
Notes:

Parameters:
pcDataSourceStyle	CHARACTER
	The character representation of the Data Source Style
Returns	Consultingwerk.BusinessEntityDesigner.Generator.DataAccessStyleEnum
	DataAccessStyleEnum The DataAccessStyleEnum member representing the style used to generate the Data Access class

Top

PROTECTED EvaluateFolderNames ()

Purpose:	Evaluates the source and r-code folder names
Notes:	Variable cSourceFolder and cRCodeFolder

Top

PUBLIC CHARACTER FieldInitialValue (character, character)

Purpose:	Converts the field's initial value based on the current numeric settings
Notes:

Parameters:
pcInitial	CHARACTER
	The initial value
pcDataType	CHARACTER
	The data type
Returns	CHARACTER
	The initial value in AMERICAN format for the ABL INITIAL VALUE

Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode FindMethod (IParseUnit, character)

Purpose:	Parses the Business Entity and returns the INode representing the
	ValidateData method
Notes:	FindMethod is duplicated to allow the continued direct use of Proparse if the ProparseApi is not available.

Parameters:
poParseUnit	Consultingwerk.Studio.ProparseApi.IParseUnit
	The reference to the ParseUnit
pcMethodName	CHARACTER
	The name of the method to locate
Returns	Consultingwerk.Studio.ProparseApi.INode
	The INode representing the ValidateData method

Top

PUBLIC org.prorefactor.core.JPNode FindMethod (ParseUnit, character)

Purpose:	Parses the Business Entity and returns the JPNode representing the
	ValidateData method
Notes:	FindMethod is duplicated to allow the continued direct use of Proparse if the ProparseApi is not available.

Parameters:
poParseUnit	org.prorefactor.treeparser.ParseUnit
	The reference to the ParseUnit
pcMethodName	CHARACTER
	The name of the method to locate
Returns	org.prorefactor.core.JPNode
	The JPNode representing the ValidateData method

Top

PUBLIC FixLineBreak (character)

Purpose:	Fixes the line breaks of the generated source
Notes:

Parameters:
pcFileName	CHARACTER
	The file name to open

Top

PROTECTED LONGCHAR GenerateAssignSourceBufferAndTables ()

Purpose:	Returns the source code that assigns the SourceBufferNames
	and SourceTableNames properties
Notes:

Returns	LONGCHAR
	The source code that assigns the SourceBufferNames and SourceTableNames properties

Top

PROTECTED GenerateAssignSourceBufferAndTables (character, character)

Purpose:	Returns the source code that assigns the SourceBufferNames
	and SourceTableNames properties
Notes:

Parameters:
pcSourceTables	CHARACTER
	OUTPUT The semicolon delimited list of comma delimited list of source table names
pcSourceBuffers	CHARACTER
	OUTPUT The semicolon delimited list of comma delimited list of source buffer names

Top

PROTECTED CHARACTER GenerateBusinessEntity ()

Purpose:	Generates the Business Entity
Notes:

Returns	CHARACTER
	The name of the generated business entity

Top

PUBLIC LOGICAL GenerateCode (dataset)

Purpose:	Generates the source code
Notes:	This method will overwrite eventually existing source code

Parameters:
dsBusinessEntity	DATASET dsBusinessEntity
	The dataset with the Business Entity model
Returns	LOGICAL
	Logical value indicating the success of the operation

Top

PROTECTED CHARACTER GenerateDataAccessObject ()

Purpose:	Generates the Data Access Object
Notes:

Returns	CHARACTER
	The name of the generated data access object

Top

PROTECTED GenerateDataAccessObjectDetails (longchar, longchar, longchar, longchar, longchar, CharacterDictionary)

Purpose:	Generates the DataSource Object Details
Notes:

Parameters:
lcDefineDataSource	LONGCHAR
	The code block for the data source definition
lcAttachDataSource	LONGCHAR
	The code block for attaching the data sources
lcDetachDataSource	LONGCHAR
	The code block the detaching the data sources
lcSourceColumn	LONGCHAR
	The code block for the SourceColumn method
lcDefaultQuery	LONGCHAR
	The code block for the SourceDefaultQuery method
poDataSourceNames	Consultingwerk.Framework.Collections.CharacterDictionary
	The CharacterDictionary of data source names

Top

PROTECTED GenerateDataAccessObjectDetails2 (longchar, longchar, longchar, longchar, longchar, CharacterDictionary)

Purpose:	Generates the DataSource Object Details
Notes:

Parameters:
lcDefineDataSource	LONGCHAR
	The code block for the data source definition
lcAttachDataSource	LONGCHAR
	The code block for attaching the data sources
lcDetachDataSource	LONGCHAR
	The code block the detaching the data sources
lcSourceColumn	LONGCHAR
	The code block for the SourceColumn method
lcDefaultQuery	LONGCHAR
	The code block for the SourceDefaultQuery method
poDataSourceNames	Consultingwerk.Framework.Collections.CharacterDictionary
	The CharacterDictionary of data source names

Top

PROTECTED CHARACTER GenerateDataset ()

Purpose:	Generates the dataset include file
Notes:

Returns	CHARACTER
	The file name of the generated dataset include file

Top

PROTECTED CHARACTER GenerateDatasetController ()

Purpose:	Generates the dataset controller
Notes:

Returns	CHARACTER
	The file name of the generated dataset controller

Top

PUBLIC CHARACTER GenerateFileAnnotation (character, character, character)

Purpose:	Returns the source code for the @FILEANNOTATION@ based on the
	role of the file and the business entity
Notes:

Parameters:
pcEntityPackage	CHARACTER
	The Business Entity package
pcEntityName	CHARACTER
	The Business Entity name
pcFileType	CHARACTER
	The file type
Returns	CHARACTER
	The source code for the @FILEANNOTATION@

Top

PROTECTED LONGCHAR GenerateSourceColumnWhen (character)

Purpose:	Returns the WHEN branch for the SourceColumn CASE Statement
	of a single temp-table
Notes:

Parameters:
pcTable	CHARACTER
	The name of the temp-table
Returns	LONGCHAR
	The WHEN branch for the SourceColumn CASE Statement

Top

PROTECTED CHARACTER GenerateTempTables ()

Purpose:	Generates the temp-table include files
Notes:

Returns	CHARACTER
	Comma-delimited list of the generated temp-table include files

Top

PROTECTED CHARACTER GenerateXmlSchema ()

Purpose:	Generates XML schema representation of the Dataset
Notes:	Uses DATASET:WRITE-XMLSCHEMA method

Returns	CHARACTER
	The file name of the generated xsd file

Top

PROTECTED Consultingwerk.Studio.ProparseApi.INode GetAnnotationNode (character, character)

Purpose:	Locates the INode representing an Annotation in the source code
Notes:

Parameters:
pcFileName	CHARACTER
	The file name to parse
pcAnnotation	CHARACTER
	The name of the annotation
Returns	Consultingwerk.Studio.ProparseApi.INode
	The INode reference representing the first occurence of the given annotation

Top

PROTECTED Consultingwerk.Studio.ProparseApi.INode GetAnnotationNode (character, character, IParseUnit)

Purpose:	Locates the INode representing an Annotation in the source code
Notes:

Parameters:
pcFileName	CHARACTER
	The file name to parse
pcAnnotation	CHARACTER
	The name of the annotation
poParseUnit	Consultingwerk.Studio.ProparseApi.IParseUnit
	Output Parameter, the ParseUnit used
Returns	Consultingwerk.Studio.ProparseApi.INode
	The INode reference representing the first occurence of the given annotation

Top

PROTECTED GetAnnotationToFrom (character, character, character, character, integer, integer)

Purpose:	Locates the lines a start and end annotation are contained in a
	source code unit
Notes:

Parameters:
pcFileName	CHARACTER
	The file name to parse
pcStartAnnotation	CHARACTER
	The name of the start annotation
pcEndAnnotation	CHARACTER
	The name of the end annotation
pcAnnotationFileName	CHARACTER
	OUTPUT The file name containing the annotations
piStart	INTEGER
	The line number of the starting annotation
piEnd	INTEGER
	The line number of the ending annotation

Top

PROTECTED CHARACTER GetAssignSkipDictionaryComplete ()

Purpose:	Returns the full list of all AssignSkipDictionary entries
Notes:	Used for the initial code generation to replace the placeholder

Returns	CHARACTER
	Formatted list of all AssignSkipDictionary entries

Top

PROTECTED CHARACTER GetAssignSkipDictionaryEntry (character)

Purpose:	Generate the Buffer specific AssignSkipDictionary statement
Notes:

Parameters:
pcBufferName	CHARACTER
	Name of the Buffer to create the AssignSkipDictionary statement for
Returns	CHARACTER
	the AssignSkipDictionary statement

Top

PRIVATE Consultingwerk.Studio.ProparseApi.INode GetEndNodeOfConstructor (IParseUnit)

Purpose:	Finds the END Node of the default Constructor
Notes:

Parameters:
poParseUnit	Consultingwerk.Studio.ProparseApi.IParseUnit
	The ParseUnit context to be used as the source
Returns	Consultingwerk.Studio.ProparseApi.INode
	The END Constructor Node

Top

PROTECTED CHARACTER GetFieldMapping (character, integer)

Purpose:	Returns the field mapping pairs for the named temp-table
Notes:

Parameters:
pcTempTableName	CHARACTER
	The name of the temp-table to return the field mappings for
piSpaces	INTEGER
	The number of SPACE Characters (CHR(32)) to prefix each entry with
Returns	CHARACTER
	The list of the field mappings

Top

PUBLIC LOGICAL GetRegenerate (character)

Purpose:	Returns if the component identified by the ID should be
	regenerated
Notes:

Parameters:
pcID	CHARACTER
	The ID of the component to regenerate
Returns	LOGICAL
	Logical value indicating if the component should be regenerated

Top

PUBLIC Consultingwerk.BusinessEntityDesigner.Generator.ListRegenerateParameter GetRegenerateParameters ()

Purpose:	Returns the list of the regenerate parameters
Notes:	Raised by the UI to obtain the list of prompts

Returns	Consultingwerk.BusinessEntityDesigner.Generator.ListRegenerateParameter
	The list of the regenerate parameters

Top

PROTECTED CHARACTER GetTopNavBuffers ()

Purpose:	Returns the comma delimited list of the top-nav buffers of the generated dataset
Notes:

Returns	CHARACTER
	The comma delimited list of the top-nav buffers

Top

PUBLIC CHARACTER GetUserId ()

Purpose:	Returns the current windows user d
Notes:

Returns	CHARACTER
	The ID of the current windows user

Top

PUBLIC CHARACTER GetUserName ()

Purpose:	Returns the current windows user name
Notes:

Returns	CHARACTER
	The Display name of the current windows user

Top

PUBLIC LOGICAL HasCalculatedFields ()

Purpose:	Returns if the Business Entity design contains calculated fields
Notes:

Returns	LOGICAL
	Logical value indicating if the Business Entity design contains calculated fields

Top

PUBLIC LOGICAL HasValidations ()

Purpose:	Returns if the Business Entity design contains validations
Notes:

Returns	LOGICAL
	Logical value indicating if the Business Entity design contains validations

Top

PROTECTED OnAfterWriteFile (AfterWriteFileEventArgs)

Purpose:	Raises the AfterWriteFile event
Notes:

Parameters:
e	Consultingwerk.BusinessEntityDesigner.Generator.AfterWriteFileEventArgs
	The AfterWriteFileEventArgs with the data for the event

Top

PROTECTED OnGenerateTempTable (GenerateTempTableEventArgs)

Purpose:	Raises the GenerateTempTable event
Notes:

Parameters:
e	Consultingwerk.BusinessEntityDesigner.Generator.GenerateTempTableEventArgs
	The GenerateTempTableEventArgs with the data for the event

Top

PROTECTED OnProvideRegeneratePrompt (ProvideRegeneratePromptEventArgs)

Purpose:	Raises the ProvideRegeneratePrompt event
Notes:

Parameters:
e	Consultingwerk.BusinessEntityDesigner.Generator.ProvideRegeneratePromptEventArgs
	The GenerateTempTableEventArgs with the data for the event

Top

PROTECTED OnWriteFile (WriteFileEventArgs)

Purpose:	Raises the WriteFile event
Notes:

Parameters:
e	Consultingwerk.BusinessEntityDesigner.Generator.WriteFileEventArgs
	The WriteFileEventArgs with the data for the event

Top

PROTECTED OpenFilesInIDE (character)

Purpose:	Opens the generated files in the IDE
Notes:

Parameters:
pcFileNames	CHARACTER
	The comma delimited list of file names to open in the IDE

Top

PROTECTED LOGICAL PromptForOverwrite (character)

Purpose:	Prompts for overwriting an existing file
Notes:

Parameters:
pcFileName	CHARACTER
	The file name to be used in the prompt dialog
Returns	LOGICAL
	Logical value indicating the response of the current user

Top

PUBLIC Consultingwerk.BusinessEntityDesigner.Generator.AfterWriteFileEventArgs RaiseAfterWriteFileEvent (character, character)

Purpose:	Raises the AfterWriteFile event from the Business Entity Dataset Controller
Notes:

Parameters:
pcFilePurpose	CHARACTER
	The purpose of the file being written
pcFileName	CHARACTER
	The name of the file being written
Returns	Consultingwerk.BusinessEntityDesigner.Generator.AfterWriteFileEventArgs
	The AfterWriteFileEventArgs with the result of the event

Top

PUBLIC Consultingwerk.BusinessEntityDesigner.Generator.WriteFileEventArgs RaiseWriteFileEvent (character, character)

Purpose:	Raises the WriteFile event from the Business Entity Dataset Controller
Notes:

Parameters:
pcFilePurpose	CHARACTER
	The purpose of the file being written
pcFileName	CHARACTER
	The name of the file being written
Returns	Consultingwerk.BusinessEntityDesigner.Generator.WriteFileEventArgs
	The WriteFileEventArgs with the result of the event

Top

PUBLIC LOGICAL RegenerateCode (dataset)

Purpose:	Re-generates the source code
Notes:	Currently this will only re-generate the dataset and temp-table
	definitions, but leave the business entity and data access code
	untouched

Parameters:
dsBusinessEntity	DATASET dsBusinessEntity
	The dataset with the Business Entity model
Returns	LOGICAL
	Logical value indicating the success of the operation

Top

PROTECTED CHARACTER UnqualifiedTableNames (character)

Purpose:	Returns a list of unqualified table names by removing the database prefix
Notes:

Parameters:
pcQualifiedTableNames	CHARACTER
	A comma delimited list of potentially DB qualified table names
Returns	CHARACTER
	The list of unqualified table names by removing the database prefix

Top

PROTECTED UpdateAssignSkipDictionary (character)

Purpose:	Updates the AssignSkipDictionary entries in the Constructor
Notes:

Parameters:
pcFileName	CHARACTER
	The name of the Data Access source code

Top

PROTECTED UpdateAttachDataSource (character)

Purpose:	Updates the Attach Data Source Method
Notes:

Parameters:
pcFileName	CHARACTER
	The name of the Data Access source code

Top

PROTECTED CHARACTER UpdateBusinessEntity ()

Purpose:	Updates the Business Entity by merging the current source code
	with the model
Notes:	Using Proparse to parse the file

Returns	CHARACTER
	The file name of the Business Entity

Top

PROTECTED UpdateBusinessEntityCalculatedFields (character)

Purpose:	Updates the Business Entity Calculated Fields
Notes:	Replaces source code within @GeneratedCalculatedFieldsStart. and
	@GeneratedCalculatedFieldsEnd. annotations.

Parameters:
pcFileName	CHARACTER
	The name of the Data Access source code

Top

PROTECTED UpdateBusinessEntityValidation (character)

Purpose:	Updates the Business Entity Validation
Notes:	Replaces source code within @GeneratedValidationStart. and
	@GeneratedValidationEnd. annotations.

Parameters:
pcFileName	CHARACTER
	The name of the Data Access source code

Top

PROTECTED CHARACTER UpdateDataAccessObject ()

Purpose:	Updates the Data Access Object by merging the current source code
	with the model
Notes:	Using Proparse to parse the file

Returns	CHARACTER
	The file name of the Data Access Object

Top

PROTECTED UpdateDataSourceDefinition (character)

Purpose:	Updates the Data Source Definition
Notes:

Parameters:
pcFileName	CHARACTER
	The name of the Data Access source code

Top

PROTECTED UpdateDetachDataSource (character)

Purpose:	Updates the Detach Data Source Method
Notes:

Parameters:
pcFileName	CHARACTER
	The name of the Data Access source code

Top

PROTECTED UpdateEnableParentRelationMethods (character)

Purpose:	Updates the EnableParentRelation methods in the Data Access class
Notes:

Parameters:
pcFileName	CHARACTER
	The name of the Data Access class

Top

PROTECTED UpdateExistingSourceDefaultQuery (character)

Purpose:	Updates the SourceDefault Method
Notes:

Parameters:
pcFileName	CHARACTER
	The name of the Data Access source code

Top

PROTECTED UpdateMappingDefinition (character)

Purpose:	Updates the mapping definition
Notes:

Parameters:
pcFileName	CHARACTER
	The name of the Data Access source code

Top

PROTECTED UpdateSourceColumn (character)

Purpose:	Updates the SourceColumn Method
Notes:

Parameters:
pcFileName	CHARACTER
	The name of the Data Access source code

Top

PROTECTED UpdateSourceDefaultQuery (character)

Purpose:	Updates the SourceDefault Method
Notes:	This method adds new SourceDefaultQuery CASE branches. The method
	UpdateExistingSourceDefaultQuery verifies existing CASE branches.

Parameters:
pcFileName	CHARACTER
	The name of the Data Access source code

Top

PROTECTED CHARACTER ValidABLIdentifier (character)

Purpose:	Limits the length of an identifier to 32 characters (ABL maximum)
Notes:	Avoid error: Identifier was left blank or is more than 32 characters. (1700)

Parameters:
pcIdentifier	CHARACTER
	The intended ABL identifier
Returns	CHARACTER
	The identifier name reduced to 32 characters

Top

PROTECTED ValidateDesign ()

Purpose:	Validates the Design information
Notes:	Throws errors when there are issues in the Design

Top

PUBLIC ValidateDesign (dataset)

Purpose:	Validates the Design information
Notes:	Throws errors when there are issues in the Design

Parameters:
dsBusinessEntity	DATASET dsBusinessEntity
	The dataset with the Business Entity model

Top

PROTECTED ValidateUniqueSerializeNames ()

Purpose:	Validates uniqueness of serialize names
Notes:	dsBusinessEntity passed to calling method ValidateDesign

Constructor Detail

Top

PUBLIC BusinessEntityGenerator ()

Purpose:	Constructor for the BusinessEntityGenerator class
Notes:

Event Detail

Top

PUBLIC AfterWriteFile (Object, AfterWriteFileEventArgs)

Purpose:	Raised when the Business Entity Designer writes to an output file
Notes:	Cancelable event, that can cancel the write of a single file. To
	Cancel the whole business entity generation, event handlers should
	throw an error

Parameters:
sender	Progress.Lang.Object
	The object that raised the WriteFile event
e	Consultingwerk.BusinessEntityDesigner.Generator.AfterWriteFileEventArgs
	The WriteFileEventArgs with the data for the event

Top

PUBLIC GenerateTempTable (Object, GenerateTempTableEventArgs)

Purpose:	Raised when the Business Entity Generator generates a temp-table
Notes:

Parameters:
sender	Progress.Lang.Object
	The object that raised the GenerateTempTable event
e	Consultingwerk.BusinessEntityDesigner.Generator.GenerateTempTableEventArgs
	The GenerateTempTableEventArgs with the data for the event

Top

PUBLIC ProvideRegeneratePrompt (Object, ProvideRegeneratePromptEventArgs)

Purpose:	Raised when the Business Entity Generator needs to obtain the list of regenerate prompts
Notes:

Parameters:
sender	Progress.Lang.Object
	The object that raised the ProvideRegeneratePrompt event
e	Consultingwerk.BusinessEntityDesigner.Generator.ProvideRegeneratePromptEventArgs
	The GenerateTempTableEventArgs with the data for the event

Top

PUBLIC WriteFile (Object, WriteFileEventArgs)

Purpose:	Raised when the Business Entity Designer writes to an output file
Notes:	Cancelable event, that can cancel the write of a single file. To
	Cancel the whole business entity generation, event handlers should
	throw an error

Parameters:
sender	Progress.Lang.Object
	The object that raised the WriteFile event
e	Consultingwerk.BusinessEntityDesigner.Generator.WriteFileEventArgs
	The WriteFileEventArgs with the data for the event