Namespace: Consultingwerk.SmartFramework.System
Class 
ValueListDatasetModel Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.DatasetModel
Consultingwerk.SmartFramework.System.ValueListDatasetModel_Generated
Consultingwerk.SmartFramework.System.ValueListDatasetModel

Inherits: Consultingwerk.SmartFramework.System.ValueListDatasetModel_Generated

File:ValueList
Author(s):Mike Fechner
Created:21/12/2013 00:52:48,798+01:00

Consultingwerk.SmartFramework.System.ValueListBusinessEntity
Consultingwerk.SmartFramework.System.ValueListBusinessEntity

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



Top Method Summary
Options Name Purpose
+ GetDataset (dataset-handle) Returns the Dataset to the caller
Inherited from Consultingwerk.OERA.DatasetModel
+ DatasetControlStringEnum GetDatasetControlString () Returns the DatasetControlString of the Dataset
Inherited from Consultingwerk.OERA.DatasetModel
+ CHARACTER GetNextRowid () Returns the Next-Rowid
Inherited from Consultingwerk.OERA.DatasetModel
# InitializeDisconnected () Initializes a disconnected DatasetModel
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
+ LOGICAL NewFilter (character) Initializes the Filter for SmartValueList
Inherited from Consultingwerk.SmartFramework.System.ValueListDatasetModel_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, character, OnNotAvailableEnum) 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
+ Consultingwerk.OERA.DatasetModel RetrieveData (character, INamedQueryParameter, OnNotAvailableEnum) Retrieves data from the backend
Inherited from Consultingwerk.OERA.DatasetModel
+ Consultingwerk.OERA.DatasetModel RetrieveData (character, IQueryExpression) Retrieves data from the backend
Inherited from Consultingwerk.OERA.DatasetModel
+ Consultingwerk.OERA.DatasetModel RetrieveData (character, IQueryExpression, OnNotAvailableEnum) 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 RetrieveData (INamedQueryParameter, OnNotAvailableEnum) 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
+ LOGICAL SaveChanges (OnValidationErrorEnum) Performs Save Changes request either using the Service Adapter or the Service Interface
Inherited from Consultingwerk.OERA.DatasetModel
+ Consultingwerk.OERA.DatasetModel SaveChanges (Object) Performs Save Changes request either using the Service Adapter or the Service Interface
Inherited from Consultingwerk.OERA.DatasetModel
+ LOGICAL SaveChanges (Object, OnValidationErrorEnum) Performs Save Changes request either using the Service Adapter or the Service Interface
Inherited from Consultingwerk.OERA.DatasetModel
+ Consultingwerk.SmartFramework.System.ValueListDatasetModel SetAppServerPartition (character) Sets the AppServerPartition value
Inherited from Consultingwerk.SmartFramework.System.ValueListDatasetModel_Generated
+ Consultingwerk.SmartFramework.System.ValueListDatasetModel SetBatchSize (integer) Sets the BatchSize value
Inherited from Consultingwerk.SmartFramework.System.ValueListDatasetModel_Generated
+ Consultingwerk.OERA.DatasetModel SetRestartRowid (character) Sets the Restart-Rowid for the next request
Inherited from Consultingwerk.OERA.DatasetModel
+ Consultingwerk.SmartFramework.System.ValueListDatasetModel SetStopAfter (integer) Sets the StopAfter value
Inherited from Consultingwerk.SmartFramework.System.ValueListDatasetModel_Generated
+ Consultingwerk.SmartFramework.System.ValueListDatasetModel SetTrackingChanges (logical) Sets the TrackingChanges value
Inherited from Consultingwerk.SmartFramework.System.ValueListDatasetModel_Generated
+ Consultingwerk.SmartFramework.System.ValueListDatasetModel SetUseDedicatedBusinessEntity (logical) Sets the UseDedicatedBusinessEntity value
Inherited from Consultingwerk.SmartFramework.System.ValueListDatasetModel_Generated
+ Consultingwerk.SmartFramework.System.ValueListDatasetModel SetUseInterface (UseInterfaceEnum) Sets the UseInterface value
Inherited from Consultingwerk.SmartFramework.System.ValueListDatasetModel_Generated
+ 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
+ ValueListDatasetModel () Constructor for the ValueListDatasetModel class
+ ValueListDatasetModel (character) Constructor for the ValueListDatasetModel class

