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

Inherits: Progress.Lang.Object

/*&GLOBAL-DEFINE NoUserLobStatistics NoUserLobStatistics

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



Top Method Summary
Options Name Purpose
AddChildRows (JsonObject, handle, character) Adds children ows
CHARACTER AddDefaultSortToEntityQuery (character, character, character, character) Adds the default sort of the entity table to the query of the entity table when that query has no BY clause
Count (character, character, integer) Generic Count Service Interface
CreateData (character, longchar) Generic CreateData (post/create) Service Interface
CHARACTER DefaultSort (character, character) Returns the default sort of the table from the Business Entity Descriptor
DeleteData (character, longchar) Generic DeleteData (post/create) Service Interface
FetchDataRequestFromFilter (FetchDataRequest, character, character, character, character) Assigns the properties of the given FetchDataRequest instance from a character string representing an ABL Filter
HANDLE FetchEmptyDataset (character, handle) Returns the empty dataset of a Business Entity
Consultingwerk.OERA.BusinessEntityDescriptor.IBusinessEntityDescriptor GetBusinessEntityDescriptor (character) Retrieves the Business Entity Descriptor of the Business Entity
Progress.Json.ObjectModel.JsonObject GetData (character, character, character, character) Generic GetData (get/read) Service Interface
GetData (character, character, character, character, dataset-handle) Generic GetData (get/read) Service Interface
Progress.Json.ObjectModel.JsonObject InvokeBusinessTask (IBusinessTaskCatalogData, character, JsonObject) Generic Invoke Business Task Service Interface
InvokeWithSerializableObject (character, character, longchar, longchar) Generic Invoke Method Service Interface
Progress.Json.ObjectModel.JsonObject InvokeWithSerializableObject (character, character, JsonObject) Generic Invoke Method Service Interface
Consultingwerk.OERA.CountRecordsRequest NewCountRecordsRequest (character, character) Factory method for the CountRecordsRequest object passed to the ServiceInterface for the Count request
Consultingwerk.OERA.FetchDataRequest NewFetchDataRequest (character, character) Factory method for the FetchDataRequest object passed to the ServiceInterface for the GetData request
Consultingwerk.OERA.INamedQueryParameter ParseNamedQuery (JsonObject) Parses the NamedQuery property of the Json Document
Consultingwerk.OERA.NamedQueryParameterEntry ParseNamedQueryParameter (JsonObject) Parses a single entry of the NamedQuery parameter array
INTEGER ParseNumRecords (character) Parses the optional NumRecords argument
INTEGER ParseStopAfter (character) Parses the optional StopAfter argument
ProcessUpdate (character, longchar) Processes Create/Update/Delete operations
Progress.Json.ObjectModel.JsonObject ProcessUpdate (character, JsonObject) Processes Create/Update/Delete operations
RestoreClientId (JsonObject, handle) Restores the prods:ClientId in the response
StoreClientId (JsonObject, handle) Stores the prods:ClientId from the request
SubmitData (character, longchar) Generic SubmitData (submit/create/delete/update) Service Interface
UpdateData (character, longchar) Generic UpdateData (put/update) Service Interface
CHARACTER ViewTableQueries (FilterParameter, character, handle) Returns the query entries of the view tables built from the viewTableFilters of the filter parameter
CHARACTER ViewTableQueries (FilterParameter, character, handle, NumericFormat) Returns the query entries of the view tables built from the viewTableFilters of the filter parameter

Top Constructor Summary
Options Name Purpose
Service () Constructor for the Service class

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


Method Detail
Top

AddChildRows (JsonObject, handle, character)
Purpose: Adds children ows
Notes:

Parameters:
poParentRow Progress.Json.ObjectModel.JsonObject
The JsonObject of the parent row
phParentBuffer HANDLE
The buffer object handle of the parent record
pcAllTables CHARACTER
The comma delimited list of tables
Top

CHARACTER AddDefaultSortToEntityQuery (character, character, character, character)
Purpose: Adds the default sort of the entity table to the query of the
entity table when that query has no BY clause
Notes: SCL-6162. Only the first entry of the CHR(1) delimited queries is
the query of the entity table. The further entries (the query
entries of the view tables built from viewTableFilters) are
returned unchanged

Parameters:
pcQueries CHARACTER
The CHR(1) delimited queries of the FetchDataRequest
pcEntityName CHARACTER
The name of the Business Entity
pcBufferName CHARACTER
The name of the entity table
pcOrderBy CHARACTER
The sort of the entity table (without BY), replaced with the default sort when the query has no BY clause
Returns CHARACTER
The CHR(1) delimited queries with the sorted query of the entity table
Top

Count (character, character, integer)
Purpose: Generic Count Service Interface
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
pcFilter CHARACTER
The filter parameter
piNumRecs INTEGER
OUTPUT The number of records returned by the query
Top

CreateData (character, longchar)
Purpose: Generic CreateData (post/create) Service Interface
Notes: Uses a LONGCHAR as INPUT-OUTPUT for the Dataset, to allow to map this
to the actual data types of the fields in the Dataset from the business entity.
The default mapping for JSON number would be a DECIMAL fields, which
would cause conflicts integer fields in the business entity while
updating

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
lcDataset LONGCHAR
The JSON Representation of the Dataset to update
Top

CHARACTER DefaultSort (character, character)
Purpose: Returns the default sort of the table from the Business Entity Descriptor
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
pcTable CHARACTER
The name of the temp-table
Returns CHARACTER
CHARACTER
Top

DeleteData (character, longchar)
Purpose: Generic DeleteData (post/create) Service Interface
Notes: Uses a LONGCHAR as INPUT-OUTPUT for the Dataset, to allow to map this
to the actual data types of the fields in the Dataset from the business entity.
The default mapping for JSON number would be a DECIMAL fields, which
would cause conflicts integer fields in the business entity while
updating

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
lcDataset LONGCHAR
The JSON Representation of the Dataset to update
Top

FetchDataRequestFromFilter (FetchDataRequest, character, character, character, character)
Purpose: Assigns the properties of the given FetchDataRequest instance from
a character string representing an ABL Filter
Notes:

Parameters:
poFetchDataRequest Consultingwerk.OERA.FetchDataRequest
The FetchDataRequest instance to assign values to
pcFilter CHARACTER
The character string representing the ABL Filter instance
pcBufferName CHARACTER
The Buffer name for the query string
pcEntityName CHARACTER
The name of the Business Entity
pcOrderBy CHARACTER
OUTPUT The order by value
Top

HANDLE FetchEmptyDataset (character, handle)
Purpose: Returns the empty dataset of a Business Entity
Notes: SCL-6188: Used when a read with a skip at or behind the last
record raised a QueryOffEndException, so that the read returns
an empty result. Reuses the dataset of a read by reference

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
phDataset HANDLE
The dataset handle of the failed read, or unknown
Returns HANDLE
The handle of the empty dataset
Top

Consultingwerk.OERA.BusinessEntityDescriptor.IBusinessEntityDescriptor GetBusinessEntityDescriptor (character)
Purpose: Retrieves the Business Entity Descriptor of the Business Entity
Notes:

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

Progress.Json.ObjectModel.JsonObject GetData (character, character, character, character)
Purpose: Generic GetData (get/read) Service Interface
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
pcFilter CHARACTER
The filter parameter
pcNumRecords CHARACTER
The numRecords value from the http client, see method ParseNumRecords
pcStopAfter CHARACTER
The stopAfter value from the http client, see method ParseStopAfter
Returns Progress.Json.ObjectModel.JsonObject
The JSON Object with data
Top

GetData (character, character, character, character, dataset-handle)
Purpose: Generic GetData (get/read) Service Interface
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
pcFilter CHARACTER
The filter parameter
pcNumRecords CHARACTER
The numRecords value from the http client, see method ParseNumRecords
pcStopAfter CHARACTER
The stopAfter value from the http client, see method ParseStopAfter
phDataset DATASET-HANDLE
The Dataset to return to the client
Top

Progress.Json.ObjectModel.JsonObject InvokeBusinessTask (IBusinessTaskCatalogData, character, JsonObject)
Purpose: Generic Invoke Business Task Service Interface
Notes: Pacific WebSpeed variant

Parameters:
poBusinessTask Consultingwerk.OERA.IBusinessTaskCatalogData
The Business Task Catalog Data instance
pcMethodName CHARACTER
The name of the method to invoke
poJsonObject Progress.Json.ObjectModel.JsonObject
The JsonObject with the request data
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the response data
Top

InvokeWithSerializableObject (character, character, longchar, longchar)
Purpose: Generic Invoke Method Service Interface
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
pcMethodName CHARACTER
The name of the method to invoke
plcDataset LONGCHAR
The JSON representation of the INPUT/OUTPUT ProDataset
plcParameter LONGCHAR
The JSON Serializable INPUT/OUTPUT Parameter
Top

Progress.Json.ObjectModel.JsonObject InvokeWithSerializableObject (character, character, JsonObject)
Purpose: Generic Invoke Method Service Interface
Notes: Pacific WebSpeed variant

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
pcMethodName CHARACTER
The name of the method to invoke
poJsonObject Progress.Json.ObjectModel.JsonObject
The JsonObject with the request data
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the response data
Top

Consultingwerk.OERA.CountRecordsRequest NewCountRecordsRequest (character, character)
Purpose: Factory method for the CountRecordsRequest object passed to the
ServiceInterface for the Count request
Notes: Overridable method, so that extended versions of the Service.cls can
inject extended CountRecordsRequest implementations

Parameters:
pcEntityName CHARACTER
The entity name of the current request
pcFilter CHARACTER
The filter parameter value of the current request
Returns Consultingwerk.OERA.CountRecordsRequest
The FetchDataRequest instance
Top

Consultingwerk.OERA.FetchDataRequest NewFetchDataRequest (character, character)
Purpose: Factory method for the FetchDataRequest object passed to the
ServiceInterface for the GetData request
Notes: Overridable method, so that extended versions of the Service.cls can
inject extended FetchDataRequest implementations

Parameters:
pcEntityName CHARACTER
The entity name of the current request
pcFilter CHARACTER
The filter parameter value of the current request
Returns Consultingwerk.OERA.FetchDataRequest
The FetchDataRequest instance
Top

Consultingwerk.OERA.INamedQueryParameter ParseNamedQuery (JsonObject)
Purpose: Parses the NamedQuery property of the Json Document
Notes: Supports "NamedQuery" : "a simple name" for a NamedQueryParameter
with only the name property set or a

Parameters:
poJsonObject Progress.Json.ObjectModel.JsonObject
The JsonObject to parse the NamedQuery property of
Returns Consultingwerk.OERA.INamedQueryParameter
The resulting INamedQueryParameter instance
Top

Consultingwerk.OERA.NamedQueryParameterEntry ParseNamedQueryParameter (JsonObject)
Purpose: Parses a single entry of the NamedQuery parameter array
Notes:

Parameters:
poJsonObject Progress.Json.ObjectModel.JsonObject
The JsonObject to parse the NamedQuery parameter from
Returns Consultingwerk.OERA.NamedQueryParameterEntry
The resulting NamedQueryParameterEntry instance
Top

INTEGER ParseNumRecords (character)
Purpose: Parses the optional NumRecords argument
Notes: Supports optional "all" and "one"

Parameters:
pcNumRecords CHARACTER
The NumRecords argument as received from the http client
Returns INTEGER
The numeric value for num records
Top

INTEGER ParseStopAfter (character)
Purpose: Parses the optional StopAfter argument
Notes: Supports optional "disabled" and "none"

Parameters:
pcStopAfter CHARACTER
The StopAfter argument as received from the http client
Returns INTEGER
The numeric value for stop after
Top

ProcessUpdate (character, longchar)
Purpose: Processes Create/Update/Delete operations
Notes: Worker method for CreateData, DeleteData and UpdateData as the
rest adapter does not support using the same method for all three
verbs - but all methods can share the same implementation

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
lcDataset LONGCHAR
The JSON Representation of the Dataset to update
Top

Progress.Json.ObjectModel.JsonObject ProcessUpdate (character, JsonObject)
Purpose: Processes Create/Update/Delete operations
Notes: Pacific WebSpeed variant

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
poJsonObject Progress.Json.ObjectModel.JsonObject
The JSON Representation of the Dataset to update
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the result of the update operation
Top

RestoreClientId (JsonObject, handle)
Purpose: Restores the prods:ClientId in the response
Notes:

Parameters:
poJson Progress.Json.ObjectModel.JsonObject
The response JSON
phDataset HANDLE
The input ProDataset
Top

StoreClientId (JsonObject, handle)
Purpose: Stores the prods:ClientId from the request
Notes:

Parameters:
poJson Progress.Json.ObjectModel.JsonObject
The request JSON
phDataset HANDLE
The input ProDataset
Top

SubmitData (character, longchar)
Purpose: Generic SubmitData (submit/create/delete/update) Service Interface
Notes: Uses a LONGCHAR as INPUT-OUTPUT for the Dataset, to allow to map this
to the actual data types of the fields in the Dataset from the business
entity. The default mapping for JSON number would be a DECIMAL fields,
which would cause conflicts integer fields in the business entity while
updating

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
lcDataset LONGCHAR
The JSON Representation of the Dataset to update
Top

UpdateData (character, longchar)
Purpose: Generic UpdateData (put/update) Service Interface
Notes: Uses a LONGCHAR as INPUT-OUTPUT for the Dataset, to allow to map this
to the actual data types of the fields in the Dataset from the business entity.
The default mapping for JSON number would be a DECIMAL fields, which
would cause conflicts integer fields in the business entity while
updating

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
lcDataset LONGCHAR
The JSON Representation of the Dataset to update
Top

CHARACTER ViewTableQueries (FilterParameter, character, handle)
Purpose: Returns the query entries of the view tables built from the
viewTableFilters of the filter parameter
Notes: SCL-6162. Returns one entry per entry of viewTableFilters, each
one including its leading CHR(1), to be appended to the query of
the entity table (IFetchDataRequest:Queries). An empty entry of
viewTableFilters results in an empty query entry (default query of
the view table)
SCL-6245: Writes number literals compared with DECIMAL fields in
the current numeric format of the session. FetchDataRequestFromFilter
runs with the AMERICAN numeric format and calls the overload that
receives the numeric format of the session instead

Parameters:
poFilterParameter Consultingwerk.OERA.FilterParameter
The FilterParameter with the viewTables and viewTableFilters
pcTables CHARACTER
The comma delimited list of buffer names of the request, the entity table followed by the view tables
phDataset HANDLE
The handle of the ProDataset of the Business Entity
Returns CHARACTER
The CHR(1) delimited query entries of the view tables
Top

CHARACTER ViewTableQueries (FilterParameter, character, handle, NumericFormat)
Purpose: Returns the query entries of the view tables built from the
viewTableFilters of the filter parameter
Notes: SCL-6162. Returns one entry per entry of viewTableFilters, each
one including its leading CHR(1), to be appended to the query of
the entity table (IFetchDataRequest:Queries). An empty entry of
viewTableFilters results in an empty query entry (default query of
the view table)
SCL-6245: Number literals compared with DECIMAL fields are written
in the given numeric format, the format of the session that
prepares the queries

Parameters:
poFilterParameter Consultingwerk.OERA.FilterParameter
The FilterParameter with the viewTables and viewTableFilters
pcTables CHARACTER
The comma delimited list of buffer names of the request, the entity table followed by the view tables
phDataset HANDLE
The handle of the ProDataset of the Business Entity
poNumericFormat Consultingwerk.NumericFormat
The numeric format of the session that prepares the queries
Returns CHARACTER
The CHR(1) delimited query entries of the view tables


Constructor Detail
Top

Service ()
Purpose: Constructor for the Service class
Notes:



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:59