Namespace: Consultingwerk.OERA
Interface 
IDatasetModel Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implemented by: Consultingwerk.OERA.DatasetModel, Consultingwerk.SmartFramework.Authentication.UserDatasetModel, Consultingwerk.SmartFramework.Authentication.UserDatasetModel_Generated, Consultingwerk.SmartFramework.Authentication.UserProfileDatasetModel, Consultingwerk.SmartFramework.Authentication.UserProfileDatasetModel_Generated, Consultingwerk.SmartFramework.Authorization.FieldSecurityItemDatasetModel, Consultingwerk.SmartFramework.Authorization.FieldSecurityItemDatasetModel_Generated, Consultingwerk.SmartFramework.Authorization.GroupDatasetModel, Consultingwerk.SmartFramework.Authorization.GroupDatasetModel_Generated, Consultingwerk.SmartFramework.Authorization.MenuGroupDatasetModel, Consultingwerk.SmartFramework.Authorization.MenuGroupDatasetModel_Generated, Consultingwerk.SmartFramework.Authorization.ParentGroupDatasetModel, Consultingwerk.SmartFramework.Authorization.ParentGroupDatasetModel_Generated, Consultingwerk.SmartFramework.Authorization.SecurityAssignmentDatasetModel, Consultingwerk.SmartFramework.Authorization.SecurityAssignmentDatasetModel_Generated, Consultingwerk.SmartFramework.Authorization.SecurityObjectDatasetModel, Consultingwerk.SmartFramework.Authorization.SecurityObjectDatasetModel_Generated, Consultingwerk.SmartFramework.Authorization.SecurityRealmDatasetModel, Consultingwerk.SmartFramework.Authorization.SecurityRealmDatasetModel_Generated, Consultingwerk.SmartFramework.Authorization.SecurityTokenDatasetModel, Consultingwerk.SmartFramework.Authorization.SecurityTokenDatasetModel_Generated, Consultingwerk.SmartFramework.Authorization.ToolbarSecurityItemDatasetModel, Consultingwerk.SmartFramework.Authorization.ToolbarSecurityItemDatasetModel_Generated, Consultingwerk.SmartFramework.Authorization.UserGroupDatasetModel, Consultingwerk.SmartFramework.Authorization.UserGroupDatasetModel_Generated, Consultingwerk.SmartFramework.Context.ContextStoreDatasetModel, Consultingwerk.SmartFramework.Context.ContextStoreDatasetModel_Generated, Consultingwerk.SmartFramework.Lock.LockDatasetModel, Consultingwerk.SmartFramework.Lock.LockDatasetModel_Generated, Consultingwerk.SmartFramework.Menu.MenuDatasetModel, Consultingwerk.SmartFramework.Menu.MenuDatasetModel_Generated, Consultingwerk.SmartFramework.Menu.MenuStyleDatasetModel, Consultingwerk.SmartFramework.Menu.MenuStyleDatasetModel_Generated, Consultingwerk.SmartFramework.Menu.ModuleDatasetModel, Consultingwerk.SmartFramework.Menu.ModuleDatasetModel_Generated, Consultingwerk.SmartFramework.Menu.ProductDatasetModel, Consultingwerk.SmartFramework.Menu.ProductDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.BusinessEntities.MetaBusinessEntity.MetaBusinessEntityDatasetModel, Consultingwerk.SmartFramework.Repository.BusinessEntities.MetaBusinessEntity.MetaBusinessEntityDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.BusinessEntities.MetaDataSource.MetaDataSourceDatasetModel, Consultingwerk.SmartFramework.Repository.BusinessEntities.MetaDataSource.MetaDataSourceDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.BusinessEntities.MetaEntityTable.MetaEntityTableDatasetModel, Consultingwerk.SmartFramework.Repository.BusinessEntities.MetaEntityTable.MetaEntityTableDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.Class.AttributeDatasetModel, Consultingwerk.SmartFramework.Repository.Class.AttributeDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.Class.AttributeGroupDatasetModel, Consultingwerk.SmartFramework.Repository.Class.AttributeGroupDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.Class.AttributeValueDatasetModel, Consultingwerk.SmartFramework.Repository.Class.AttributeValueDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.Class.ClassTypeDatasetModel, Consultingwerk.SmartFramework.Repository.Class.ClassTypeDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.Class.LinkTypeDatasetModel, Consultingwerk.SmartFramework.Repository.Class.LinkTypeDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.Class.ObjectTypeDatasetModel, Consultingwerk.SmartFramework.Repository.Class.ObjectTypeDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.Class.SupportedInstanceObjectTypeDatasetModel, Consultingwerk.SmartFramework.Repository.Class.SupportedInstanceObjectTypeDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.Class.SupportedLinkDatasetModel, Consultingwerk.SmartFramework.Repository.Class.SupportedLinkDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.Customization.CustomizationDatasetModel, Consultingwerk.SmartFramework.Repository.Customization.CustomizationDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.Customization.CustomizationTypeDatasetModel, Consultingwerk.SmartFramework.Repository.Customization.CustomizationTypeDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.Field.EntityFieldMappingDatasetModel, Consultingwerk.SmartFramework.Repository.Field.EntityFieldMappingDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.Object.ObjectMasterDatasetModel, Consultingwerk.SmartFramework.Repository.Object.ObjectMasterDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.ScreenMapping.EntityTableMappingDatasetModel, Consultingwerk.SmartFramework.Repository.ScreenMapping.EntityTableMappingDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.ScreenMapping.ScreenTypeDatasetModel, Consultingwerk.SmartFramework.Repository.ScreenMapping.ScreenTypeDatasetModel_Generated, Consultingwerk.SmartFramework.Repository.ScreenMapping.UiTypeDatasetModel, Consultingwerk.SmartFramework.Repository.ScreenMapping.UiTypeDatasetModel_Generated, Consultingwerk.SmartFramework.Scheduler.SchedulerJobDatasetModel, Consultingwerk.SmartFramework.Scheduler.SchedulerJobDatasetModel_Generated, Consultingwerk.SmartFramework.Scheduler.SchedulerJobPlanDatasetModel, Consultingwerk.SmartFramework.Scheduler.SchedulerJobPlanDatasetModel_Generated, Consultingwerk.SmartFramework.Scheduler.SchedulerJobStatusDatasetModel, Consultingwerk.SmartFramework.Scheduler.SchedulerJobStatusDatasetModel_Generated, Consultingwerk.SmartFramework.Scheduler.SchedulerQueueDatasetModel, Consultingwerk.SmartFramework.Scheduler.SchedulerQueueDatasetModel_Generated, Consultingwerk.SmartFramework.System.AttachmentDatasetModel, Consultingwerk.SmartFramework.System.AttachmentDatasetModel_Generated, Consultingwerk.SmartFramework.System.AttachmentRoleDatasetModel, Consultingwerk.SmartFramework.System.AttachmentRoleDatasetModel_Generated, Consultingwerk.SmartFramework.System.CommentRoleDatasetModel, Consultingwerk.SmartFramework.System.CommentRoleDatasetModel_Generated, Consultingwerk.SmartFramework.System.ConfigurationValueDatasetModel, Consultingwerk.SmartFramework.System.ConfigurationValueDatasetModel_Generated, Consultingwerk.SmartFramework.System.DeletionDatasetModel, Consultingwerk.SmartFramework.System.DeletionDatasetModel_Generated, Consultingwerk.SmartFramework.System.ImportFileStatus.ImportFileStatusDatasetModel, Consultingwerk.SmartFramework.System.ImportFileStatus.ImportFileStatusDatasetModel_Generated, Consultingwerk.SmartFramework.System.KeyFieldAssignmentTypeDatasetModel, Consultingwerk.SmartFramework.System.KeyFieldAssignmentTypeDatasetModel_Generated, Consultingwerk.SmartFramework.System.LanguageDatasetModel, Consultingwerk.SmartFramework.System.LanguageDatasetModel_Generated, Consultingwerk.SmartFramework.System.LoginCompanyDatasetModel, Consultingwerk.SmartFramework.System.LoginCompanyDatasetModel_Generated, Consultingwerk.SmartFramework.System.MessageDatasetModel, Consultingwerk.SmartFramework.System.MessageDatasetModel_Generated, Consultingwerk.SmartFramework.System.ModifiedStateDatasetModel, Consultingwerk.SmartFramework.System.ModifiedStateDatasetModel_Generated, Consultingwerk.SmartFramework.System.RelationDatasetModel, Consultingwerk.SmartFramework.System.RelationDatasetModel_Generated, Consultingwerk.SmartFramework.System.SmartBusinessEntityDatasetModel, Consultingwerk.SmartFramework.System.SmartBusinessEntityDatasetModel_Generated, Consultingwerk.SmartFramework.System.SmartCache.CacheDatasetModel, Consultingwerk.SmartFramework.System.SmartCache.CacheDatasetModel_Generated, Consultingwerk.SmartFramework.System.TableDatasetModel, Consultingwerk.SmartFramework.System.TableDatasetModel_Generated, Consultingwerk.SmartFramework.System.Tags.TagDatasetModel, Consultingwerk.SmartFramework.System.Tags.TagDatasetModel_Generated, Consultingwerk.SmartFramework.System.TranslationDatasetModel, Consultingwerk.SmartFramework.System.TranslationDatasetModel_Generated, Consultingwerk.SmartFramework.System.UiTranslationDatasetModel, Consultingwerk.SmartFramework.System.UiTranslationDatasetModel_Generated, Consultingwerk.SmartFramework.System.ValueListDatasetModel, Consultingwerk.SmartFramework.System.ValueListDatasetModel_Generated, Consultingwerk.SmartFramework.Web.RouteDatasetModel, Consultingwerk.SmartFramework.Web.RouteDatasetModel_Generated, Consultingwerk.SmartFramework.Workflow.WorkflowDatasetModel, Consultingwerk.SmartFramework.Workflow.WorkflowDatasetModel_Generated, Consultingwerk.SmartFramework.Workflow.WorkflowInstanceDatasetModel, Consultingwerk.SmartFramework.Workflow.WorkflowInstanceDatasetModel_Generated

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)

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



