Namespace: Consultingwerk.SmartFramework.Repository.Object
Class 
ObjectMasterDatasetModel Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.DatasetModel
Consultingwerk.SmartFramework.Repository.Object.ObjectMasterDatasetModel_Generated
Consultingwerk.SmartFramework.Repository.Object.ObjectMasterDatasetModel

Inherits: Consultingwerk.SmartFramework.Repository.Object.ObjectMasterDatasetModel_Generated

File:ObjectMaster
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:15/05/2016 23:17:24,078+02:00
Notes:Custom constructors that should not be replaced when the
DatasetModel class is regenerated, need to be annotated
using the @CustomConstructor. annotation

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ GetDataset (dataset-handle) Returns the Dataset to the caller
Inherited from Consultingwerk.OERA.DatasetModel
# Consultingwerk.OERA.DatasetModelPerformer NewDatasetModelPerformer (handle, character) Overridable factory method for the DatasetModelPerformer instance used by the DatasetModel instance
Inherited from Consultingwerk.OERA.DatasetModel
+ ObjectIsA (ObjectIsAParameter) Invokes the Business Entity Method ObjectIsA
Inherited from Consultingwerk.SmartFramework.Repository.Object.ObjectMasterDatasetModel_Generated
# OpenTableModelQueries () Opens the queries of all table models
Inherited from Consultingwerk.OERA.DatasetModel
+ Consultingwerk.OERA.DatasetModel RetrieveData (character, character) Retrieves data from the backend
Inherited from Consultingwerk.OERA.DatasetModel
+ Consultingwerk.OERA.DatasetModel RetrieveData (character, INamedQueryParameter) Retrieves data from the backend
Inherited from Consultingwerk.OERA.DatasetModel
+ RetrieveData (character, IQueryExpression) Retrieves data from the backend
Inherited from Consultingwerk.OERA.DatasetModel
+ Consultingwerk.OERA.DatasetModel RetrieveData (INamedQueryParameter) Retrieves data from the backend
Inherited from Consultingwerk.OERA.DatasetModel
+ Consultingwerk.OERA.DatasetModel SaveChanges () Performs Save Changes request either using the Service Adapter or the Service Interface
Inherited from Consultingwerk.OERA.DatasetModel
+ Consultingwerk.OERA.DatasetModel UseDatasetQueries () Ensures that all TableModels are using one of the ProDataset QUERY's
Inherited from Consultingwerk.OERA.DatasetModel

Top Constructor Summary
Options Name Purpose
+ ObjectMasterDatasetModel () Constructor for the ObjectMasterDatasetModel class
+ ObjectMasterDatasetModel (character) Constructor for the ObjectMasterDatasetModel class
+ ObjectMasterDatasetModel (character, INamedQueryParameter) Constructor for the ObjectMasterDatasetModel class
+ ObjectMasterDatasetModel (INamedQueryParameter) Constructor for the ObjectMasterDatasetModel class

