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

Inherits: Progress.Lang.Object


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



Top Method Summary
Options Name Purpose
+ 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
+ GetData (character, character, character, character, dataset-handle) Generic GetData (get/read) Service Interface
+ InvokeWithSerializableObject (character, character, longchar, longchar) 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
+ SubmitData (character, longchar) Generic SubmitData (submit/create/delete/update) Service Interface
+ UpdateData (character, longchar) Generic UpdateData (put/update) Service Interface

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


Method Detail
Top

PUBLIC 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

PUBLIC 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

PROTECTED 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

PUBLIC 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

PROTECTED 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 characcter 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

PUBLIC 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

PUBLIC 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

PROTECTED 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 entiy name of the current request
pcFilter CHARACTER
The filter parameter value of the current request
Returns Consultingwerk.OERA.CountRecordsRequest
The FetchDataRequest instance
Top

PROTECTED 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 entiy name of the current request
pcFilter CHARACTER
The filter parameter value of the current request
Returns Consultingwerk.OERA.FetchDataRequest
The FetchDataRequest instance
Top

PROTECTED 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

PROTECTED 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

PROTECTED 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

PROTECTED 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

PROTECTED 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

PUBLIC 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

PUBLIC 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


Constructor Detail
Top

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



©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       04.02.2020 23:13:32