Top Method Summary
Options Name Purpose
+ GetDataset (dataset-handle) Returns the Dataset to the caller
+ Consultingwerk.Util.Enum.DatasetControlStringEnum GetDatasetControlString () Returns the DatasetControlString of the Dataset
+ CHARACTER GetNextRowid () Returns the Next-Rowid
+ Consultingwerk.OERA.DatasetModel RetrieveData (character, character) Retrieves data from the backend
+ Consultingwerk.OERA.DatasetModel RetrieveData (character, character, OnNotAvailableEnum) Retrieves data from the backend
+ Consultingwerk.OERA.DatasetModel RetrieveData (character, INamedQueryParameter) Retrieves data from the backend
+ Consultingwerk.OERA.DatasetModel RetrieveData (character, INamedQueryParameter, OnNotAvailableEnum) Retrieves data from the backend
+ Consultingwerk.OERA.DatasetModel RetrieveData (character, IQueryExpression) Retrieves data from the backend
+ Consultingwerk.OERA.DatasetModel RetrieveData (character, IQueryExpression, OnNotAvailableEnum) Retrieves data from the backend
+ Consultingwerk.OERA.DatasetModel RetrieveData (INamedQueryParameter) Retrieves data from the backend
+ Consultingwerk.OERA.DatasetModel RetrieveData (INamedQueryParameter, OnNotAvailableEnum) Retrieves data from the backend
+ Consultingwerk.OERA.DatasetModel SaveChanges () Performs Save Changes request either using the Service Adapter or the Service Interface
+ LOGICAL SaveChanges (OnValidationErrorEnum) Performs Save Changes request either using the Service Adapter or the Service Interface
+ Consultingwerk.OERA.DatasetModel SaveChanges (Object) Performs Save Changes request either using the Service Adapter or the Service Interface
+ LOGICAL SaveChanges (Object, OnValidationErrorEnum) Performs Save Changes request either using the Service Adapter or the Service Interface
+ Consultingwerk.OERA.DatasetModel SetRestartRowid (character) Sets the Restart-Rowid for the next request
+ Consultingwerk.OERA.DatasetModel UseDatasetQueries () Ensures that all TableModels are using one of the ProDataset QUERY's

