| |
Options |
Name |
Purpose |
|
|
|
BuildArguments (IWebRequest, Object, IHttpResponse, DataObjectService, MappedOperation)
|
/* Builds the parameters for execution by an 'entity'
@param IWebRequest The request that resulting in the exception
@param P.L.Object The message body of the incoming request. Typically
will be transformed from bytes into something useful; may also have an envelope removed.
@param IHttpResponse The current response object, if any
@param DataObjectService The current service
@param MappedOperation The current operation
@return IList<OperationArgument> The list or arguments. This list will always have at least 1 entry (for the return value, even if it's a void return value) */
|
|
|
|
INTEGER Execute (IWebRequest, Object, IHttpResponse, DataObjectService, MappedOperation, Object)
|
/* Executes the operation.
@param IWebRequest The request that resulting in the exception
@param P.L.Object The message body of the incoming request. Typically
will be transformed from bytes into something useful; may also have an envelope removed.
@param IHttpResponse The current response object, if any
@param DataObjectService The service being operated on
@param MappedOperation The mapped operation
@param P.L.Object The business entity (business logic service)
@return integer A non-null status code use to deal with errors */
|
|
|
|
ExtractTableData (OperationArgument)
|
/* Extracts temp-table or dataset data from a handle-based structure (which is how
we work with them in the DOH and friends) into a MEMPTR ... we need to do this
in this helper class since the operation decides whether to write BI data or not.
@param OperationArgument The *output or return parameter argument*/
|
|
|
|
Progress.Lang.Object GetElementValue (MessageElement, Object, Class)
|
/* Returns a value for a message element from the argvalue
@param MessageElement The message element
@param Progress.Lang.Object The argument value holder
@param Progress.Lang.Class The type of the argument value */
|
|
|
|
GetInputValue (OperationArgument, Object, IWebRequest)
|
/** Extract input values from the HTTP request and set against the argument.
@param OperationArgument The current argument
@param Object The incoming message body
@param IWebRequest The incoming request */
|
|
|
|
InitDataStructure (OperationArgument)
|
/* Creates/inits a temp-table or dataset for used as an argument.
we pass in the value writer since we may (in some case) write
schema once and then write data into that structure.
@param OperationArgument The current argument */
|
|
|
|
Progress.Lang.Object ReadArgumentArray (Class, Object, integer)
|
/* Reads a value from an argument array for a message element
@param Progress.Lang.Class The argument type
@param Progress.Lang.Object The returned argument (will be type-of() the arg type but not necessarily =
@param integer The index to use
@return Progress.Lang.Object The object value of the array element */
|
|
|
|
Progress.Lang.Object ReadArgumentProperty (Class, Object, character)
|
/* Reads a value from an object argument property (returned by the Business Logic) for a message element
@param Progress.Lang.Class The argument type
@param Progress.Lang.Object The returned argument (will be type-of() the arg type but not necessarily EQ)
@param character The property name to read. This can be a property name ("prop"), or if the property is an object,
one or more properties of it or its children, using dots to separate the names. For example,
"prop.prop1.prop2". If a child property cannot be read (not public, does not exist) then the entire
parent value is returned.
If the property is an array, then an index can be used, eg "prop[3]", on any of
the properties. If the index is out of bounds or the array is indeterminate, then the entire property
value is returned.
@return Progress.Lang.Object The object value of the property */
|
|
|
|
ReadFieldValue (OperationArgument, MessageElement, IWebRequest, Object, ArgumentValueWriter)
|
/* Reads the value of a named field from the body.
@param OperationArgument The current argument being processed
@param MessageElement The message element we are reading from
@param IWebRequest The request message
@param Progress.Lang.Object The message body (firld source)
@param ArgumentValueWriter The writer used for this field */
|
|
|
|
Progress.Lang.Object ReadFormFieldValue (OperationArgument, character, IStringStringMap)
|
/* Reads the value of a named field from the APPLICATION/X-WWW-FORM-URLENCODED body.
@param OperationArgument The current argument being processed
@param character The field name to read
@param IStringStringMap The message body
@return Progress.Lang.Object The field value */
|
|
|
|
Progress.Lang.Object ReadFormFieldValue (OperationArgument, character, MultipartEntity)
|
/* Reads the value of a named field from the MULTIPART/FORM-DATA body.
@param OperationArgument The current argument being processed
@param character The field name to read
@param MultipartEntity The message body
@return Progress.Lang.Object The field value */
|
|
|
|
CHARACTER ReadHeaderValue (MessageElement, IWebRequest)
|
/* Reads the value (base or or parameter) from a named header
@param MessageElement The message element we are reading from
@param IWebRequest The request message
@return character The header value (base or parameter) */
|
|
|
|
Progress.Lang.Object ReadJsonFieldValue (OperationArgument, character, JsonObject)
|
/* Reads the value of a named field from the JSON-OBJCET body.
@param OperationArgument The current argument being processed
@param character The field name to read
@param JsonObject The message body
@return Progress.Lang.Object The field value */
|
|
|
|
Progress.Lang.Object ReadXmlFieldValue (OperationArgument, character, Object)
|
/* Reads the value of a named field from the MULTIPART/FORM-DATA body.
@param OperationArgument The current argument being processed
@param character The field name to read
@param Progress.Lang.Object The message body
@return Progress.Lang.Object The field value */
|
|
|
|
SetOutputValue (OperationArgument, IHttpResponse)
|
/* Sets the output/return value from the target function into the HTTP response
@param OperationArgument The current argument
@param IHttpResponse The response being built */
|
|
|
|
SetTrackingChanges (OperationArgument, logical)
|
/* Sets the value of a dataset's contained buffers' tracking-changes value.
THIS METHOD SHOULD BE CALLED WITH CARE - SCHEMAS (FROM ~11.7) WILL BE CREATED
BY THE ServiceRegistryLoader WITH BEFORE-TABLES AND SO THIS STEP IS NOT
NECESSARY.
@param OperationArgument The argument containing the dataset
@param logical TRUE to enable TRACKING-CHANGES */
|
|
|
|
WriteFieldValue (OperationArgument, character, Object, IHttpResponse)
|
/* Writes a field name/value for the appropriate content type
@param OperationArgument The value, etc for the argument
@param character The field name element we're working with
@param Progress.Lang.Object The element value for this field
@param IHttpResponse The response being written */
|