Namespace: Consultingwerk.OERA
Class 
DatasetModel Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.DatasetModel

Inherits: Progress.Lang.Object
Inherited by: Consultingwerk.SmartFramework.Authentication.UserDatasetModel_Generated, Consultingwerk.SmartFramework.Authentication.UserDatasetModel, Consultingwerk.SmartFramework.Authorization.FieldSecurityItemDatasetModel_Generated, Consultingwerk.SmartFramework.Authorization.FieldSecurityItemDatasetModel, Consultingwerk.SmartFramework.Authorization.GroupDatasetModel_Generated, Consultingwerk.SmartFramework.Authorization.GroupDatasetModel, Consultingwerk.SmartFramework.Authorization.MenuGroupDatasetModel_Generated, Consultingwerk.SmartFramework.Authorization.MenuGroupDatasetModel, Consultingwerk.SmartFramework.Authorization.SecurityAssignmentDatasetModel_Generated, Consultingwerk.SmartFramework.Authorization.SecurityAssignmentDatasetModel, Consultingwerk.SmartFramework.Authorization.SecurityRealmDatasetModel_Generated, Consultingwerk.SmartFramework.Authorization.SecurityRealmDatasetModel, Consultingwerk.SmartFramework.Authorization.SecurityTokenDatasetModel_Generated, Consultingwerk.SmartFramework.Authorization.SecurityTokenDatasetModel, Consultingwerk.SmartFramework.Authorization.ToolbarSecurityItemDatasetModel_Generated, Consultingwerk.SmartFramework.Authorization.ToolbarSecurityItemDatasetModel, Consultingwerk.SmartFramework.Authorization.UserGroupDatasetModel_Generated, Consultingwerk.SmartFramework.Authorization.UserGroupDatasetModel, Consultingwerk.SmartFramework.Scheduler.SchedulerJobPlanDatasetModel_Generated, Consultingwerk.SmartFramework.Scheduler.SchedulerJobPlanDatasetModel, Consultingwerk.SmartFramework.Scheduler.SchedulerJobStatusDatasetModel_Generated, Consultingwerk.SmartFramework.Scheduler.SchedulerJobStatusDatasetModel, Consultingwerk.SmartFramework.System.AttachmentDatasetModel_Generated, Consultingwerk.SmartFramework.System.AttachmentDatasetModel, Consultingwerk.SmartFramework.System.AttachmentRoleDatasetModel_Generated, Consultingwerk.SmartFramework.System.AttachmentRoleDatasetModel, Consultingwerk.SmartFramework.System.CommentRoleDatasetModel_Generated, Consultingwerk.SmartFramework.System.CommentRoleDatasetModel, Consultingwerk.SmartFramework.System.DeletionDatasetModel_Generated, Consultingwerk.SmartFramework.System.DeletionDatasetModel, Consultingwerk.SmartFramework.System.KeyFieldAssignmentTypeDatasetModel_Generated, Consultingwerk.SmartFramework.System.KeyFieldAssignmentTypeDatasetModel, Consultingwerk.SmartFramework.System.LanguageDatasetModel_Generated, Consultingwerk.SmartFramework.System.LanguageDatasetModel, Consultingwerk.SmartFramework.System.LoginCompanyDatasetModel_Generated, Consultingwerk.SmartFramework.System.LoginCompanyDatasetModel, Consultingwerk.SmartFramework.System.MessageDatasetModel_Generated, Consultingwerk.SmartFramework.System.MessageDatasetModel, Consultingwerk.SmartFramework.System.RelationDatasetModel_Generated, Consultingwerk.SmartFramework.System.RelationDatasetModel, Consultingwerk.SmartFramework.System.SmartBusinessEntityDatasetModel_Generated, Consultingwerk.SmartFramework.System.SmartBusinessEntityDatasetModel, Consultingwerk.SmartFramework.System.TableDatasetModel_Generated, Consultingwerk.SmartFramework.System.TableDatasetModel, Consultingwerk.SmartFramework.System.TranslationDatasetModel_Generated, Consultingwerk.SmartFramework.System.TranslationDatasetModel, Consultingwerk.SmartFramework.System.UiTranslationDatasetModel_Generated, Consultingwerk.SmartFramework.System.UiTranslationDatasetModel, Consultingwerk.SmartFramework.System.ValueListDatasetModel_Generated, Consultingwerk.SmartFramework.System.ValueListDatasetModel, Consultingwerk.SmartFramework.Context.ContextStoreDatasetModel_Generated, Consultingwerk.SmartFramework.Context.ContextStoreDatasetModel, Consultingwerk.SmartFramework.Localization.StringResourcesDatasetModel_Generated, Consultingwerk.SmartFramework.Localization.StringResourcesDatasetModel, Consultingwerk.SmartFramework.Menu.MenuDatasetModel_Generated, Consultingwerk.SmartFramework.Menu.MenuDatasetModel, Consultingwerk.SmartFramework.Menu.MenuStyleDatasetModel_Generated, Consultingwerk.SmartFramework.Menu.MenuStyleDatasetModel, Consultingwerk.SmartFramework.Menu.ModuleDatasetModel_Generated, Consultingwerk.SmartFramework.Menu.ModuleDatasetModel, Consultingwerk.SmartFramework.Menu.ProductDatasetModel_Generated, Consultingwerk.SmartFramework.Menu.ProductDatasetModel, Consultingwerk.SmartFramework.Repository.Class.AttributeDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.Class.AttributeDatasetModel, Consultingwerk.SmartFramework.Repository.Class.AttributeGroupDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.Class.AttributeGroupDatasetModel, Consultingwerk.SmartFramework.Repository.Class.AttributeValueDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.Class.AttributeValueDatasetModel, Consultingwerk.SmartFramework.Repository.Class.ClassTypeDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.Class.ClassTypeDatasetModel, Consultingwerk.SmartFramework.Repository.Class.LinkTypeDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.Class.LinkTypeDatasetModel, Consultingwerk.SmartFramework.Repository.Class.ObjectTypeDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.Class.ObjectTypeDatasetModel, Consultingwerk.SmartFramework.Repository.Class.SupportedLinkDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.Class.SupportedLinkDatasetModel, Consultingwerk.SmartFramework.Repository.Customization.CustomizationDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.Customization.CustomizationDatasetModel, Consultingwerk.SmartFramework.Repository.Customization.CustomizationTypeDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.Customization.CustomizationTypeDatasetModel, Consultingwerk.SmartFramework.Repository.Object.ObjectMasterDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.Object.ObjectMasterDatasetModel, Consultingwerk.SmartFramework.Scheduler.SchedulerJobDatasetModel_Generated, Consultingwerk.SmartFramework.Scheduler.SchedulerJobDatasetModel
ABSTRACT