Top Property Summary
Options Name Purpose
+ CHARACTER AppServerPartition Gets/Sets the name of the AppServer Partition to be used by this DatasetModel
Inherited from Consultingwerk.OERA.DatasetModel
+ INTEGER BatchSize Gets/Sets the BatchSize used when reading data from the Business Entity.
Inherited from Consultingwerk.OERA.DatasetModel
+ HANDLE DatasetHandle Returns a reference to the primary Dataset owned by the DatasetController
Inherited from Consultingwerk.OERA.DatasetModel
+ A CHARACTER EntityName Name of the BusinessEntity.
Overrides Consultingwerk.SmartFramework.Repository.Object.ObjectMasterDatasetModel_Generated:EntityName
+ LOGICAL HasChanges Returns logical value indicating if the Dataset has changes
Inherited from Consultingwerk.OERA.DatasetModel
+ LOGICAL NextBatchAvailable Returns is a next batch of records is available
Inherited from Consultingwerk.OERA.DatasetModel
+ Consultingwerk.OERA.DatasetModelPerformer Performer Returns the reference to the DatasetModelPerformer instance of this dataset model
Inherited from Consultingwerk.OERA.DatasetModel
+ Consultingwerk.SmartFramework.Repository.Object.SmartLinkTableModel SmartLink Returns the reference to the SmartLink table model
Inherited from Consultingwerk.SmartFramework.Repository.Object.ObjectMasterDatasetModel_Generated
+ Consultingwerk.SmartFramework.Repository.Object.SmartObjectInstanceTableModel SmartObjectInstance Returns the reference to the SmartObjectInstance table model
Inherited from Consultingwerk.SmartFramework.Repository.Object.ObjectMasterDatasetModel_Generated
+ Consultingwerk.SmartFramework.Repository.Object.SmartObjectMasterTableModel SmartObjectMaster Returns the reference to the SmartObjectMaster table model
Inherited from Consultingwerk.SmartFramework.Repository.Object.ObjectMasterDatasetModel_Generated
+ Consultingwerk.SmartFramework.Repository.Object.SmartPageTableModel SmartPage Returns the reference to the SmartPage table model
Inherited from Consultingwerk.SmartFramework.Repository.Object.ObjectMasterDatasetModel_Generated
+ INTEGER StopAfter Gets and sets the STOP-AFTER value used when reading data from the Business Entity.
Inherited from Consultingwerk.OERA.DatasetModel
+ Consultingwerk.OERA.ListTableModel TableModels Returns the List of TableModels
Inherited from Consultingwerk.OERA.DatasetModel
+ LOGICAL TrackingChanges Gets and sets if the Dataset Model's ProDataset is TRACKING-CHANGES
Inherited from Consultingwerk.OERA.DatasetModel
+ LOGICAL UseDedicatedBusinessEntity Gets and sets if the DatasetModel is communicating with a dedicated Business Entity instance
Inherited from Consultingwerk.OERA.DatasetModel
+ Consultingwerk.OERA.UseInterfaceEnum UseInterface /*- Purpose: Gets and sets the Interface this DatasetModel uses for Business Entity Requests Notes: Default depends on NUM-DBS > 0, then ServiceInterface else ServiceAdapter */
Inherited from Consultingwerk.OERA.DatasetModel


Method Detail
Top

PUBLIC GetDataset (dataset-handle)
Inherited from Consultingwerk.OERA.DatasetModel
Purpose: Returns the Dataset to the caller
Notes:

Parameters:
hDataset DATASET-HANDLE
The Dataset to be returned to the caller
Top

PROTECTED Consultingwerk.OERA.DatasetModelPerformer NewDatasetModelPerformer (handle, character)
Inherited from Consultingwerk.OERA.DatasetModel
Purpose: Overridable factory method for the DatasetModelPerformer instance
used by the DatasetModel instance
Notes: Allows customers, to return instances of custom DatasetModelPerformer
classes

Parameters:
phDataset HANDLE
The handle of the ProDataset from the model class
pcEntityName CHARACTER
The name of the Business Entity
Returns Consultingwerk.OERA.DatasetModelPerformer
The reference to the new DatasetModelPerformer instance
Top

PUBLIC ObjectIsA (ObjectIsAParameter)
Inherited from Consultingwerk.SmartFramework.Repository.Object.ObjectMasterDatasetModel_Generated
Purpose: Invokes the Business Entity Method ObjectIsA
Notes: Receives the dataset ObjectIsA from the backend

Parameters:
poParameter Consultingwerk.SmartFramework.Repository.Object.ObjectIsAParameter
The Parameter Object for this method
Top

PROTECTED OpenTableModelQueries ()
Inherited from Consultingwerk.OERA.DatasetModel
Purpose: Opens the queries of all table models
Notes:

Top

PUBLIC Consultingwerk.OERA.DatasetModel RetrieveData (character, character)
Inherited from Consultingwerk.OERA.DatasetModel
Purpose: Retrieves data from the backend
Notes:

Parameters:
pcTables CHARACTER
The comma delimited list of the Table Names to retrieve
pcQueryString CHARACTER
The query string to use for the first table
Returns Consultingwerk.OERA.DatasetModel
The reference to the DatasetModel instance itself
Top

PUBLIC Consultingwerk.OERA.DatasetModel RetrieveData (character, INamedQueryParameter)
Inherited from Consultingwerk.OERA.DatasetModel
Purpose: Retrieves data from the backend
Notes:

