Namespace: Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb
Class 
ProparseWebObject Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject

Inherits: Progress.Lang.Object
Inherited by: Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebBlock Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebBufferScope Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebCall Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebField Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebFieldBuffer Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebFieldContainer Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebFrame Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebNode Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebBlockNode Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebProgramRootNode Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebFieldRefNode Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebProparseDirectiveNode Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebRecordNameNode Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebParameter Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebRunHandle Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebSymbol Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebSymbolScope Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebTable Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebTableBuffer Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebVariable
ABSTRACT

File:ProparseWebObject
Purpose:Common base class for objects created from JSON files
Author(s):Sebastian Wandel / Consultingwerk Ltd.
Created:Thu Oct 22 11:20:16 CEST 2020
Purpose: Constructor for ProparseWebObjects
Notes:

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



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

Top Constructor Summary
Options Name Purpose
+ ProparseWebObject (IProparseWebSession, JsonObject) Constructor for ProparseWebObjects

Top Property Summary
Options Name Purpose
# Progress.Json.ObjectModel.JsonObject BaseJson
# Progress.Json.ObjectModel.JsonObject Links
# Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.IProparseWebSession Session


Method Detail
Top

PROTECTED LOGICAL CanGetProperty (JsonObject, character)
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)
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)
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)
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)
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 ProparseWebObject (IProparseWebSession, JsonObject)
Purpose: Constructor for ProparseWebObjects
Notes:

Parameters:
poSession Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.IProparseWebSession
The session this object will be created in
poJson Progress.Json.ObjectModel.JsonObject
JSON representation of the object to create


Property Detail
Top

PROTECTED Progress.Json.ObjectModel.JsonObject BaseJson

Returns Progress.Json.ObjectModel.JsonObject
Top

PROTECTED Progress.Json.ObjectModel.JsonObject Links

Returns Progress.Json.ObjectModel.JsonObject
Top

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

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


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 06:16:04