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 Consultingwerk.Integrations.RapidCloud.RapidCloudDataEndpoint
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
Progress.Json.ObjectModel.JsonObject BuildInvokeResult (Object, JsonObject) Builds the result of an invoked method
CustomizeInvokeMethodParameter (character, character, Object) Passes the parameter object of an invoked method to the IGenericServiceCustomization service
Progress.Lang.Object DeserializeParameterObject (character, JsonObject, character, character) Creates the parameter object of an invoked method from its JSON representation
FetchData (character, FetchDataRequest, character, character, dataset-handle) Performs a FetchData request against the OERA Service Interface and returns a dataset enriched with the generic id and seq fields
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
Progress.Json.ObjectModel.JsonObject InvokeBusinessEntityMethod (character, character, JsonObject, JsonObject) Invokes a method of a Business Entity that is published with the @InvokeMethod annotation
Progress.Json.ObjectModel.JsonObject InvokeBusinessTaskMethod (IBusinessTaskCatalogData, character, JsonObject, JsonObject) Invokes a method of a Business Task that is listed in its catalog data (IBusinessTaskCatalogInfo)
Progress.Json.ObjectModel.JsonObject InvokeMethod (character, character, JsonObject, JsonObject) Invokes a published method of a Business Entity or Business Task and returns the parameter object and the output datasets
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
ReadDatasetFromJson (JsonObject, handle) Reads the given dataset from the datasets JsonObject of an invoke request
SaveChanges (character, dataset-handle) Passes the given change-tracking dataset to the OERA Service Interface update processing (Business Entity validation and SaveChanges)
Progress.Json.ObjectModel.JsonObject SerializeParameterObject (Object) Returns the JSON representation of the parameter object of an invoked method
CHARACTER UniqueKeyValue (handle, character, integer) Returns the (concatenated) unique key value(s) of the record in the given buffer
WriteDatasetToJson (JsonObject, handle, logical) Adds the given dataset to the datasets JsonObject of an invoke result

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

Progress.Json.ObjectModel.JsonObject BuildInvokeResult (Object, JsonObject)
Purpose: Builds the result of an invoked method
Notes: SCL-6114. The parameter property is null when the method has no
parameter object

Parameters:
poParameter Progress.Lang.Object
The parameter object after the call (may be ?)
poDatasets Progress.Json.ObjectModel.JsonObject
The JsonObject with the output datasets
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the parameter and the datasets property
Top

CustomizeInvokeMethodParameter (character, character, Object)
Purpose: Passes the parameter object of an invoked method to the
IGenericServiceCustomization service
Notes: SCL-6114. Same hook as in the JSDO Generic Service - only called
while a WebRequest is assigned and the service is registered

Parameters:
pcEntityName CHARACTER
The name of the Business Entity or Business Task
pcMethodName CHARACTER
The name of the invoked method
poParameter Progress.Lang.Object
INPUT-OUTPUT The parameter object (may be replaced by the customization)
Top

Progress.Lang.Object DeserializeParameterObject (character, JsonObject, character, character)
Purpose: Creates the parameter object of an invoked method from its
JSON representation
Notes: SCL-6114. The class is taken from the method descriptor.
Supports NativeJsonSerializable and IJsonSerializable parameter
objects (as the JSDO Generic Service) and JsonObject parameters.
Returns ? when the request contains no parameter object

Parameters:
pcParameterClassName CHARACTER
The name of the parameter class from the method descriptor (empty when the method has no parameter object)
poParameter Progress.Json.ObjectModel.JsonObject
The JsonObject with the serialized parameter object (may be ?)
pcEntityName CHARACTER
The name of the Business Entity or Business Task (for the error message)
pcMethodName CHARACTER
The name of the method (for the error message)
Returns Progress.Lang.Object
The parameter object or ?
Top

