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

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

File:RestMethodResponse
Purpose:Return type for RESTful methods which allows to customize
the HTTP StatusCode, StatusReason and ContentType
Description:RESTful methods support various return types (JSON, ISerializable)
When the response type implements this Interface, further
options for manipulating the HTTP response are available
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sat Sep 01 07:24:49 CEST 2018
Purpose: Gets and sets the HTTP ContentType of the response
Notes: Defaults to application/json

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


Top Constructor Summary
Options Name Purpose
+ RestMethodResponse (StatusCodeEnum) Constructor for the RestMethodResponse class
+ RestMethodResponse (Object, character) Constructor for the RestMethodResponse class
+ RestMethodResponse (Object, character, StatusCodeEnum) Constructor for the RestMethodResponse class
+ RestMethodResponse (Object, character, StatusCodeEnum, character) Constructor for the RestMethodResponse class
+ RestMethodResponse (Object, StatusCodeEnum) Constructor for the RestMethodResponse class
+ RestMethodResponse (Object, StatusCodeEnum, character) Constructor for the RestMethodResponse class

Top Property Summary
Options Name Purpose
+ CHARACTER ContentType
+ Progress.Lang.Object Entity
+ OpenEdge.Net.HTTP.HttpHeader Headers
+ OpenEdge.Net.HTTP.StatusCodeEnum StatusCode
+ CHARACTER StatusReason


Constructor Detail
Top

PUBLIC RestMethodResponse (StatusCodeEnum)
Purpose: Constructor for the RestMethodResponse class
Notes:

Parameters:
poStatusCode OpenEdge.Net.HTTP.StatusCodeEnum
The response StatusCode (StatusCodeEnum)
Top

PUBLIC RestMethodResponse (Object, character)
Purpose: Constructor for the RestMethodResponse class
Notes:

Parameters:
poEntity Progress.Lang.Object
The response entity (payload)
pcContentType CHARACTER
The response content type
Top

PUBLIC RestMethodResponse (Object, character, StatusCodeEnum)
Purpose: Constructor for the RestMethodResponse class
Notes:

Parameters:
poEntity Progress.Lang.Object
The response entity (payload)
pcContentType CHARACTER
The response content type
poStatusCode OpenEdge.Net.HTTP.StatusCodeEnum
The response StatusCode (StatusCodeEnum)
Top

PUBLIC RestMethodResponse (Object, character, StatusCodeEnum, character)
Purpose: Constructor for the RestMethodResponse class
Notes:

Parameters:
poEntity Progress.Lang.Object
The response entity (payload)
pcContentType CHARACTER
The response content type
poStatusCode OpenEdge.Net.HTTP.StatusCodeEnum
The response StatusCode (StatusCodeEnum)
pcStatusReason CHARACTER
The response StatusReason
Top

PUBLIC RestMethodResponse (Object, StatusCodeEnum)
Purpose: Constructor for the RestMethodResponse class
Notes:

Parameters:
poEntity Progress.Lang.Object
The response entity (payload)
poStatusCode OpenEdge.Net.HTTP.StatusCodeEnum
The response StatusCode (StatusCodeEnum)
Top

PUBLIC RestMethodResponse (Object, StatusCodeEnum, character)
Purpose: Constructor for the RestMethodResponse class
Notes:

Parameters:
poEntity Progress.Lang.Object
The response entity (payload)
poStatusCode OpenEdge.Net.HTTP.StatusCodeEnum
The response StatusCode (StatusCodeEnum)
pcStatusReason CHARACTER
The response StatusReason


Property Detail
Top

PUBLIC CHARACTER ContentType

Returns CHARACTER
Top

PUBLIC Progress.Lang.Object Entity

Returns Progress.Lang.Object
Top

PUBLIC OpenEdge.Net.HTTP.HttpHeader Headers

Returns OpenEdge.Net.HTTP.HttpHeader
Top

PUBLIC OpenEdge.Net.HTTP.StatusCodeEnum StatusCode

Returns OpenEdge.Net.HTTP.StatusCodeEnum
Top

PUBLIC CHARACTER StatusReason

Returns CHARACTER


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