Top Property Summary
Options Name Purpose
+ CHARACTER AppServerPartition
+ INTEGER BatchSize
+ HANDLE ContextDataset
+ CHARACTER CustomContext
+ Progress.Lang.Object CustomParameter
+ HANDLE DatasetHandle
+ Consultingwerk.OERA.DatasetModelModeEnum DatasetModelMode
+ CHARACTER EntityName
+ LOGICAL HasChanges
+ LOGICAL NextBatchAvailable
+ Consultingwerk.OERA.DatasetModelPerformer Performer
+ Consultingwerk.OERA.DatasetModel.QueryStyleEnum QueryStyle
+ INTEGER Skip
+ INTEGER StopAfter
+ Consultingwerk.OERA.ListTableModel TableModels
+ LOGICAL TrackingChanges
+ LOGICAL UseDedicatedBusinessEntity
+ Consultingwerk.OERA.UseInterfaceEnum UseInterface


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

PUBLIC Consultingwerk.Util.Enum.DatasetControlStringEnum GetDatasetControlString ()
Purpose: Returns the DatasetControlString of the Dataset
Notes: _CANCEL or _QUESTIONS-PENDING as an Enum

Returns Consultingwerk.Util.Enum.DatasetControlStringEnum
The DatasetControlString of the Dataset
Top

