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

File:ProparseWebBlock
Purpose:Represents a Block
Author(s):Sebastian Wandel / Consultingwerk Ltd.
Created:Thu Oct 22 10:01:38 CEST 2020
Purpose: Constructor for the ProparseWebBlock class
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
# InitArrays () Initializes the extent properties
# 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
+ ProparseWebBlock (IProparseWebSession, JsonObject) Constructor for the ProparseWebBlock class

Top Property Summary
Options Name Purpose
# Progress.Json.ObjectModel.JsonObject BaseJson
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
+ Consultingwerk.Studio.ProparseApi.ITableBuffer BlockBuffers
+ Consultingwerk.Studio.ProparseApi.IFrame DefaultFrame
+ Consultingwerk.Studio.ProparseApi.IFrame Frames
# Progress.Json.ObjectModel.JsonObject Links
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
+ LOGICAL MethodBlock
+ Consultingwerk.Studio.ProparseApi.INode Node
+ Consultingwerk.Studio.ProparseApi.IBlock Parent
+ LOGICAL ProgramBlock
+ LOGICAL RootBlock
# Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.IProparseWebSession Session
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
+ Consultingwerk.Studio.ProparseApi.ISymbolScope SymbolScope


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 InitArrays ()

Purpose: Initializes the extent properties
Notes:

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 ProparseWebBlock (IProparseWebSession, JsonObject)

Purpose: Constructor for the ProparseWebBlock 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

PUBLIC Consultingwerk.Studio.ProparseApi.ITableBuffer BlockBuffers


Returns Consultingwerk.Studio.ProparseApi.ITableBuffer
Top

PUBLIC Consultingwerk.Studio.ProparseApi.IFrame DefaultFrame


Returns Consultingwerk.Studio.ProparseApi.IFrame
Top

PUBLIC Consultingwerk.Studio.ProparseApi.IFrame Frames


Returns Consultingwerk.Studio.ProparseApi.IFrame
Top

PROTECTED Progress.Json.ObjectModel.JsonObject Links

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

Returns Progress.Json.ObjectModel.JsonObject
Top

PUBLIC LOGICAL MethodBlock


Returns LOGICAL
Top

PUBLIC Consultingwerk.Studio.ProparseApi.INode Node


Returns Consultingwerk.Studio.ProparseApi.INode
Top

PUBLIC Consultingwerk.Studio.ProparseApi.IBlock Parent


Returns Consultingwerk.Studio.ProparseApi.IBlock
Top

PUBLIC LOGICAL ProgramBlock


Returns LOGICAL
Top

PUBLIC LOGICAL RootBlock


Returns LOGICAL
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 Consultingwerk.Studio.ProparseApi.ISymbolScope SymbolScope


Returns Consultingwerk.Studio.ProparseApi.ISymbolScope


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