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

Inherits: Consultingwerk.OERA.BusinessTask
Implements: Consultingwerk.OERA.IBusinessEntity, Consultingwerk.OERA.IBusinessService, Consultingwerk.OERA.BusinessEntityDescriptor.IProvidesBusinessEntityDescriptor, ISupportsRestMethods
ABSTRACT

File:DataMaintenanceBusinessTask
Purpose:Base class for business tasks implementing the IBusinessEntity
interface to support data retrieval and update through
the JSDO generic service
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Mon Jun 10 09:07:26 CEST 2019
Notes:SCL-2651, SCL-2652
/* Mike Fechner, Consultingwerk Ltd. 13.09.2017
Preprocessor variables for SmartComponentLibrary, WinKit and SmartFramework
based on Consultingwerk/packages.i now

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



Top Method Summary
Options Name Purpose
# A FetchData (IFetchDataRequest) Fetch data from the Data Access object
+ F FetchData (IFetchDataRequest, dataset-handle) Fetch data and/or definitions
+ FetchDataset (dataset-handle) Creates and returns an empty dataset to the caller
+ GetBusinessEntityDescriptor (dataset-handle, GetBusinessEntityDescriptorParameter) Returns the Business Entity Descriptor for this Business Entity
+ GetInitialValues (dataset-handle, GetInitialValuesParameter) Returns a dataset with one record containing the initial values
+ ListRestMethod GetRestMethods () Returns the list of supported rest adresses for methods to the caller
Inherited from Consultingwerk.OERA.BusinessTask
+ GetTopNavBuffers (dataset-handle, CharacterHolder) Populates the provided CharacterHolder with a comma-delimited list of the names of the dataset TOP-NAV-BUFFER's
# A SaveChanges () Processes changes
+ F SaveChanges (dataset-handle) Saves changes
+ F SaveChanges (dataset-handle, Object) Saves changes

Top Constructor Summary
Options Name Purpose
# DataMaintenanceBusinessTask (handle) Constructor of the DataMaintenanceBusinessTask class

Top Property Summary
Options Name Purpose
+ HANDLE DatasetHandle
# Progress.Lang.Object SaveChangesParameter


Method Detail
Top

PROTECTED FetchData (IFetchDataRequest)
Purpose: Fetch data from the Data Access object
Notes:

Parameters:
poFetchDataRequest Consultingwerk.OERA.IFetchDataRequest
The IFetchDataRequest object with the parameters for this call
Top

PUBLIC FetchData (IFetchDataRequest, dataset-handle)
Purpose: Fetch data and/or definitions
Notes:

Parameters:
poFetchDataRequest Consultingwerk.OERA.IFetchDataRequest
The IFetchDataRequest object with the parameter for this call
phDataset DATASET-HANDLE
OUTPUT Dataset with the resulting data
Top

PUBLIC FetchDataset (dataset-handle)
Purpose: Creates and returns an empty dataset to the caller
Notes: Useful for dynamic callers that need access to the dataset schema prior to calling FetchData

Parameters:
phDataset DATASET-HANDLE
OUTPUT Dataset with the resulting data
Top

PUBLIC GetBusinessEntityDescriptor (dataset-handle, GetBusinessEntityDescriptorParameter)
Purpose: Returns the Business Entity Descriptor for this Business Entity
Notes: Invokable Method
http://confluence.consultingwerkcloud.com/wiki/display/SCL/Business+Entity+Descriptor

Parameters:
phDataset DATASET-HANDLE
The dataset of the Business Entity
poParameter Consultingwerk.OERA.BusinessEntityDescriptor.GetBusinessEntityDescriptorParameter
The GetBusinessEntityDescriptorParameter with the data for this call
Top

PUBLIC GetInitialValues (dataset-handle, GetInitialValuesParameter)
Purpose: Returns a dataset with one record containing the initial values
Notes: Can be overridden in Business Entity implementations to provide
dynamic initial values. The base class implementation will return
the buffer fields initial values. The parameter object's TableNames
is a comma-delimited list. The parameter object's ForeignKeyFields
property is a character array (one element per table) of comma delimited
lists of the provided foreign field names. The foreing field values is a
character array (one element per table) of CHR(1) delimited field
values

Parameters:
phDataset DATASET-HANDLE
Used to return the dataset
poParameter Consultingwerk.OERA.GetInitialValuesParameter
The GetInitialValuesParameter instance with the parameters for this call
Top

PUBLIC ListRestMethod GetRestMethods ()
Inherited from Consultingwerk.OERA.BusinessTask
Purpose: Returns the list of supported rest adresses for methods
to the caller
Notes:

Returns ListRestMethod
The list of supported rest methods to the caller
Top

PUBLIC GetTopNavBuffers (dataset-handle, CharacterHolder)
Purpose: Populates the provided CharacterHolder with a comma-delimited list
of the names of the dataset TOP-NAV-BUFFER's
Notes:

Parameters:
phDataset DATASET-HANDLE
The dataset handle (not used)
poParameter Consultingwerk.CharacterHolder
The CharacterHolder to receive the list of TOP-NAV-BUFFERS
Top

PROTECTED SaveChanges ()
Purpose: Processes changes
Notes: This method saves changes contained in the dataset currently present
in the Business Task

Top

PUBLIC SaveChanges (dataset-handle)
Purpose: Saves changes
Notes: This method is called from consumers of the Business Task and
receives the dataset. It calls into the SaveChanges() method with no
parameters after the internal dataset has been set
This method is called by the ServiceInterface when no parameter object
has been passed in

Parameters:
phDataset DATASET-HANDLE
INPUT-OUTPUT Dataset with changes
Top

PUBLIC SaveChanges (dataset-handle, Object)
Purpose: Saves changes
Notes: This method is called from consumers of the Business Task and
receives the dataset. It calls into the SaveChanges() method with no
parameters after the internal dataset has been set
This method is called by the ServiceInterface when a parameter object
has been passed in. The parameter object will be accessible from within
the business entity using the protected property SaveChangesParameter

Parameters:
phDataset DATASET-HANDLE
INPUT-OUTPUT Dataset with changes
poParameter Progress.Lang.Object
Optional Parameter object for the SaveChanges method


Constructor Detail
Top

PROTECTED DataMaintenanceBusinessTask (handle)
Purpose: Constructor of the DataMaintenanceBusinessTask class
Notes:

Parameters:
phDataset HANDLE
The handle of the dataset


Property Detail
Top

PUBLIC HANDLE DatasetHandle

Returns HANDLE
Top

PROTECTED Progress.Lang.Object SaveChangesParameter

Returns Progress.Lang.Object


©2006-2019 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.08.2019 23:28:27