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

Inherits: Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebFieldContainer
Implements: Consultingwerk.Studio.ProparseApi.IFieldContainer, Consultingwerk.Studio.ProparseApi.IFrame

File:ProparseWebFrame
Purpose:Represents a Frame
Author(s):Sebastian Wandel / Consultingwerk Ltd.
Created:Thu Oct 22 16:29:51 CEST 2020
Purpose: Returns the Frame Scope Block
Notes:

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



Top Method Summary
Options Name Purpose
+ Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebFrame Array (IProparseWebSession, JsonArray) Turns a JsonArray into an array of ProparseWebFrame
# 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
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebFieldContainer
# 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
+ ProparseWebFrame (IProparseWebSession, JsonObject) Constructor for the ProparseWebFrame class

Top Property Summary
Options Name Purpose
+ Consultingwerk.Studio.ProparseApi.ISymbol AllFields
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebFieldContainer
+ Consultingwerk.Studio.ProparseApi.ISymbol AllFieldsAndWidgets
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebFieldContainer
# Progress.Json.ObjectModel.JsonObject BaseJson
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
+ Consultingwerk.Studio.ProparseApi.ISymbol EnabledFields
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebFieldContainer
+ Consultingwerk.Studio.ProparseApi.IBlock FrameScopeBlock
# 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
+ Consultingwerk.Studio.ProparseApi.INode Statements
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebFieldContainer


Method Detail
Top

PUBLIC Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebFrame Array (IProparseWebSession, JsonArray)
Purpose: Turns a JsonArray into an array of ProparseWebFrame
Notes:

Parameters:
poSession Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.IProparseWebSession
The session for which this array is created
poJsonArray Progress.Json.ObjectModel.JsonArray
The source JsonArray
Returns Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebFrame
The resulting ProparseWebFrame array
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 ()
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebFieldContainer
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 ProparseWebFrame (IProparseWebSession, JsonObject)
Purpose: Constructor for the ProparseWebFrame 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

PUBLIC Consultingwerk.Studio.ProparseApi.ISymbol AllFields
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebFieldContainer

Returns Consultingwerk.Studio.ProparseApi.ISymbol
Top

PUBLIC Consultingwerk.Studio.ProparseApi.ISymbol AllFieldsAndWidgets
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebFieldContainer

Returns Consultingwerk.Studio.ProparseApi.ISymbol
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.ISymbol EnabledFields
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebFieldContainer

Returns Consultingwerk.Studio.ProparseApi.ISymbol
Top

PUBLIC Consultingwerk.Studio.ProparseApi.IBlock FrameScopeBlock

Returns Consultingwerk.Studio.ProparseApi.IBlock
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 Consultingwerk.Studio.ProparseApi.INode Statements
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebFieldContainer

Returns Consultingwerk.Studio.ProparseApi.INode


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