Namespace: Consultingwerk.SmartFramework.Repository.ScreenWizard
Class 
ScreenWizardBusinessTask Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.BusinessTask
Consultingwerk.SmartFramework.Repository.ScreenWizard.ScreenWizardBusinessTask

Inherits: Consultingwerk.OERA.BusinessTask
Implements: Consultingwerk.OERA.IBusinessService, ISupportsRestMethods


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
Consultingwerk.CharacterHolder CreateDataSource (CreateDataSourceParameter) Creates a MetaDataSource for a Business Entity
Consultingwerk.CharacterHolder CreateFormFromTemplate (CreateFormFromTemplateParameter) Creates a form from a repository template with a single data source, viewer and grid placeholder
Consultingwerk.LogicalHolder DataSourceHasMissingFields (CharacterHolder) Returns if not all fields of the EntityTable and EntityView of a data source exist as data fields in the repository
GetBusinessEntities (dataset, LogicalHolder) Returns the names of the Business Entity classes (classes implementing IBusinessEntity, abstract classes excluded)
Consultingwerk.OERA.IDataSourceInfo GetDataSourceInfo (CharacterHolder) Returns the information about a MetaDataSource
GetDataSources (dataset, CharacterHolder) Returns the MetaDataSource object masters of a Business Entity
CHARACTER GetDataSourceTables (IDataSourceInfo) Returns the EntityTable and EntityView of a data source as a comma delimited list
Consultingwerk.BusinessEntityDesigner.Mcp.BusinessEntityDesignerMcpBusinessTask GetDesignerTask () Returns the Business Entity Designer Business Task that creates and verifies the data fields of a Business Entity
GetDesignObjects (dataset, GetDesignObjectsParameter) Returns the object masters of the given object type (and derived types) that use a data source as their design time data source
Consultingwerk.CharacterHolder GetMissingDataFields (CharacterHolder) Returns the fields of the EntityTable and EntityView of a data source that do not exist as data fields in the repository
GetWizardTemplates (dataset, GetWizardTemplatesParameter) Returns the repository templates the screen generation wizard can create a form from
Consultingwerk.CharacterHolder ImportDataFields (ImportDataFieldsParameter) Creates the missing data fields of the EntityTable and EntityView of a data source in the repository


Method Detail
Top

Consultingwerk.CharacterHolder CreateDataSource (CreateDataSourceParameter)
Purpose: Creates a MetaDataSource for a Business Entity
Notes: Validates the EntityTable and EntityView against the Business Entity
and sets the PartialDataset attribute when the EntityTable is not a
top level buffer of the dataset. The ObjectType defaults to MetaDataSource,
the Description to "DataSource for <Business Entity>"

Parameters:
poParameter Consultingwerk.SmartFramework.Repository.ScreenWizard.CreateDataSourceParameter
The CreateDataSourceParameter with the data for this call
Returns Consultingwerk.CharacterHolder
The CharacterHolder with the GUID of the new MetaDataSource object master
Top

Consultingwerk.CharacterHolder CreateFormFromTemplate (CreateFormFromTemplateParameter)
Purpose: Creates a form from a repository template with a single data source,
viewer and grid placeholder
Notes: The data source placeholder receives the DataSourceName, a viewer
placeholder (MetaViewer or derived) the ViewerName and a grid placeholder
(MetaGrid or derived) the GridName. The proposed object properties (TITLE,
ForeignFields, page labels) are accepted without changes, like in the
New-from-template wizard when the user does not modify them

Parameters:
poParameter Consultingwerk.SmartFramework.Repository.ScreenWizard.CreateFormFromTemplateParameter
The CreateFormFromTemplateParameter with the data for this call
Returns Consultingwerk.CharacterHolder
The CharacterHolder with the GUID of the new object master
Top

Consultingwerk.LogicalHolder DataSourceHasMissingFields (CharacterHolder)
Purpose: Returns if not all fields of the EntityTable and EntityView of a data
source exist as data fields in the repository
Notes: See GetMissingDataFields

Parameters:
poDataSourceName Consultingwerk.CharacterHolder
The CharacterHolder with the name of the MetaDataSource
Returns Consultingwerk.LogicalHolder
The LogicalHolder with the value true when data fields are missing
Top

GetBusinessEntities (dataset, LogicalHolder)
Purpose: Returns the names of the Business Entity classes (classes implementing
IBusinessEntity, abstract classes excluded)
Notes: Reads the class name cache of the session (SCL-5991). With a TRUE value
the cache is rebuilt first, e.g. after new Business Entities have been
added

Parameters:
dsClassNames DATASET dsClassNames
The dataset with the class names
poRefresh Consultingwerk.LogicalHolder
The LogicalHolder with the value true to rebuild the class name cache first
Top

Consultingwerk.OERA.IDataSourceInfo GetDataSourceInfo (CharacterHolder)
Purpose: Returns the information about a MetaDataSource
Notes:

