Namespace: Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb
Class 
ProparseWebRunHandle Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
Implements: Consultingwerk.Studio.ProparseApi.IRunHandle

File:ProparseWebRunHandle
Purpose:A HANDLE Variable that has been set by running a Procedure persistently
Author(s):Sebastian Wandel / Consultingwerk Ltd.
Created:Fri Oct 23 11:58:14 CEST 2020
Purpose: The name of the procedure this handle is set to.
Notes:



Top Method Summary
Options Name Purpose
# LOGICAL CanGetProperty (JsonObject, character) Helper method to check whether a property can be retrieved from a JSON object
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
# Consultingwerk.Studio.ProparseApi.INode GetNode (character) Helper method to get a node from the backend and create the object
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
# Progress.Lang.Object PostRequest (character, JsonConstruct) Executes a POST request on the server
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
# Progress.Json.ObjectModel.JsonArray RequestJsonArray (character) Helper method to get a JSON array from the server
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
# Progress.Json.ObjectModel.JsonObject RequestJsonObject (character) Helper method to get a JSON object from the server
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject

Top Constructor Summary
Options Name Purpose
+ ProparseWebRunHandle (IProparseWebSession, JsonObject) Constructor for the ProparseWebRunHandle class

Top Property Summary
Options Name Purpose
# Progress.Json.ObjectModel.JsonObject BaseJson
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
# Progress.Json.ObjectModel.JsonObject Links
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
# Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.IProparseWebSession Session
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
+ CHARACTER Value


Method Detail
Top

PROTECTED LOGICAL CanGetProperty (JsonObject, character)

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
Purpose: Helper method to check whether a property can be retrieved from a JSON object
Notes:

Parameters:
poJson Progress.Json.ObjectModel.JsonObject
The Json object to retrieve the property from
pcProperty CHARACTER
Name of the property to retrieve
Returns LOGICAL
TRUE/FALSE whether pcProperty can be retrieved from poJson
Top

PROTECTED Consultingwerk.Studio.ProparseApi.INode GetNode (character)

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
Purpose: Helper method to get a node from the backend and create the object
Notes:

Parameters:
pcLink CHARACTER
Link to the node resource
Returns Consultingwerk.Studio.ProparseApi.INode
The requested node
Top

PROTECTED Progress.Lang.Object PostRequest (character, JsonConstruct)

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
Purpose: Executes a POST request on the server
Notes:

Parameters:
pcUri CHARACTER
URI for the request
poJson Progress.Json.ObjectModel.JsonConstruct
Content for the request
Returns Progress.Lang.Object
The response entity
Top

PROTECTED Progress.Json.ObjectModel.JsonArray RequestJsonArray (character)

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
Purpose: Helper method to get a JSON array from the server
Notes:

Parameters:
pcRequestLink CHARACTER
Link to the requested resource
Returns Progress.Json.ObjectModel.JsonArray
JSON array from the response
Top

PROTECTED Progress.Json.ObjectModel.JsonObject RequestJsonObject (character)

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
Purpose: Helper method to get a JSON object from the server
Notes:

Parameters:
pcRequestLink CHARACTER
Link to the requested resource
Returns Progress.Json.ObjectModel.JsonObject
JSON object from the response


Constructor Detail
Top

PUBLIC ProparseWebRunHandle (IProparseWebSession, JsonObject)

Purpose: Constructor for the ProparseWebRunHandle class
Notes:

Parameters:
poSession Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.IProparseWebSession
The session for which this object is being created, also holds HttpClient and JSessionID
poJson Progress.Json.ObjectModel.JsonObject
The JsonObject from which this object is being created


Property Detail
Top

PROTECTED Progress.Json.ObjectModel.JsonObject BaseJson

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject

Returns Progress.Json.ObjectModel.JsonObject
Top

PROTECTED Progress.Json.ObjectModel.JsonObject Links

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject

Returns Progress.Json.ObjectModel.JsonObject
Top

PROTECTED Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.IProparseWebSession Session

Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject

Returns Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.IProparseWebSession
Top

PUBLIC CHARACTER Value


Returns CHARACTER


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.12.2024 13:23:07