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

Inherits: Progress.Lang.Object
Inherited by: Consultingwerk.Integrations.BuildOne.Swat.SwatService
ABSTRACT


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



Top Method Summary
Options Name Purpose
HANDLE AddIdAndSequenceFields (handle, character, integer, character) Returns a copy of the given dataset with the generic id and seq fields added to every table
FetchData (character, FetchDataRequest, character, dataset-handle) Performs a FetchData request against the OERA Service Interface and returns a dataset enriched with the generic id and seq fields
FetchDatasetSchema (character, dataset-handle) Returns the dataset (schema only) of the given Business Entity
Consultingwerk.OERA.IBusinessEntity GetBusinessEntity (character) Returns the Business Entity instance for the given name
CHARACTER GetTopNavBufferName (character) Returns the name of the first top-nav buffer (primary table) of the given Business Entity
JsonToDatasetWithBeforeImage (JsonObject, handle) Converts the given JSON object with the ProDataset before-image representation (prods:hasChanges, prods:rowState, prods:before) into the given ProDataset with established row-states and before-images
SaveChanges (character, dataset-handle) Passes the given change-tracking dataset to the OERA Service Interface update processing (Business Entity validation and SaveChanges)
CHARACTER UniqueKeyValue (handle, character, integer) Returns the (concatenated) unique key value(s) of the record in the given buffer

Top Property Summary
Options Name Purpose
OpenEdge.Web.IWebRequest WebRequest


Method Detail
Top

HANDLE AddIdAndSequenceFields (handle, character, integer, character)
Purpose: Returns a copy of the given dataset with the generic id and seq
fields added to every table
Notes: Follows the pattern established by the JSDO generic service: the
id field carries the (concatenated) unique key value(s) of the
record, the seq field the position of the record in the result
set for the primary table (? for child tables). Can be overridden
by implementations that do not require the id/seq enrichment

Parameters:
phFetchDataset HANDLE
The dataset returned by the Service Interface
pcBufferName CHARACTER
The name of the primary table buffer
piStartSequence INTEGER
The sequence offset (Skip value) of the request
pcOrderBy CHARACTER
The order-by phrase (without the BY keyword, may be empty) used for sequencing the primary table
Returns HANDLE
The handle of the new dataset instance with id and seq fields
Top

FetchData (character, FetchDataRequest, character, dataset-handle)
Purpose: Performs a FetchData request against the OERA Service Interface
and returns a dataset enriched with the generic id and seq fields
Notes: The id field is populated with the (concatenated) unique key
value(s) of each record, the seq field with the position of the
record in the result set (continuing across batches based on the
Skip value of the FetchDataRequest). The caller is responsible
for deleting the output dataset handle

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
poFetchDataRequest Consultingwerk.OERA.FetchDataRequest
The FetchDataRequest describing the request
pcOrderBy CHARACTER
The order-by phrase (without the BY keyword, may be empty) used for sequencing the primary table
phDataset DATASET-HANDLE
OUTPUT The dataset with the fetched data
Top

FetchDatasetSchema (character, dataset-handle)
Purpose: Returns the dataset (schema only) of the given Business Entity
Notes: The caller is responsible for deleting the output dataset handle

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
phDataset DATASET-HANDLE
OUTPUT The dataset handle of the Business Entity
Top

Consultingwerk.OERA.IBusinessEntity GetBusinessEntity (character)
Purpose: Returns the Business Entity instance for the given name
Notes: Business Entities are singletons managed by the ServiceManager -
no cleanup by the caller

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
Returns Consultingwerk.OERA.IBusinessEntity
The IBusinessEntity instance
Top

CHARACTER GetTopNavBufferName (character)
Purpose: Returns the name of the first top-nav buffer (primary table)
of the given Business Entity
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
Returns CHARACTER
The name of the primary table of the Business Entity
Top

JsonToDatasetWithBeforeImage (JsonObject, handle)
Purpose: Converts the given JSON object with the ProDataset before-image
representation (prods:hasChanges, prods:rowState, prods:before)
into the given ProDataset with established row-states and
before-images
Notes: Public so specific integration classes can use this conversion -
or not (not all integrations may support ProDataset before-value
representations in that way). The actual conversion is performed
by the IJsonDatasetBeforeImageService resolved through the
ServiceContainer

Parameters:
poJson Progress.Json.ObjectModel.JsonObject
The JsonObject with the serialized ProDataset including the before-image representation
phDataset HANDLE
The handle of the target ProDataset (typically the dataset of the Business Entity)
Top

SaveChanges (character, dataset-handle)
Purpose: Passes the given change-tracking dataset to the OERA Service
Interface update processing (Business Entity validation and
SaveChanges)
Notes: After the call the dataset carries the saved values (including
trigger- or backend-assigned values). Validation errors are
reflected by the ERROR attribute of the dataset and the
ERROR-STRING values of the affected rows. Callers should pass
the dataset BY-REFERENCE to avoid deep copies

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
phDataset DATASET-HANDLE
INPUT-OUTPUT DATASET-HANDLE The dataset with the tracked changes
Top

CHARACTER UniqueKeyValue (handle, character, integer)
Purpose: Returns the (concatenated) unique key value(s) of the record in
the given buffer
Notes: Multiple key field values are separated with the pipe character

Parameters:
phBuffer HANDLE
The buffer positioned on the record
pcKeyFields CHARACTER
The comma-delimited list of unique key fields
piEntries INTEGER
The number of entries in pcKeyFields
Returns CHARACTER
The unique key value of the record


Property Detail
Top

OpenEdge.Web.IWebRequest WebRequest

Returns OpenEdge.Web.IWebRequest


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       24.08.2026 05:58:12