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

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

File:BusinessEntityBusinessTask
Purpose:Base class for Business Tasks used as a facade to one or
multiple business entities
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun Mar 22 16:33:05 CET 2020

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



Top Method Summary
Options Name Purpose
# A FetchData (IFetchDataRequest) Fetch data and/or definitions
+ F FetchData (IFetchDataRequest, dataset-handle) Fetch data and/or definitions
+ FetchDataset (dataset-handle) Creates and returns an empty dataset to the caller
# Consultingwerk.OERA.IBusinessEntity GetBusinessEntity () Return the reference to the Business Entity
+ Consultingwerk.OERA.BusinessEntityDescriptor.IBusinessEntityDescriptor GetBusinessEntityDescriptor () Returns the Business Entity Descriptor for this Business Entity
+ F GetBusinessEntityDescriptor (dataset-handle, GetBusinessEntityDescriptorParameter) Returns the Business Entity Descriptor for this Business Entity
+ ListRestMethod GetRestMethods () Returns the list of supported rest adresses for methods to the caller
Inherited from Consultingwerk.OERA.BusinessTask
+ CHARACTER GetTopNavBuffers () Returns the names of the dataset TOP-NAV-BUFFER's
+ ResetState () Resets the state of the Business Entity by emptying temp-tables
+ F SaveChanges (dataset-handle) Saves changes
+ F SaveChanges (dataset-handle, Object) Saves changes
# A SaveChanges (Object) Saves changes

Top Constructor Summary
Options Name Purpose
# BusinessEntityBusinessTask (handle, character) Constructor for the BusinessEntityBusinessTask class

Top Property Summary
Options Name Purpose
+ HANDLE DatasetHandle
# CHARACTER ENTITY_NAME


Method Detail
Top

PROTECTED FetchData (IFetchDataRequest)
Purpose: Fetch data and/or definitions
Notes:

Parameters:
poFetchDataRequest Consultingwerk.OERA.IFetchDataRequest
The IFetchDataRequest object with the parameter 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

PROTECTED Consultingwerk.OERA.IBusinessEntity GetBusinessEntity ()
Purpose: Return the reference to the Business Entity
Notes:

Returns Consultingwerk.OERA.IBusinessEntity
The reference to the IBusinessEntity
Top

PUBLIC Consultingwerk.OERA.BusinessEntityDescriptor.IBusinessEntityDescriptor GetBusinessEntityDescriptor ()
Purpose: Returns the Business Entity Descriptor for this Business Entity
Notes: https://consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094518/Business+Entity+Descriptor

Returns Consultingwerk.OERA.BusinessEntityDescriptor.IBusinessEntityDescriptor
The IBusinessEntityDescriptor of the Business Entity
Top

PUBLIC GetBusinessEntityDescriptor (dataset-handle, GetBusinessEntityDescriptorParameter)
Purpose: Returns the Business Entity Descriptor for this Business Entity
Notes: Invokable Method
https://consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094518/Business+Entity+Descriptor //consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094518/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 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 CHARACTER GetTopNavBuffers ()
Purpose: Returns the names of the dataset TOP-NAV-BUFFER's
Notes:

Returns CHARACTER
The list of TOP-NAV-BUFFERS
Top

PUBLIC ResetState ()
Purpose: Resets the state of the Business Entity by emptying temp-tables
Notes: If the dataset or any temp-tables have been passed BY-REFERENCE and
a reference. This method is typically called from an AppServer's
deactivate procedure via the ServiceInterface's RequestEnded event

Top

PUBLIC SaveChanges (dataset-handle)
Purpose: Saves changes
Notes: This method is called from consumers of the Business Task and
receives the dataset.
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.
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
Top

PROTECTED SaveChanges (Object)
Purpose: Saves changes
Notes: This method is called from consumers of the Business Task and
receives the dataset.

Parameters:
poParameter Progress.Lang.Object
Optional Parameter object for the SaveChanges method


Constructor Detail
Top

PROTECTED BusinessEntityBusinessTask (handle, character)
Purpose: Constructor for the BusinessEntityBusinessTask class
Notes:

Parameters:
phDataset HANDLE
The handle of the Dataset
pcEntityName CHARACTER
The name of the Business Entity


Property Detail
Top

PUBLIC HANDLE DatasetHandle

Returns HANDLE
Top

PROTECTED CHARACTER ENTITY_NAME

Returns CHARACTER


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