Top Property Summary
Options Name Purpose
+ CHARACTER AppServerPartition
Inherited from Consultingwerk.OERA.DatasetModel
+ INTEGER BatchSize
Inherited from Consultingwerk.OERA.DatasetModel
+ HANDLE ContextDataset
Inherited from Consultingwerk.OERA.DatasetModel
+ HANDLE DatasetHandle
Inherited from Consultingwerk.OERA.DatasetModel
+ Consultingwerk.OERA.DatasetModelModeEnum DatasetModelMode
Inherited from Consultingwerk.OERA.DatasetModel
+ Consultingwerk.OERA.IDatasetModelUseInterfaceProvider DatasetModelUseInterfaceProvider
Inherited from Consultingwerk.OERA.DatasetModel
+ A CHARACTER EntityName
Overrides Consultingwerk.SmartFramework.System.ValueListDatasetModel_Generated:EntityName
+ LOGICAL HasChanges
Inherited from Consultingwerk.OERA.DatasetModel
+ LOGICAL NextBatchAvailable
Inherited from Consultingwerk.OERA.DatasetModel
+ Consultingwerk.OERA.DatasetModelPerformer Performer
Inherited from Consultingwerk.OERA.DatasetModel
+ INTEGER Skip
Inherited from Consultingwerk.OERA.DatasetModel
+ Consultingwerk.SmartFramework.System.SmartValueListTableModel SmartValueList
Inherited from Consultingwerk.SmartFramework.System.ValueListDatasetModel_Generated
+ Consultingwerk.SmartFramework.System.SmartValueListEntryTableModel SmartValueListEntry
Inherited from Consultingwerk.SmartFramework.System.ValueListDatasetModel_Generated
+ INTEGER StopAfter
Inherited from Consultingwerk.OERA.DatasetModel
+ Consultingwerk.OERA.ListTableModel TableModels
Inherited from Consultingwerk.OERA.DatasetModel
+ LOGICAL TrackingChanges
Inherited from Consultingwerk.OERA.DatasetModel
+ LOGICAL UseDedicatedBusinessEntity
Inherited from Consultingwerk.OERA.DatasetModel
+ Consultingwerk.OERA.UseInterfaceEnum UseInterface
Inherited from Consultingwerk.OERA.DatasetModel
+ LOGICAL UseServiceAdapterDefault
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

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

Returns DatasetControlStringEnum
The DatasetControlString of the Dataset
Top

PUBLIC CHARACTER GetNextRowid ()
Inherited from Consultingwerk.OERA.DatasetModel
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

PROTECTED InitializeDisconnected ()
Inherited from Consultingwerk.OERA.DatasetModel
Purpose: Initializes a disconnected DatasetModel
Notes:

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 LOGICAL NewFilter (character)
Inherited from Consultingwerk.SmartFramework.System.ValueListDatasetModel_Generated
Purpose: Initializes the Filter for SmartValueList
Notes:

Parameters:
pValueListGuid CHARACTER
The filter value for the eSmartValueList.ValueListGuid field
Returns LOGICAL
Logical value indicating if a record is available
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, character, OnNotAvailableEnum)
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
poOnNotAvailable Consultingwerk.OERA.OnNotAvailableEnum
OnNotAvailableEnum member describing if the DatasetModel should throw an error on not availalbe
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 Consultingwerk.OERA.DatasetModel RetrieveData (character, INamedQueryParameter, OnNotAvailableEnum)
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
poOnNotAvailable Consultingwerk.OERA.OnNotAvailableEnum
OnNotAvailableEnum member describing if the DatasetModel should throw an error on not availalbe
Returns Consultingwerk.OERA.DatasetModel
The reference to the DatasetModel instance itself
Top

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

