Namespace: Consultingwerk.OERA.RestResource
Interface 
IRestResourceFormatService Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implemented by: Consultingwerk.OERA.RestResource.RestResourceFormatService

Purpose: Returns the response JsonArray for a collection record
Notes:



Top Method Summary
Options Name Purpose
+ Progress.Json.ObjectModel.JsonArray BuildCollectionResponse (handle, character, IRestResourceFormatParameter) Returns the response JsonArray for a collection record
+ Progress.Json.ObjectModel.JsonObject BuildCountResponse (ICountRecordsRequest, IRestResourceFormatParameter) Returns the response JsonObject for a single record
+ Progress.Json.ObjectModel.JsonObject BuildInitialValueResponse (handle, IRestResourceFormatParameter) Returns the response JsonObject for the initial values for a collection
+ Progress.Json.ObjectModel.JsonObject BuildRecordResponse (handle, IRestResourceFormatParameter) Returns the response JsonObject for a single record
+ Progress.Json.ObjectModel.JsonObject BuildStatusResponse (character, StatusCodeEnum, IRestResourceFormatParameter) Returns the response JsonObject for a status code message


Method Detail
Top

PUBLIC Progress.Json.ObjectModel.JsonArray BuildCollectionResponse (handle, character, IRestResourceFormatParameter)

Purpose: Returns the response JsonArray for a collection record
Notes:

Parameters:
phDataset HANDLE
The dataset that contains the response records
pcQuerySort CHARACTER
The query sort
poRestResourceFormatParameter Consultingwerk.OERA.RestResource.IRestResourceFormatParameter
The parameter object containing formatting information.
Returns Progress.Json.ObjectModel.JsonArray
The JSON Response entity
Top

PUBLIC Progress.Json.ObjectModel.JsonObject BuildCountResponse (ICountRecordsRequest, IRestResourceFormatParameter)

Purpose: Returns the response JsonObject for a single record
Notes:

Parameters:
poCountRequest Consultingwerk.OERA.ICountRecordsRequest
The response object
poRestResourceFormatParameter Consultingwerk.OERA.RestResource.IRestResourceFormatParameter
The parameter object containing formatting information.
Returns Progress.Json.ObjectModel.JsonObject
The JSON Response entity
Top

PUBLIC Progress.Json.ObjectModel.JsonObject BuildInitialValueResponse (handle, IRestResourceFormatParameter)

Purpose: Returns the response JsonObject for the initial values for a collection
Notes:

Parameters:
phDataset HANDLE
The dataset that contains the response records
poRestResourceFormatParameter Consultingwerk.OERA.RestResource.IRestResourceFormatParameter
The parameter object containing formatting information.
Returns Progress.Json.ObjectModel.JsonObject
The JSON Response entity
Top

PUBLIC Progress.Json.ObjectModel.JsonObject BuildRecordResponse (handle, IRestResourceFormatParameter)

Purpose: Returns the response JsonObject for a single record
Notes:

Parameters:
phDataset HANDLE
The dataset that contains the response records
poRestResourceFormatParameter Consultingwerk.OERA.RestResource.IRestResourceFormatParameter
The parameter object containing formatting information.
Returns Progress.Json.ObjectModel.JsonObject
The JSON Response entity
Top

PUBLIC Progress.Json.ObjectModel.JsonObject BuildStatusResponse (character, StatusCodeEnum, IRestResourceFormatParameter)

Purpose: Returns the response JsonObject for a status code message
Notes:

Parameters:
pcMessage CHARACTER
A message relating to the status code
poStatusCode OpenEdge.Net.HTTP.StatusCodeEnum
The status code of the response
poRestResourceFormatParameter Consultingwerk.OERA.RestResource.IRestResourceFormatParameter
The parameter object containing formatting information.
Returns Progress.Json.ObjectModel.JsonObject
The JSON Response entity


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