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

Inherits: Progress.Lang.Object

File:DatasetModelPerformer
Purpose:Performs the backend requests of the Dataset Model class
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sat Dec 21 23:41:54 CET 2013
Notes:This class has been introduced so that the TableModel
instances to not need to keep a reference to the
Dataset Model and the Dataset Model will be cleaned up
by the garbage collector when no longer needed

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
# PerformFetchDataRequest (FetchDataRequest) Performs Fetch Data request either using the Service Adapter or the Service Interface
+ PerformNextBatchRequest () Fetches the next batch of data
+ RetrieveData (character, character) Retrieves data from the backend
+ RetrieveData (character, INamedQueryParameter) Retrieves data from the backend
+ RetrieveData (character, IQueryExpression) Retrieves data from the backend
+ RetrieveData (INamedQueryParameter) Retrieves data from the backend
+ RetrieveDataByRowid (character, character) Retrieves data from the backend based on the given data-source ROWID (DB-ROWID)
+ SaveChanges () Performs Save Changes request either using the Service Adapter or the Service Interface

Top Constructor Summary
Options Name Purpose
+ DatasetModelPerformer (handle, character) Constructor for the DatasetModelPerformer class

Top Property Summary
Options Name Purpose
+ CHARACTER AppServerPartition Gets/Sets the name of the AppServer Partition to be used by this DatasetModel
+ CHARACTER BatchingOnTable Returns the Name of the TempTable this DatasetModelPerformer is batching on
+ 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
+ CHARACTER EntityName Name of the BusinessEntity.
# Consultingwerk.OERA.FetchDataRequest FetchDataRequest Returns the FetchDataRequest instance used to fetch the previous batch
+ LOGICAL NextBatchAvailable Returns is a next batch of records is available
+ INTEGER StopAfter Gets and sets the STOP-AFTER value used when reading data from the Business Entity.
+ LOGICAL UseDedicatedBusinessEntity Gets and sets if the DatasetModel is communicating with a dedicated Business Entity instance
+ Consultingwerk.OERA.UseInterfaceEnum UseInterface Gets and sets the Interface this DatasetModel uses for Business Entity Requests


Method Detail
Top

PROTECTED PerformFetchDataRequest (FetchDataRequest)
Purpose: Performs Fetch Data request either using the Service Adapter or the
Service Interface
Notes:

Parameters:
poFetchDataRequest Consultingwerk.OERA.FetchDataRequest
The FetchDataRequest instance with the request data
Top

PUBLIC PerformNextBatchRequest ()
Purpose: Fetches the next batch of data
Notes: Invoked by the GetNext() method of the TableModel class when
no local data is available in the model but additional batches are
available on the backend

Top

PUBLIC 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
Top

PUBLIC 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
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 RetrieveData (INamedQueryParameter)
Purpose: Retrieves data from the backend
Notes:

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

PUBLIC RetrieveDataByRowid (character, character)
Purpose: Retrieves data from the backend based on the given data-source
ROWID (DB-ROWID)
Notes: DB-ROWID passed as comma-delimited list in case there are joined
data-source queries

Parameters:
pcTable CHARACTER
The comma delimited list of the Table Names to retrieve
pcSourceRowidIds CHARACTER
The comma-delimited list of data-source rowids
Top

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



Constructor Detail
Top

PUBLIC DatasetModelPerformer (handle, character)
Purpose: Constructor for the DatasetModelPerformer class
Notes:

Parameters:
phDataset HANDLE
The handle of the ProDataset from the model class
pcEntityName CHARACTER
The name of the Business Entity


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 CHARACTER BatchingOnTable
Purpose: Returns the Name of the TempTable this DatasetModelPerformer is batching
on
Notes:

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

PROTECTED Consultingwerk.OERA.FetchDataRequest FetchDataRequest
Purpose: Returns the FetchDataRequest instance used to fetch the previous
batch
Notes: Only valid when batching

Returns Consultingwerk.OERA.FetchDataRequest
Top

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

Returns LOGICAL
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 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