PUBLIC CHARACTER GetNextRowid ()
Purpose: Returns the Next-Rowid
Notes: The Next-Rowid is the row-identifier required for retrieving
the next batch. The usage of this method is only required, when
implementing ROWID based batching with Dataset Models throughout
different AppServer requests. The SetRestartRowid method acecpts
the same values

Returns CHARACTER
The row-identifier required for retrieving the next batch
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, character, OnNotAvailableEnum)
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
poOnNotAvailable Consultingwerk.OERA.OnNotAvailableEnum
OnNotAvailableEnum member describing if the DatasetModel should throw an error on not available
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 Consultingwerk.OERA.DatasetModel RetrieveData (character, INamedQueryParameter, OnNotAvailableEnum)
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
poOnNotAvailable Consultingwerk.OERA.OnNotAvailableEnum
OnNotAvailableEnum member describing if the DatasetModel should throw an error on not available
Returns Consultingwerk.OERA.DatasetModel
The reference to the DatasetModel instance itself
Top

PUBLIC Consultingwerk.OERA.DatasetModel 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
Returns Consultingwerk.OERA.DatasetModel
The reference to the DatasetModel instance itself
Top

PUBLIC Consultingwerk.OERA.DatasetModel RetrieveData (character, IQueryExpression, OnNotAvailableEnum)
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
poOnNotAvailable Consultingwerk.OERA.OnNotAvailableEnum
OnNotAvailableEnum member describing if the DatasetModel should throw an error on not available
Returns Consultingwerk.OERA.DatasetModel
The reference to the DatasetModel instance itself
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 RetrieveData (INamedQueryParameter, OnNotAvailableEnum)
Purpose: Retrieves data from the backend
Notes:

