Consultingwerk.BusinessEntityDesigner.Batch.BatchGenerator

Namespace:

Consultingwerk.BusinessEntityDesigner.Batch

Class

BatchGenerator

Parent classes:

Progress.Lang.Object

Consultingwerk.BusinessEntityDesigner.Batch.BatchGenerator

Inherits:

Progress.Lang.Object

Top Method Summary

	Options	Name	Purpose
		AddAdditionalFields (character, handle)	Adds additional fields specified by the caller to the current Business Entity schema Notes : This is a stub implementation and can be extended to parse and add fields @param pcAdditionalFields A comma delimited list of additional fields to add @param phDatabaseDataset The handle to the dataset with the schema information */
		CHARACTER AddTempTable (character, character, character, dataset)	Adds an additional temp-table to an existing Business Entity schema dataset Notes : This method does not create or update eBusinessEntity, does not persist the .bedgm and does not generate code @param pcDatabase The database name to add the temp-table from @param pcTableName The table name to add to the Business Entity @param pcAdditionalFields Additional fields to be added to the temp-table (comma delimited list) @param dsBusinessEntity The dataset with the schema information @return The name of the new temp-table */
		CHARACTER AddTempTable (handle, character, character, character, character, character)	Adds an additional temp-table to the current Business Entity schema dataset Notes : This method only adds the schema records (eTable/eField/eIndex) to dsBusinessEntity @param phDatabaseDataset The handle to the dataset with the schema information @param pcPackage The package of the Business Entity @param pcBusinessEntityName The Business Entity name to associate the temp-table with @param pcDatabase The database name to add the temp-table from @param pcTableName The table name to add to the Business Entity @param pcAdditionalFields Additional fields to be added to the temp-table (comma delimited list) @return The name of the new temp-table */
		CHARACTER BuildBusinessEntityName (logical, character)	Builds the name of a Business Entity
		CreateField (handle, logical)	Creates a field for a database field
		CreateIndex (handle)	Creates an eIndex record based on the database schema index definition
		GenerateBusinessEntities (character, character, character, character, logical, character, character)	Generates a list of Business Entities
		GenerateBusinessEntities (character, logical, character, character, character, logical, character, character, logical)	Generates a list of Business Entities
		GenerateBusinessEntity (character, character, character, character, character, dataset)	Generates a single Business Entity
		GenerateBusinessEntity (handle, character, character, character, character, character, character, character, character, logical)	Generates a single Business Entity
		CHARACTER GetIndexDataTypes (character, character)	Returns a comma delimited list of data types of the index fields
		OnStatusChanged (ProcessingStatusChangedEventArgs)	Raises the StatusChanged
		CHARACTER PathFromPackage (character)	Translates a package name into a file path
		SetSearchIndexes (character)	Sets the DefaultSearchCodeGeneration flags for indexes of a temp-table Notes : This is intentionally left blank for the batch generator @param pcTempTableName The name of the temp-table */

Top Event Summary

	Options	Name	Purpose
		StatusChanged (Object, ProcessingStatusChangedEventArgs)	Raised when the status of this component changes

Method Detail

Top

AddAdditionalFields (character, handle)

Purpose:	Adds additional fields specified by the caller to the current Business Entity schema
	Notes : This is a stub implementation and can be extended to parse and add fields

Parameters:
pcAdditionalFields	CHARACTER
	A comma delimited list of additional fields to add
phDatabaseDataset	HANDLE
	The handle to the dataset with the schema information

Top

CHARACTER AddTempTable (character, character, character, dataset)

Purpose:	Adds an additional temp-table to an existing Business Entity schema dataset
	Notes : This method does not create or update eBusinessEntity, does not persist the .bedgm and does not generate code

Parameters:
pcDatabase	CHARACTER
	The database name to add the temp-table from
pcTableName	CHARACTER
	The table name to add to the Business Entity
pcAdditionalFields	CHARACTER
	Additional fields to be added to the temp-table (comma delimited list)
dsBusinessEntity	DATASET dsBusinessEntity
	The dataset with the schema information
Returns	CHARACTER
	The name of the new temp-table

Top

CHARACTER AddTempTable (handle, character, character, character, character, character)

Purpose:	Adds an additional temp-table to the current Business Entity schema dataset
	Notes : This method only adds the schema records (eTable/eField/eIndex) to dsBusinessEntity

Parameters:
phDatabaseDataset	HANDLE
	The handle to the dataset with the schema information
pcPackage	CHARACTER
	The package of the Business Entity
pcBusinessEntityName	CHARACTER
	The Business Entity name to associate the temp-table with
pcDatabase	CHARACTER
	The database name to add the temp-table from
pcTableName	CHARACTER
	The table name to add to the Business Entity
pcAdditionalFields	CHARACTER
	Additional fields to be added to the temp-table (comma delimited list)
Returns	CHARACTER
	The name of the new temp-table

Top

CHARACTER BuildBusinessEntityName (logical, character)

Purpose:	Builds the name of a Business Entity
Notes:

Parameters:
plCamelcase	LOGICAL
	When true, the first letter of the table name will be forced to uppercase for the Business Entity Name
pcTableName	CHARACTER
	The name of the database table name
Returns	CHARACTER
	The base business Entity Name

Top

CreateField (handle, logical)

Purpose:	Creates a field for a database field
Notes:

Parameters:
phBuffer	HANDLE
	The handle to the eField buffer