Parameters:
pcTables CHARACTER
The comma delimited list of the Table Names to retrieve
poNamedQuery Consultingwerk.OERA.INamedQueryParameter
The INamedQueryParameter that defines a named query
Returns Consultingwerk.OERA.DatasetModel
The reference to the DatasetModel instance itself
Top

PUBLIC RetrieveData (character, IQueryExpression)
Inherited from Consultingwerk.OERA.DatasetModel
Purpose: Retrieves data from the backend
Notes:

Parameters:
pcTables CHARACTER
The comma delimited list of the Table Names to retrieve
poQueryExpression IQueryExpression
The query expression to use for the first table
Top

PUBLIC Consultingwerk.OERA.DatasetModel RetrieveData (INamedQueryParameter)
Inherited from Consultingwerk.OERA.DatasetModel
Purpose: Retrieves data from the backend
Notes:

Parameters:
poNamedQuery Consultingwerk.OERA.INamedQueryParameter
The INamedQueryParameter that defines a named query
Returns Consultingwerk.OERA.DatasetModel
The reference to the DatasetModel instance itself
Top

PUBLIC Consultingwerk.OERA.DatasetModel SaveChanges ()
Inherited from Consultingwerk.OERA.DatasetModel
Purpose: Performs Save Changes request either using the Service Adapter or the
Service Interface
Notes:

Returns Consultingwerk.OERA.DatasetModel
The reference to the DatasetModel instance itself
Top

PUBLIC Consultingwerk.OERA.DatasetModel UseDatasetQueries ()
Inherited from Consultingwerk.OERA.DatasetModel
Purpose: Ensures that all TableModels are using one of the ProDataset QUERY's
Notes: Invokes UseDatasetQuery() in all TableModels

Returns Consultingwerk.OERA.DatasetModel
The reference to the DatasetModel instance itself


Constructor Detail
Top

PUBLIC ObjectMasterDatasetModel ()
Purpose: Constructor for the ObjectMasterDatasetModel class
Notes:

Top

PUBLIC ObjectMasterDatasetModel (character)
Purpose: Constructor for the ObjectMasterDatasetModel class
Notes:

Parameters:
pObjectMasterGuid CHARACTER
The filter value for the eSmartObjectMaster.ObjectMasterGuid field
Top

PUBLIC ObjectMasterDatasetModel (character, INamedQueryParameter)
Purpose: Constructor for the ObjectMasterDatasetModel class
Notes: Retrieves data based on a named query

Parameters:
pcTables CHARACTER
The comma delimited list of the Table Names to retrieve
poNamedQuery Consultingwerk.OERA.INamedQueryParameter
The INamedQueryParameter that defines a named query
Top

PUBLIC ObjectMasterDatasetModel (INamedQueryParameter)
Purpose: Constructor for the ObjectMasterDatasetModel class
Notes: Retrieves data based on a named query

Parameters:
poNamedQuery Consultingwerk.OERA.INamedQueryParameter
The INamedQueryParameter that defines a named query


Property Detail
Top

PUBLIC CHARACTER AppServerPartition
Inherited from Consultingwerk.OERA.DatasetModel
Purpose: Gets/Sets the name of the AppServer Partition to be used
by this DatasetModel
Notes: Only relevant when running on the client side (no databases connected)

Returns CHARACTER
Top

PUBLIC INTEGER BatchSize
Inherited from Consultingwerk.OERA.DatasetModel
Purpose: Gets/Sets the BatchSize used when reading data from the Business
Entity.
Notes: Set to 0 to fetch all data and disable Batching

Returns INTEGER
Top

PUBLIC HANDLE DatasetHandle
Inherited from Consultingwerk.OERA.DatasetModel
Purpose: Returns a reference to the primary Dataset owned by the DatasetController
Notes:

Returns HANDLE
Top

PUBLIC CHARACTER EntityName
Overrides Consultingwerk.SmartFramework.Repository.Object.ObjectMasterDatasetModel_Generated:EntityName
Purpose: Name of the BusinessEntity.
Notes: This Property needs to be set by actual Dataset model implementation

Returns CHARACTER
Top