Parameters:
poNamedQuery Consultingwerk.OERA.INamedQueryParameter
The INamedQueryParameter that defines a named query
poOnNotAvailable Consultingwerk.OERA.OnNotAvailableEnum
OnNotAvailableEnum member describing if the DatasetModel should throw an error on not available
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 LOGICAL SaveChanges (OnValidationErrorEnum)
Purpose: Performs Save Changes request either using the Service Adapter or the
Service Interface
Notes:

Parameters:
poOnValidationError Consultingwerk.OERA.Enum.OnValidationErrorEnum
An OnValidationError value describing the behaviour when a vlaidation error is encountered
Returns LOGICAL
Logical value indicating if the SaveChanges was successful (no validation error)
Top

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

Parameters:
poParameter Progress.Lang.Object
The optional parameter for the SaveChanges method of the Business Entity
Returns Consultingwerk.OERA.DatasetModel
The reference to the DatasetModel instance itself
Top

PUBLIC LOGICAL SaveChanges (Object, OnValidationErrorEnum)
Purpose: Performs Save Changes request either using the Service Adapter or the
Service Interface
Notes:

Parameters:
poParameter Progress.Lang.Object
The (optional) parameter for the SaveChanges method
poOnValidationError Consultingwerk.OERA.Enum.OnValidationErrorEnum
An OnValidationError value describing the behaviour when a vlaidation error is encountered
Returns LOGICAL
Logical value indicating if the SaveChanges was successful (no validation error)
Top

PUBLIC Consultingwerk.OERA.DatasetModel SetRestartRowid (character)
Purpose: Sets the Restart-Rowid for the next request
Notes: Allows to start retrieving data from a specific row.
The usage of this method is only required, when implementing
ROWID based batching with Dataset Models throughout different
AppServer requests.

Parameters:
pcRowid CHARACTER
The value for the Restart-Rowid
Returns Consultingwerk.OERA.DatasetModel
The reference to the DatasetModel itself for fluent style code
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


Property Detail
Top

PUBLIC CHARACTER AppServerPartition

Returns CHARACTER
Top

PUBLIC INTEGER BatchSize

Returns INTEGER
Top

PUBLIC HANDLE ContextDataset

Returns HANDLE
Top

PUBLIC CHARACTER CustomContext

Returns CHARACTER
Top

PUBLIC Progress.Lang.Object CustomParameter

Returns Progress.Lang.Object
Top

PUBLIC HANDLE DatasetHandle

Returns HANDLE
Top

PUBLIC Consultingwerk.OERA.DatasetModelModeEnum DatasetModelMode

Returns Consultingwerk.OERA.DatasetModelModeEnum
Top

PUBLIC CHARACTER EntityName

Returns CHARACTER
Top

PUBLIC LOGICAL HasChanges

Returns LOGICAL
Top

PUBLIC LOGICAL NextBatchAvailable

Returns LOGICAL
Top

PUBLIC Consultingwerk.OERA.DatasetModelPerformer Performer

Returns Consultingwerk.OERA.DatasetModelPerformer
Top

PUBLIC Consultingwerk.OERA.DatasetModel.QueryStyleEnum QueryStyle

Returns Consultingwerk.OERA.DatasetModel.QueryStyleEnum
Top

PUBLIC INTEGER Skip

Returns INTEGER
Top

PUBLIC INTEGER StopAfter

Returns INTEGER
Top

PUBLIC Consultingwerk.OERA.ListTableModel TableModels

Returns Consultingwerk.OERA.ListTableModel
Top

PUBLIC LOGICAL TrackingChanges

Returns LOGICAL
Top

PUBLIC LOGICAL UseDedicatedBusinessEntity

Returns LOGICAL
Top

PUBLIC Consultingwerk.OERA.UseInterfaceEnum UseInterface

Returns Consultingwerk.OERA.UseInterfaceEnum


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 05:52:37