FetchData (character, FetchDataRequest, character, 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: SCL-6072. Same as the FetchData method without the pcBufferName
parameter, but sequences the given buffer instead of the first
top-nav buffer of the Business Entity - for requests whose
primary table is a child table. 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
pcBufferName CHARACTER
The name of the primary table buffer (empty for the first top-nav buffer of the Business Entity)
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

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

Progress.Json.ObjectModel.JsonObject InvokeBusinessEntityMethod (character, character, JsonObject, JsonObject)
Purpose: Invokes a method of a Business Entity that is published with
the @InvokeMethod annotation
Notes: SCL-6114. The method receives an empty dataset when the method
does not accept an input dataset or the request does not
contain it (SCL-1344)

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
pcMethodName CHARACTER
The name of the method to invoke
poParameter Progress.Json.ObjectModel.JsonObject
The JsonObject with the serialized parameter object (may be ?)
poDatasets Progress.Json.ObjectModel.JsonObject
The JsonObject with the input datasets (may be ?)
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the parameter and the datasets property
Top

Progress.Json.ObjectModel.JsonObject InvokeBusinessTaskMethod (IBusinessTaskCatalogData, character, JsonObject, JsonObject)
Purpose: Invokes a method of a Business Task that is listed in its
catalog data (IBusinessTaskCatalogInfo)
Notes: SCL-6114. Supports up to five dataset parameters, like the
OERA Service Interface. All datasets are emptied before and
after the call, so the Business Task (a singleton) neither
returns nor keeps data of a previous request

Parameters:
poCatalogData Consultingwerk.OERA.IBusinessTaskCatalogData
The catalog data of the Business Task
pcMethodName CHARACTER
The name of the method to invoke
poParameter Progress.Json.ObjectModel.JsonObject
The JsonObject with the serialized parameter object (may be ?)
poDatasets Progress.Json.ObjectModel.JsonObject
The JsonObject with the input datasets (may be ?)
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the parameter and the datasets property
Top

Progress.Json.ObjectModel.JsonObject InvokeMethod (character, character, JsonObject, JsonObject)
Purpose: Invokes a published method of a Business Entity or Business
Task and returns the parameter object and the output datasets
Notes: SCL-6114. Only explicitly published methods are invoked: the
methods of a Business Entity with the @InvokeMethod annotation
(from the Business Entity Descriptor, not excluded from the
catalog) and the methods listed in the catalog data of a
Business Task implementing IBusinessTaskCatalogInfo. Every
other method raises a MethodNotInvokableException. The class of
the parameter object is taken from the method descriptor, never
from the request. poDatasets and the datasets property of the
result carry one property per dataset, named after the
SERIALIZE-NAME of the dataset, with the dataset in the
WRITE-JSON format

Parameters:
pcEntityName CHARACTER
The name of the Business Entity or Business Task
pcMethodName CHARACTER
The name of the method to invoke
poParameter Progress.Json.ObjectModel.JsonObject
The JsonObject with the serialized parameter object (may be ?)
poDatasets Progress.Json.ObjectModel.JsonObject
The JsonObject with the input datasets (may be ?)
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the parameter and the datasets property
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

ReadDatasetFromJson (JsonObject, handle)
Purpose: Reads the given dataset from the datasets JsonObject of an
invoke request
Notes: SCL-6114. The dataset is looked up by its SERIALIZE-NAME, then by
its NAME. A missing or null dataset leaves the dataset empty.
The before-image representation (prods:hasChanges) is supported

Parameters:
poDatasets Progress.Json.ObjectModel.JsonObject
The JsonObject with the input datasets (may be ?)
phDataset HANDLE
The handle of the dataset to read
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

Progress.Json.ObjectModel.JsonObject SerializeParameterObject (Object)
Purpose: Returns the JSON representation of the parameter object of an
invoked method
Notes: SCL-6114

Parameters:
poParameter Progress.Lang.Object
The parameter object
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the serialized parameter object
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
Top

WriteDatasetToJson (JsonObject, handle, logical)
Purpose: Adds the given dataset to the datasets JsonObject of an invoke
result
Notes: SCL-6114. The property is named after the SERIALIZE-NAME of the
dataset and contains the tables in the WRITE-JSON format.
Integrations may override this method to post-process the
serialized dataset

Parameters:
poDatasets Progress.Json.ObjectModel.JsonObject
The JsonObject with the output datasets
phDataset HANDLE
The handle of the dataset to serialize
plWriteBeforeImage LOGICAL
Logical value indicating if the before-image representation is written


Property Detail
Top

OpenEdge.Web.IWebRequest WebRequest

Returns OpenEdge.Web.IWebRequest


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       09.11.2026 08:05:39