Top Method Summary
Options Name Purpose
LOGICAL AppendEventHandlerMethod (character, character, character, RepositoryEventDescriptor) Appends a client-side event handler method to a Logic Object class
LOGICAL AppendServerSideEventHandlerMethod (character, character, character, character, RepositoryEventDescriptor) Appends a server-side event handler method to a Business Task class
CHARACTER GenerateLogicObject (character, character, character, character, logical) Generates the Logic Object class of a repository container
CHARACTER GenerateServerSideEventHandler (character, character, character, character, character, character, logical) Generates the server-side event handler Business Task of a repository container
CHARACTER GetDatasetName (character) Returns the name of the ProDataset a server-side event handler class operates on
CHARACTER GetDataSourceEntityName (character) Returns the Business Entity a MetaDataSource object master is bound to
INTEGER GetMethodLineNumber (character, character) Returns the line number a method of the given class file is declared in
LOGICAL HasMethod (character, character) Returns if the given class file already declares a method of that name
CHARACTER ProposeMethodName (character, character, character, character) Returns the proposed name of an event handler method
ResolveDataset (character, character, character) Resolves the ProDataset include file and dataset name of a Business Entity

Top Property Summary
Options Name Purpose
CHARACTER OutputFolder


Method Detail
Top

LOGICAL AppendEventHandlerMethod (character, character, character, RepositoryEventDescriptor)

Purpose: Appends a client-side event handler method to a Logic Object class
Notes: The method is inserted before the closing end class statement. When the
class already declares a method of that name nothing is written

Parameters:
pcFileName CHARACTER
The name of the Logic Object class file
pcMethodName CHARACTER
The name of the event handler method
pcInstanceName CHARACTER
The name of the object instance raising the event, empty for object master level events
poEvent Consultingwerk.SmartFramework.Repository.RepositoryEventDescriptor
The RepositoryEventDescriptor of the event
Returns LOGICAL
Logical value indicating if the method has been added
Top

LOGICAL AppendServerSideEventHandlerMethod (character, character, character, character, RepositoryEventDescriptor)

Purpose: Appends a server-side event handler method to a Business Task class
Notes: The method is inserted before the closing end class statement. When the
class already declares a method of that name nothing is written

Parameters:
pcFileName CHARACTER
The name of the event handler class file
pcMethodName CHARACTER
The name of the event handler method
pcInstanceName CHARACTER
The name of the object instance raising the event, empty for object master level events
pcDatasetName CHARACTER
The name of the ProDataset of the event handler class
poEvent Consultingwerk.SmartFramework.Repository.RepositoryEventDescriptor
The RepositoryEventDescriptor of the event
Returns LOGICAL
Logical value indicating if the method has been added
Top

CHARACTER GenerateLogicObject (character, character, character, character, logical)

Purpose: Generates the Logic Object class of a repository container
Notes: Returns the unknown value when the file exists and plOverwrite is false

Parameters:
pcPackageName CHARACTER
The package name of the Logic Object class
pcClassName CHARACTER
The class name of the Logic Object class
pcObjectType CHARACTER
The object type of the container (MetaForm, MetaControlGroup, MetaViewer or MetaGrid)
pcAuthor CHARACTER
The author to write into the file header
plOverwrite LOGICAL
Logical value indicating if an existing file may be overwritten
Returns CHARACTER
The name of the generated class file or ? when nothing was generated
Top

CHARACTER GenerateServerSideEventHandler (character, character, character, character, character, character, logical)

Purpose: Generates the server-side event handler Business Task of a repository container
Notes: The ProDataset include and the dataset name are mandatory - the
generated class always carries a working include and GetDataset
method. Use ResolveDataset to obtain them from a Business Entity

Parameters:
pcPackageName CHARACTER
The package name of the event handler class
pcClassName CHARACTER
The class name of the event handler class
pcContainerName CHARACTER
The name of the repository container the handler belongs to
pcDatasetIncludeFile CHARACTER
The relative name of the ProDataset include file
pcDatasetName CHARACTER
The name of the ProDataset
pcAuthor CHARACTER
The author to write into the file header
plOverwrite LOGICAL
Logical value indicating if an existing file may be overwritten
Returns CHARACTER
The name of the generated class file or ? when nothing was generated
Top

CHARACTER GetDatasetName (character)

Purpose: Returns the name of the ProDataset a server-side event handler class operates on
Notes: Reads the dataset name from the GetDataset method of the class

Parameters:
pcFileName CHARACTER
The name of the event handler class file
Returns CHARACTER
The name of the ProDataset or the empty string when it cannot be determined
Top

CHARACTER GetDataSourceEntityName (character)

Purpose: Returns the Business Entity a MetaDataSource object master is bound to
Notes: Reads the EntityName attribute of the data source object master

Parameters:
pcDataSourceObjectMaster CHARACTER
The name or GUID of the MetaDataSource object master
Returns CHARACTER
The fully qualified name of the Business Entity, or the empty string
Top

INTEGER GetMethodLineNumber (character, character)

Purpose: Returns the line number a method of the given class file is declared in
Notes: SCL-5669 - allows the Object Master Designer to open an existing
event handler method in the IDE. Comments and string literals are
masked out before the source is scanned

Parameters:
pcFileName CHARACTER
The name of the class file to inspect
pcMethodName CHARACTER
The name of the method to look for
Returns INTEGER
The line number of the method declaration or 0 when it is not declared
Top

LOGICAL HasMethod (character, character)

Purpose: Returns if the given class file already declares a method of that name
Notes: Comments and string literals are masked out before the source is scanned

Parameters:
pcFileName CHARACTER
The name of the class file to inspect
pcMethodName CHARACTER
The name of the method to look for
Returns LOGICAL
Logical value indicating if the method is already declared
Top

CHARACTER ProposeMethodName (character, character, character, character)

Purpose: Returns the proposed name of an event handler method
Notes: Instance level events are named <InstanceName>@lt;EventName>Handler,
object master level events <EventName>Handler, falling back to
<ObjectName>@lt;EventName>Handler when that name is taken

Parameters:
pcFileName CHARACTER
The name of the class file the method is added to
pcObjectName CHARACTER
The name of the repository object master
pcInstanceName CHARACTER
The name of the object instance, empty for object master level events
pcEventName CHARACTER
The name of the event
Returns CHARACTER
The proposed method name
Top

ResolveDataset (character, character, character)

Purpose: Resolves the ProDataset include file and dataset name of a Business Entity
Notes: Reads the Business Entity Designer model file (.bedgm) next to the
Business Entity class first, and falls back to instantiating the
Business Entity and reading the name off IBusinessEntity:FetchDataset.
Throws when neither resolves an include file that exists on the PROPATH

Parameters:
pcBusinessEntityName CHARACTER
The fully qualified name of the Business Entity
pcIncludeFile CHARACTER
The relative name of the ProDataset include file
pcDatasetName CHARACTER
The name of the ProDataset


Property Detail
Top

CHARACTER OutputFolder


Returns CHARACTER


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       24.08.2026 05:56:10