PUBLIC LOGICAL HasChanges
Inherited from Consultingwerk.OERA.DatasetModel
Purpose: Returns logical value indicating if the Dataset has changes
Notes: Based on DatasetHelper:HasChanges

Returns LOGICAL
Top

PUBLIC LOGICAL NextBatchAvailable
Inherited from Consultingwerk.OERA.DatasetModel
Purpose: Returns is a next batch of records is available
Notes:

Returns LOGICAL
Top

PUBLIC Consultingwerk.OERA.DatasetModelPerformer Performer
Inherited from Consultingwerk.OERA.DatasetModel
Purpose: Returns the reference to the DatasetModelPerformer instance of this
dataset model
Notes: The DatasetModelPerformer performs the actual communication with the
Business Entity

Returns Consultingwerk.OERA.DatasetModelPerformer
Top

PUBLIC Consultingwerk.SmartFramework.Repository.Object.SmartLinkTableModel SmartLink
Inherited from Consultingwerk.SmartFramework.Repository.Object.ObjectMasterDatasetModel_Generated
Purpose: Returns the reference to the SmartLink table model
Notes:

Returns Consultingwerk.SmartFramework.Repository.Object.SmartLinkTableModel
Top

PUBLIC Consultingwerk.SmartFramework.Repository.Object.SmartObjectInstanceTableModel SmartObjectInstance
Inherited from Consultingwerk.SmartFramework.Repository.Object.ObjectMasterDatasetModel_Generated
Purpose: Returns the reference to the SmartObjectInstance table model
Notes:

Returns Consultingwerk.SmartFramework.Repository.Object.SmartObjectInstanceTableModel
Top

PUBLIC Consultingwerk.SmartFramework.Repository.Object.SmartObjectMasterTableModel SmartObjectMaster
Inherited from Consultingwerk.SmartFramework.Repository.Object.ObjectMasterDatasetModel_Generated
Purpose: Returns the reference to the SmartObjectMaster table model
Notes:

Returns Consultingwerk.SmartFramework.Repository.Object.SmartObjectMasterTableModel
Top

PUBLIC Consultingwerk.SmartFramework.Repository.Object.SmartPageTableModel SmartPage
Inherited from Consultingwerk.SmartFramework.Repository.Object.ObjectMasterDatasetModel_Generated
Purpose: Returns the reference to the SmartPage table model
Notes:

Returns Consultingwerk.SmartFramework.Repository.Object.SmartPageTableModel
Top

PUBLIC INTEGER StopAfter
Inherited from Consultingwerk.OERA.DatasetModel
Purpose: Gets and sets the STOP-AFTER value used when reading data from the
Business Entity.
Notes: Set to 0 to disable STOP-AFTER

Returns INTEGER
Top

PUBLIC Consultingwerk.OERA.ListTableModel TableModels
Inherited from Consultingwerk.OERA.DatasetModel
Purpose: Returns the List of TableModels
Notes:

Returns Consultingwerk.OERA.ListTableModel
Top

PUBLIC LOGICAL TrackingChanges
Inherited from Consultingwerk.OERA.DatasetModel
Purpose: Gets and sets if the Dataset Model's ProDataset is TRACKING-CHANGES
Notes:

Returns LOGICAL
Top

PUBLIC LOGICAL UseDedicatedBusinessEntity
Inherited from Consultingwerk.OERA.DatasetModel
Purpose: Gets and sets if the DatasetModel is communicating with a dedicated
Business Entity instance
Notes: Required, when using the DatasetModel from within the actual Business
Entity itself. As otherwise the read operations done through the
DatasetModel instance to the Business Entity would clear the dataset
within the Business Entity. Only applicable, when UseInterface =
ServiceInterface

Returns LOGICAL
Top

PUBLIC Consultingwerk.OERA.UseInterfaceEnum UseInterface
Inherited from Consultingwerk.OERA.DatasetModel
Purpose: Gets and sets the Interface this DatasetModel uses for Business
Entity Requests
Notes: Default depends on NUM-DBS > 0, then ServiceInterface else ServiceAdapter

Returns Consultingwerk.OERA.UseInterfaceEnum


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:39:57