plUpdateFieldOrder	LOGICAL
	If true, the field order is updated

Top

CreateIndex (handle)

Purpose:	Creates an eIndex record based on the database schema index definition
Notes:

Parameters:
phBuffer	HANDLE
	The handle to the eIndex buffer in the database schema dataset

Top

GenerateBusinessEntities (character, character, character, character, logical, character, character)

Purpose:	Generates a list of Business Entities
Notes:

Parameters:
pcPackage	CHARACTER
	The source package for the generated business entities
pcBusinessEntityNamePattern	CHARACTER
	The name pattern for the Business Entity class name, using &1 for the Table name
pcDataAccessNamePattern	CHARACTER
	The name pattern for the Data Access class name, using &1 for the Table name
pcDatasetControllerNamePattern	CHARACTER
	The name pattern for the Dataset Controller class name, using &1 for the Table name
plCamelcase	LOGICAL
	When true, the first letter of the table name will be forced to uppercase for the Business Entity Name
pcDatabase	CHARACTER
	The database name to generate business entities for
pcTableNames	CHARACTER
	The name pattern (using the CAN-DO function) the database tables need to match for being generated

Top

GenerateBusinessEntities (character, logical, character, character, character, logical, character, character, logical)

Purpose:	Generates a list of Business Entities
Notes:

Parameters:
pcPackage	CHARACTER
	The source package for the generated business entities
plCreateSubpackage	LOGICAL
	Create distinct sub-package per table
pcBusinessEntityNamePattern	CHARACTER
	The name pattern for the Business Entity class name, using &1 for the Table name
pcDataAccessNamePattern	CHARACTER
	The name pattern for the Data Access class name, using &1 for the Table name
pcDatasetControllerNamePattern	CHARACTER
	The name pattern for the Dataset Controller class name, using &1 for the Table name
plCamelcase	LOGICAL
	When true, the first letter of the table name will be forced to uppercase for the Business Entity Name
pcDatabase	CHARACTER
	The database name to generate business entities for
pcTableNames	CHARACTER
	The name pattern (using the CAN-DO function) the database tables need to match for being generated
plGenerateDatasetModel	LOGICAL
	Generate DatasetModel classes along with the Business Entity

Top

GenerateBusinessEntity (character, character, character, character, character, dataset)

Purpose:	Generates a single Business Entity
Notes:

Parameters:
pcBusinessEntityName	CHARACTER
	The base name for the Business Entity, Data Access and Dataset Controller class name
pcPackage	CHARACTER
	The source package for the generated business entities
pcDatabase	CHARACTER
	The database name to generate business entities for
pcTableName	CHARACTER
	The name of the database tables to be generated
pcAdditionalFields	CHARACTER
	The additional fields to be added to the Business Entity (comma delimited list)
dsBusinessEntity	DATASET dsBusinessEntity
	The dataset with the schema information

Top

GenerateBusinessEntity (handle, character, character, character, character, character, character, character, character, logical)

Purpose:	Generates a single Business Entity
Notes:

Parameters:
phDatabaseDataset	HANDLE
	The handle to the dataset with the schema information
pcPackage	CHARACTER
	The source package for the generated business entities
pcBusinessEntityName	CHARACTER
	The base name for the Business Entity, Data Access and Dataset Controller class name
pcBusinessEntityNamePattern	CHARACTER
	The name pattern for the Business Entity class name, using &1 for the Table name
pcDataAccessNamePattern	CHARACTER
	The name pattern for the Data Access class name, using &1 for the Table name
pcDatasetControllerNamePattern	CHARACTER
	The name pattern for the Dataset Controller class name, using &1 for the Table name
pcDatabase	CHARACTER
	The database name to generate business entities for
pcTableName	CHARACTER
	The name of the database tables to be generated
pcAdditionalFields	CHARACTER
	The additional fields to be added to the Business Entity (comma delimited list)
plGenerateDatasetModel	LOGICAL
	Generate DatasetModel classes along with the Business Entity

Top

CHARACTER GetIndexDataTypes (character, character)

Purpose:	Returns a comma delimited list of data types of the index fields
Notes:

Parameters:
pcTableName	CHARACTER
	The name of the temp-table
pcIndexFields	CHARACTER
	The comma delimited list of field names
Returns	CHARACTER
	The comma delimited list of data types

Top

OnStatusChanged (ProcessingStatusChangedEventArgs)

Purpose:	Raises the StatusChanged
Notes:

Parameters:
e	Consultingwerk.ProcessingStatusChangedEventArgs
	The ProcessingStatusChangedEventArgs with the data for the event

Top

CHARACTER PathFromPackage (character)

Purpose:	Translates a package name into a file path
Notes:

Parameters:
pcPackage	CHARACTER
	The Package to convert into a file path
Returns	CHARACTER
	The relative file path derived from the package name

Top

SetSearchIndexes (character)

Purpose:	Sets the DefaultSearchCodeGeneration flags for indexes of a temp-table
	Notes : This is intentionally left blank for the batch generator

Parameters:
pcTempTableName	CHARACTER
	The name of the temp-table

Event Detail

Top

StatusChanged (Object, ProcessingStatusChangedEventArgs)

Purpose:	Raised when the status of this component changes
Notes:

Parameters:
sender	Progress.Lang.Object
	The object that raised the StatusChanged event
e	Consultingwerk.ProcessingStatusChangedEventArgs
	The ProcessingStatusChangedEventArgs with the data for the event