PUBLIC Consultingwerk.OERA.DatasetModel RetrieveData (character, IQueryExpression, OnNotAvailableEnum)
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
poOnNotAvailable Consultingwerk.OERA.OnNotAvailableEnum
OnNotAvailableEnum member describing if the DatasetModel should throw an error on not availalbe
Returns Consultingwerk.OERA.DatasetModel
The reference to the DatasetModel instance itself
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 RetrieveData (INamedQueryParameter, OnNotAvailableEnum)
Inherited from Consultingwerk.OERA.DatasetModel
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 availalbe
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 LOGICAL SaveChanges (OnValidationErrorEnum)
Inherited from Consultingwerk.OERA.DatasetModel
Purpose: Performs Save Changes request either using the Service Adapter or the
Service Interface
Notes:

Parameters:
poOnValidationError 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)
Inherited from Consultingwerk.OERA.DatasetModel
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)
Inherited from Consultingwerk.OERA.DatasetModel
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 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.SmartFramework.System.ValueListDatasetModel SetAppServerPartition (character)
Inherited from Consultingwerk.SmartFramework.System.ValueListDatasetModel_Generated
Purpose: Sets the AppServerPartition value
Notes:

Parameters:
pcPartition CHARACTER
The value for the AppServerPartition property
Returns Consultingwerk.SmartFramework.System.ValueListDatasetModel
The reference to the DatasetModel itself for fluent style coding
Top

PUBLIC Consultingwerk.SmartFramework.System.ValueListDatasetModel SetBatchSize (integer)
Inherited from Consultingwerk.SmartFramework.System.ValueListDatasetModel_Generated
Purpose: Sets the BatchSize value
Notes:

Parameters:
piBatchSize INTEGER
The value for the BatchSize property
Returns Consultingwerk.SmartFramework.System.ValueListDatasetModel
The reference to the DatasetModel itself for fluent style coding
Top

PUBLIC Consultingwerk.OERA.DatasetModel SetRestartRowid (character)
Inherited from Consultingwerk.OERA.DatasetModel
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.SmartFramework.System.ValueListDatasetModel SetStopAfter (integer)
Inherited from Consultingwerk.SmartFramework.System.ValueListDatasetModel_Generated
Purpose: Sets the StopAfter value
Notes:

Parameters:
piStopAfter INTEGER
The value for the StopAfter property
Returns Consultingwerk.SmartFramework.System.ValueListDatasetModel
The reference to the DatasetModel itself for fluent style coding
Top

PUBLIC Consultingwerk.SmartFramework.System.ValueListDatasetModel SetTrackingChanges (logical)
Inherited from Consultingwerk.SmartFramework.System.ValueListDatasetModel_Generated
Purpose: Sets the TrackingChanges value
Notes:

Parameters:
plTrackingChanges LOGICAL
The value for the TrackingChanges property
Returns Consultingwerk.SmartFramework.System.ValueListDatasetModel
The reference to the DatasetModel itself for fluent style coding
Top

PUBLIC Consultingwerk.SmartFramework.System.ValueListDatasetModel SetUseDedicatedBusinessEntity (logical)
Inherited from Consultingwerk.SmartFramework.System.ValueListDatasetModel_Generated
Purpose: Sets the UseDedicatedBusinessEntity value
Notes:

Parameters:
plUseDedicatedBusinessEntity LOGICAL
The value for the UseDedicatedBusinessEntity property
Returns Consultingwerk.SmartFramework.System.ValueListDatasetModel
The reference to the DatasetModel itself for fluent style coding
Top

PUBLIC Consultingwerk.SmartFramework.System.ValueListDatasetModel SetUseInterface (UseInterfaceEnum)
Inherited from Consultingwerk.SmartFramework.System.ValueListDatasetModel_Generated
Purpose: Sets the UseInterface value
Notes:

