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

Inherits: Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
Implements: Consultingwerk.Studio.ProparseApi.ISymbolScope

File:ProparseWebSymbolScope
Purpose:Represents a Symbol Scope
Author(s):Sebastian Wandel / Consultingwerk Ltd.
Created:Fri Oct 23 09:50:00 CEST 2020

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



Top Method Summary
Options Name Purpose
+ Consultingwerk.Studio.ProparseApi.ISymbolScope AllChildScopesDeep () Get a list of all child scopes, and their child scopes, etc
+ Consultingwerk.Studio.ProparseApi.ISymbol AllSymbolsDeep () Get a list of this scope's symbols, and all symbols of all descendant scopes
+ Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebSymbolScope Array (IProparseWebSession, JsonArray) Turns a JsonArray into an array of ProparseWebSymbolScope
# 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
+ ProparseWebSymbolScope (IProparseWebSession, JsonObject) Constructor for the ProparseWebSymbolScope class

Top Property Summary
Options Name Purpose
+ Consultingwerk.Studio.ProparseApi.ISymbol AllSymbols
# Progress.Json.ObjectModel.JsonObject BaseJson
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
+ Consultingwerk.Studio.ProparseApi.ITableBuffer Buffers
+ Consultingwerk.Studio.ProparseApi.ICall Calls
+ Consultingwerk.Studio.ProparseApi.ISymbolScope ChildScopes
+ INTEGER Depth
# Progress.Json.ObjectModel.JsonObject Links
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
+ Consultingwerk.Studio.ProparseApi.ISymbolScope ParentScope
+ Consultingwerk.Studio.ProparseApi.IBlock RootBlock
+ Consultingwerk.Studio.ProparseApi.ISymbolScope RootScope
# Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.IProparseWebSession Session
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject
+ Consultingwerk.Studio.ProparseApi.IVariable Variables


Method Detail
Top

PUBLIC Consultingwerk.Studio.ProparseApi.ISymbolScope AllChildScopesDeep ()
Purpose: Get a list of all child scopes, and their child scopes, etc
Notes:

Returns Consultingwerk.Studio.ProparseApi.ISymbolScope
The array of ISymbolScope's
Top

PUBLIC Consultingwerk.Studio.ProparseApi.ISymbol AllSymbolsDeep ()
Purpose: Get a list of this scope's symbols, and all symbols
of all descendant scopes
Notes:

Returns Consultingwerk.Studio.ProparseApi.ISymbol
The array of ISymbol's
Top

PUBLIC Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebSymbolScope Array (IProparseWebSession, JsonArray)
Purpose: Turns a JsonArray into an array of ProparseWebSymbolScope
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.ProparseWebSymbolScope
The resulting ProparseWebSymbolScope 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 ()
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 ProparseWebSymbolScope (IProparseWebSession, JsonObject)
Purpose: Constructor for the ProparseWebSymbolScope 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 AllSymbols

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.ITableBuffer Buffers

Returns Consultingwerk.Studio.ProparseApi.ITableBuffer
Top

PUBLIC Consultingwerk.Studio.ProparseApi.ICall Calls

Returns Consultingwerk.Studio.ProparseApi.ICall
Top

PUBLIC Consultingwerk.Studio.ProparseApi.ISymbolScope ChildScopes

Returns Consultingwerk.Studio.ProparseApi.ISymbolScope
Top

PUBLIC INTEGER Depth

Returns INTEGER
Top

PROTECTED Progress.Json.ObjectModel.JsonObject Links
Inherited from Consultingwerk.Studio.ProparseApi.Implementation.ProparseWeb.ProparseWebObject

Returns Progress.Json.ObjectModel.JsonObject
Top

PUBLIC Consultingwerk.Studio.ProparseApi.ISymbolScope ParentScope

Returns Consultingwerk.Studio.ProparseApi.ISymbolScope
Top

PUBLIC Consultingwerk.Studio.ProparseApi.IBlock RootBlock

Returns Consultingwerk.Studio.ProparseApi.IBlock
Top

PUBLIC Consultingwerk.Studio.ProparseApi.ISymbolScope RootScope

Returns Consultingwerk.Studio.ProparseApi.ISymbolScope
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.IVariable Variables

Returns Consultingwerk.Studio.ProparseApi.IVariable


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