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

Inherits: Progress.Lang.Object
Implements: Consultingwerk.OERA.RestResource.IRestResourceFormatParameter
SERIALIZABLE

Purpose: The URI template. eg "/Customers/{CustNum}"
Notes:

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



Top Method Summary
Options Name Purpose
# BuildValues (character, IWebRequest) Extracts a set of values from the REST address and the web request, and adds them to this-object's Values list Notes : * @param pcAddress : The rest address for the resource @param poWebRequest : The HTTP request that is being serviced */

Top Constructor Summary
Options Name Purpose
# RestResourceFormatParameter () Default constructor
+ RestResourceFormatParameter (character, character, character, character, IWebRequest, ListNameValuePair) Constructor Notes : If no values parameter is passed in, the set of values will be constructed based on the address and web request passed in. * @param pcAddress : The rest address for the resource (mandatory) @param pcTables : The list of tables to return (mandatory) @param pcFields : A list of fields to return (mandatory) @param pcIdField : The id field(s) (optional) @param poWebRequest : The HTTP request that is being serviced (mandatory) @param poValues : A set of mapped values (optional) */
+ RestResourceFormatParameter (IRestRequest, IWebRequest, character) Constructor

Top Property Summary
Options Name Purpose
+ LOGICAL AddSelfUrl
+ CHARACTER ChildAddresses
+ CHARACTER Fields
+ CHARACTER IdField
+ CHARACTER Links
+ OpenEdge.Web.IWebRequest Request
+ CHARACTER RestAddress
+ CHARACTER Tables
+ Consultingwerk.ListNameValuePair Values


Method Detail
Top

PROTECTED BuildValues (character, IWebRequest)
Purpose: Extracts a set of values from the REST address and the web request,
and adds them to this-object's Values list
Notes :

Parameters:
pcAddress CHARACTER
: The rest address for the resource
poWebRequest OpenEdge.Web.IWebRequest
: The HTTP request that is being serviced


Constructor Detail
Top

PROTECTED RestResourceFormatParameter ()
Purpose: Default constructor
Notes: Needed for serialisation purposes

Top

PUBLIC RestResourceFormatParameter (character, character, character, character, IWebRequest, ListNameValuePair)
Purpose: Constructor
Notes : If no values parameter is passed in, the set of values will be constructed
based on the address and web request passed in.

Parameters:
pcAddress CHARACTER
: The rest address for the resource (mandatory)
pcTables CHARACTER
: The list of tables to return (mandatory)
pcFields CHARACTER
: A list of fields to return (mandatory)
pcIdField CHARACTER
: The id field(s) (optional)
poWebRequest OpenEdge.Web.IWebRequest
: The HTTP request that is being serviced (mandatory)
poValues Consultingwerk.ListNameValuePair
: A set of mapped values (optional)
Top

PUBLIC RestResourceFormatParameter (IRestRequest, IWebRequest, character)
Purpose: Constructor
Notes:
value is not used (though may be part of the determination of the)
input value

Parameters:
poRestRequest Consultingwerk.OERA.RestResource.IRestRequest
A rest request whose values will be copied
poWebRequest OpenEdge.Web.IWebRequest
: The HTTP request that is being serviced (mandatory)
pcFields CHARACTER
: A list of fields to use. The RestRequest's RestAddress:Fields


Property Detail
Top

PUBLIC LOGICAL AddSelfUrl

Returns LOGICAL
Top

PUBLIC CHARACTER ChildAddresses

Returns CHARACTER
Top

PUBLIC CHARACTER Fields

Returns CHARACTER
Top

PUBLIC CHARACTER IdField

Returns CHARACTER
Top

PUBLIC CHARACTER Links

Returns CHARACTER
Top

PUBLIC OpenEdge.Web.IWebRequest Request

Returns OpenEdge.Web.IWebRequest
Top

PUBLIC CHARACTER RestAddress

Returns CHARACTER
Top

PUBLIC CHARACTER Tables

Returns CHARACTER
Top

PUBLIC Consultingwerk.ListNameValuePair Values

Returns Consultingwerk.ListNameValuePair


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