File:DatasetModel
Purpose:Model base class for a Dataset
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sat Jun 15 01:42:38 CEST 2013
Notes:When using DatasetModel classes from within the actual
Business Entity itself, developers are supposed to set
the UseDedicatedBusinessEntity property to TRUE.

Navigate to: Methods | Constructors | Events | Properties



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

Top Constructor Summary
Options Name Purpose
+ DatasetModel (handle) Constructor for the DatasetModel class

Top Property Summary
Options Name Purpose
+ CHARACTER AppServerPartition Gets/Sets the name of the AppServer Partition to be used by this DatasetModel
+ INTEGER BatchSize Gets/Sets the BatchSize used when reading data from the Business Entity.
+ HANDLE DatasetHandle Returns a reference to the primary Dataset owned by the DatasetController
+ A CHARACTER EntityName Name of the BusinessEntity.
+ LOGICAL HasChanges Returns logical value indicating if the Dataset has changes
+ LOGICAL NextBatchAvailable Returns is a next batch of records is available
+ Consultingwerk.OERA.DatasetModelPerformer Performer Returns the reference to the DatasetModelPerformer instance of this dataset model
+ INTEGER StopAfter Gets and sets the STOP-AFTER value used when reading data from the Business Entity.
+ Consultingwerk.OERA.ListTableModel TableModels Returns the List of TableModels
+ LOGICAL TrackingChanges Gets and sets if the Dataset Model's ProDataset is TRACKING-CHANGES
+ LOGICAL UseDedicatedBusinessEntity Gets and sets if the DatasetModel is communicating with a dedicated Business Entity instance
+ 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 */


Method Detail
Top

PUBLIC GetDataset (dataset-handle)
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)
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

PROTECTED OpenTableModelQueries ()
Purpose: Opens the queries of all table models
Notes:

Top

PUBLIC Consultingwerk.OERA.DatasetModel RetrieveData (character, character)
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)
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)
Purpose: Retrieves data from the backend
Notes:

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

PUBLIC Consultingwerk.OERA.DatasetModel RetrieveData (INamedQueryParameter)
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 ()
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 ()
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 DatasetModel (handle)
Purpose: Constructor for the DatasetModel class
Notes:

Parameters:
phDataset HANDLE
The handle of the ProDataset from the concrete model class


Property Detail
Top

PUBLIC CHARACTER AppServerPartition
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
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
Purpose: Returns a reference to the primary Dataset owned by the DatasetController
Notes:

Returns HANDLE
Top

PUBLIC CHARACTER EntityName
Purpose: Name of the BusinessEntity.
Notes: This Property needs to be set by actual Dataset model implementation

Returns CHARACTER
Top

PUBLIC LOGICAL HasChanges
Purpose: Returns logical value indicating if the Dataset has changes
Notes: Based on DatasetHelper:HasChanges

Returns LOGICAL
Top

PUBLIC LOGICAL NextBatchAvailable
Purpose: Returns is a next batch of records is available
Notes:

Returns LOGICAL
Top

PUBLIC Consultingwerk.OERA.DatasetModelPerformer Performer
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 INTEGER StopAfter
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
Purpose: Returns the List of TableModels
Notes:

Returns Consultingwerk.OERA.ListTableModel
Top

PUBLIC LOGICAL TrackingChanges
Purpose: Gets and sets if the Dataset Model's ProDataset is TRACKING-CHANGES
Notes:

Returns LOGICAL
Top

PUBLIC LOGICAL UseDedicatedBusinessEntity
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
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:29:51