Parameters:
poUseInterface Consultingwerk.OERA.UseInterfaceEnum
The value for the UseInterface property
Returns Consultingwerk.SmartFramework.System.ValueListDatasetModel
The reference to the DatasetModel itself for fluent style coding
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 ValueListDatasetModel ()
Purpose: Constructor for the ValueListDatasetModel class
Notes:

Top

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

Parameters:
pValueListGuid CHARACTER
The filter value for the eSmartValueList.ValueListGuid field


Property Detail
Top

PUBLIC CHARACTER AppServerPartition
Inherited from Consultingwerk.OERA.DatasetModel

Returns CHARACTER
Top

PUBLIC INTEGER BatchSize
Inherited from Consultingwerk.OERA.DatasetModel

Returns INTEGER
Top

PUBLIC HANDLE ContextDataset
Inherited from Consultingwerk.OERA.DatasetModel

Returns HANDLE
Top

PUBLIC HANDLE DatasetHandle
Inherited from Consultingwerk.OERA.DatasetModel

Returns HANDLE
Top

PUBLIC Consultingwerk.OERA.DatasetModelModeEnum DatasetModelMode
Inherited from Consultingwerk.OERA.DatasetModel

Returns Consultingwerk.OERA.DatasetModelModeEnum
Top

PUBLIC Consultingwerk.OERA.IDatasetModelUseInterfaceProvider DatasetModelUseInterfaceProvider
Inherited from Consultingwerk.OERA.DatasetModel

Returns Consultingwerk.OERA.IDatasetModelUseInterfaceProvider
Top

PUBLIC CHARACTER EntityName
Overrides Consultingwerk.SmartFramework.System.ValueListDatasetModel_Generated:EntityName

Returns CHARACTER
Top

PUBLIC LOGICAL HasChanges
Inherited from Consultingwerk.OERA.DatasetModel

Returns LOGICAL
Top

PUBLIC LOGICAL NextBatchAvailable
Inherited from Consultingwerk.OERA.DatasetModel

Returns LOGICAL
Top

PUBLIC Consultingwerk.OERA.DatasetModelPerformer Performer
Inherited from Consultingwerk.OERA.DatasetModel

Returns Consultingwerk.OERA.DatasetModelPerformer
Top

PUBLIC INTEGER Skip
Inherited from Consultingwerk.OERA.DatasetModel

Returns INTEGER
Top

PUBLIC Consultingwerk.SmartFramework.System.SmartValueListTableModel SmartValueList
Inherited from Consultingwerk.SmartFramework.System.ValueListDatasetModel_Generated

Returns Consultingwerk.SmartFramework.System.SmartValueListTableModel
Top

PUBLIC Consultingwerk.SmartFramework.System.SmartValueListEntryTableModel SmartValueListEntry
Inherited from Consultingwerk.SmartFramework.System.ValueListDatasetModel_Generated

Returns Consultingwerk.SmartFramework.System.SmartValueListEntryTableModel
Top

PUBLIC INTEGER StopAfter
Inherited from Consultingwerk.OERA.DatasetModel

Returns INTEGER
Top

PUBLIC Consultingwerk.OERA.ListTableModel TableModels
Inherited from Consultingwerk.OERA.DatasetModel

Returns Consultingwerk.OERA.ListTableModel
Top

PUBLIC LOGICAL TrackingChanges
Inherited from Consultingwerk.OERA.DatasetModel

Returns LOGICAL
Top

PUBLIC LOGICAL UseDedicatedBusinessEntity
Inherited from Consultingwerk.OERA.DatasetModel

Returns LOGICAL
Top

PUBLIC Consultingwerk.OERA.UseInterfaceEnum UseInterface
Inherited from Consultingwerk.OERA.DatasetModel

Returns Consultingwerk.OERA.UseInterfaceEnum
Top

PUBLIC LOGICAL UseServiceAdapterDefault
Inherited from Consultingwerk.OERA.DatasetModel

Returns LOGICAL


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       04.02.2020 23:31:13