Parameters:
poDataSourceName Consultingwerk.CharacterHolder
The CharacterHolder with the name of the MetaDataSource
Returns Consultingwerk.OERA.IDataSourceInfo
The IDataSourceInfo of the data source
Top

GetDataSources (dataset, CharacterHolder)
Purpose: Returns the MetaDataSource object masters of a Business Entity
Notes: Returns the data sources with the given EntityName attribute together
with their EntityTable and EntityView

Parameters:
dsWizardDataSource DATASET dsWizardDataSource
The dataset with the data sources
poEntityName Consultingwerk.CharacterHolder
The CharacterHolder with the name of the Business Entity
Top

CHARACTER GetDataSourceTables (IDataSourceInfo)
Purpose: Returns the EntityTable and EntityView of a data source as a comma
delimited list
Notes:

Parameters:
poDataSourceInfo Consultingwerk.OERA.IDataSourceInfo
The IDataSourceInfo of the data source
Returns CHARACTER
The comma delimited list of the tables of the data source
Top

Consultingwerk.BusinessEntityDesigner.Mcp.BusinessEntityDesignerMcpBusinessTask GetDesignerTask ()
Purpose: Returns the Business Entity Designer Business Task that creates and
verifies the data fields of a Business Entity
Notes:

Returns Consultingwerk.BusinessEntityDesigner.Mcp.BusinessEntityDesignerMcpBusinessTask
The BusinessEntityDesignerMcpBusinessTask instance
Top

GetDesignObjects (dataset, GetDesignObjectsParameter)
Purpose: Returns the object masters of the given object type (and derived types)
that use a data source as their design time data source
Notes: Used for the list of the viewers (MetaViewer) and grids (MetaGrid) of
a data source. FieldNames receives the comma delimited instance names
(the fields) of each object master. Customized variants of an object
master are not returned

Parameters:
dsWizardDesignObject DATASET dsWizardDesignObject
The dataset with the object masters
poParameter Consultingwerk.SmartFramework.Repository.ScreenWizard.GetDesignObjectsParameter
The GetDesignObjectsParameter with the data for this call
Top

Consultingwerk.CharacterHolder GetMissingDataFields (CharacterHolder)
Purpose: Returns the fields of the EntityTable and EntityView of a data source
that do not exist as data fields in the repository
Notes: Applies the naming convention of ISmartRepositoryService:CreateDataFields,
data fields are named <TempTable>.<Field>. Virtual fields are ignored

Parameters:
poDataSourceName Consultingwerk.CharacterHolder
The CharacterHolder with the name of the MetaDataSource
Returns Consultingwerk.CharacterHolder
The CharacterHolder with the comma delimited list of the missing data fields, empty when all exist
Top

GetWizardTemplates (dataset, GetWizardTemplatesParameter)
Purpose: Returns the repository templates the screen generation wizard can
create a form from
Notes: A template qualifies when its placeholders are exactly one data source
(MetaDataSource) plus at most one viewer (MetaViewer) and at most one grid
(MetaGrid) placeholder, with at least a viewer or a grid placeholder. A
template with a viewer placeholder is only returned when ViewerAvailable is
true, a template with a grid placeholder only when GridAvailable is true -
so every returned template can be filled from the current selection.
Only ttTemplate is returned

Parameters:
dsTemplates DATASET dsTemplates
The dataset with the templates
poParameter Consultingwerk.SmartFramework.Repository.ScreenWizard.GetWizardTemplatesParameter
The GetWizardTemplatesParameter with the data for this call
Top

Consultingwerk.CharacterHolder ImportDataFields (ImportDataFieldsParameter)
Purpose: Creates the missing data fields of the EntityTable and EntityView of a
data source in the repository
Notes: Existing data fields are not overwritten. Uses the .bedgm file of the
Business Entity when available (MetaDataField and MetaCalculatedField
based on the field source), otherwise the ProDataset of the class
(all fields as MetaDataField)

Parameters:
poParameter Consultingwerk.SmartFramework.Repository.ScreenWizard.ImportDataFieldsParameter
The ImportDataFieldsParameter with the data for this call
Returns Consultingwerk.CharacterHolder
The CharacterHolder with the comma delimited list of the data fields that are still missing, empty when all exist


ProDataset Detail

ProDataset dsClassNames

Member tables: ttClassNames

ProDataset dsTemplates

Member tables: ttTemplate, ttPlaceHolder, ttObjectProperty

ProDataset dsWizardDataSource

Member tables: ttWizardDataSource

ProDataset dsWizardDesignObject

Member tables: ttWizardDesignObject


Temp-Table Detail

Temp-Table ttClassNames

Defined in:

Temp-Table ttObjectProperty

Defined in:

Temp-Table ttPlaceHolder

Defined in:

Temp-Table ttTemplate

Defined in:

Temp-Table ttWizardDataSource

Defined in:

Temp-Table ttWizardDesignObject

Defined in:


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       09.11.2026 08:12:04