Namespace: Consultingwerk.OERA.RestResource
Class 
RestResourceFormatService Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.RestResource.RestResourceFormatService

Inherits: Progress.Lang.Object
Implements: Consultingwerk.OERA.RestResource.IRestResourceFormatService

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

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



Top Method Summary
Options Name Purpose
# AddBufferFields (handle, JsonObject, character, CharacterDictionary) Adds the Buffer Fields to the given JSON Object
# AddIdField (JsonObject, handle, character) Adds the id property
# Consultingwerk.OERA.RestResource.BufferFieldSubstitute AddressToSubstitute (character) Parses an address pattern and returns the SUBSTITUTE() parameters
+ 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
# Consultingwerk.Framework.Collections.CharacterDictionary InitializeRestrictedFields (character) Queries the Field Authorization Provider and returns a CharacterDictionary of restricted fields(Hidden)
# ProcessLinks (JsonObject, handle, IRestResourceFormatParameter) Processes the Links and adds to JSON
# ProcessRelations (JsonObject, handle, IRestResourceFormatParameter, CharacterDictionary) Processes the child relations of the given record
# CHARACTER ResourceUri (handle, character, IRestResourceFormatParameter) Returns a Resource URI for the given record
# CHARACTER UrlPrefix (IWebRequest) Returns the UrlPrefix (hostname, port and /web/Entities)


Method Detail
Top

PROTECTED AddBufferFields (handle, JsonObject, character, CharacterDictionary)
Purpose: Adds the Buffer Fields to the given JSON Object
Notes:

Parameters:
phBuffer HANDLE
The handle of the Buffer
poRecord Progress.Json.ObjectModel.JsonObject
The JsonObject to add the fields to
pcFields CHARACTER
The fields as provided by the consumer
poRestrictedFields Consultingwerk.Framework.Collections.CharacterDictionary
A dictionary of restricted fields
Top

PROTECTED AddIdField (JsonObject, handle, character)
Purpose: Adds the id property
Notes:

Parameters:
poJson Progress.Json.ObjectModel.JsonObject
The JsonObject to add the id property to
phBuffer HANDLE
The handle of the buffer to obtain values from
pcFields CHARACTER
The list of fields to use for the id property value
Top

PROTECTED Consultingwerk.OERA.RestResource.BufferFieldSubstitute AddressToSubstitute (character)
Purpose: Parses an address pattern and returns the
SUBSTITUTE() parameters
Notes:

Parameters:
pcAddress CHARACTER
The URI address pattern
Returns Consultingwerk.OERA.RestResource.BufferFieldSubstitute
The BufferFieldSubstitute instance
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
poParameter 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: The RestEntitiesWebHandler only supports the creation of records in 1 table at a time.

Parameters:
phDataset HANDLE
The dataset that contains the response records
poParameter 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
poParameter 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
Top

PROTECTED Consultingwerk.Framework.Collections.CharacterDictionary InitializeRestrictedFields (character)
Purpose: Queries the Field Authorization Provider and returns
a CharacterDictionary of restricted fields(Hidden)
Notes:

Parameters:
pcTables CHARACTER
The comma delimited list of tables
Returns Consultingwerk.Framework.Collections.CharacterDictionary
The CharacterDictionary of restricted fields
Top

PROTECTED ProcessLinks (JsonObject, handle, IRestResourceFormatParameter)
Purpose: Processes the Links and adds to JSON
Notes:

Parameters:
poJson Progress.Json.ObjectModel.JsonObject
The JsonObject to add the links to
phBuffer HANDLE
The parent record buffer
poParameter Consultingwerk.OERA.RestResource.IRestResourceFormatParameter
The formatting parameters
Top

PROTECTED ProcessRelations (JsonObject, handle, IRestResourceFormatParameter, CharacterDictionary)
Purpose: Processes the child relations of the given record
Notes:

Parameters:
poJson Progress.Json.ObjectModel.JsonObject
The Json of the parent record
phBuffer HANDLE
The handle of the parent record
poParameter Consultingwerk.OERA.RestResource.IRestResourceFormatParameter
The formatting parameters
poRestrictedFields Consultingwerk.Framework.Collections.CharacterDictionary
A dictionary of restricted fields
Top

PROTECTED CHARACTER ResourceUri (handle, character, IRestResourceFormatParameter)
Purpose: Returns a Resource URI for the given record
Notes: A resource URI is only valid, when all data-items are > ""

Parameters:
phBuffer HANDLE
The handle of the buffer that contains the data for this resource
pcAddress CHARACTER
The address string
poParameter Consultingwerk.OERA.RestResource.IRestResourceFormatParameter
The format parameters
Returns CHARACTER
The resource URI
Top

PROTECTED CHARACTER UrlPrefix (IWebRequest)
Purpose: Returns the UrlPrefix (hostname, port and /web/Entities)
Notes:

Parameters:
poRequest OpenEdge.Web.IWebRequest
The web request
Returns CHARACTER
The Url Prefix


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