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

Inherits: Progress.Lang.Object
Implements: Consultingwerk.Studio.ProparseApi.IProparseApi


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



Top Method Summary
Options Name Purpose
CheckInitialized (character) Checks/asserts that the API is initialized
dispose () Terminates the attached ParseUnits
CHARACTER GetVersion () Returns the Version of the Webservice
initialize () Initializes the api
InitializeSession () Helper method to execute a GET-request on the /proparse/initialize interface
LOGICAL IsKeywordType (NodeTypesEnum) Returns whether the given node type represents an ABL keyword
Consultingwerk.Studio.ProparseApi.IParseUnit ParseFile (character) Parses a file and returns the Parse Unit
SetDatabaseSchema () Helper method to execute a POST-request on the /proparse/setDatabase interface
SetEnvironment () Helper method to execute a POST-request on the /proparse/setEnvironment interface

Top Constructor Summary
Options Name Purpose
ProparseWebApi () Constructor for the ProparseWebApi class

Top Property Summary
Options Name Purpose
CHARACTER BaseUrl


Method Detail
Top

CheckInitialized (character)
Purpose: Checks/asserts that the API is initialized
Notes:

Parameters:
pcFileName CHARACTER
The name of the file to be parsed
Top

dispose ()
Purpose: Terminates the attached ParseUnits
Notes:

Top

CHARACTER GetVersion ()
Purpose: Returns the Version of the Webservice
Notes:

Returns CHARACTER
Version
Top

initialize ()
Purpose: Initializes the api
Notes:

Top

InitializeSession ()
Purpose: Helper method to execute a GET-request on the /proparse/initialize interface
Notes:

Top

LOGICAL IsKeywordType (NodeTypesEnum)
Purpose: Returns whether the given node type represents an ABL keyword
Notes: Calls the /proparse/isKeywordType REST endpoint which delegates
to NodeTypes.isKeywordType(int) on the Java side

Parameters:
poType Consultingwerk.Studio.ProparseApi.NodeTypesEnum
The NodeTypesEnum member to check
Returns LOGICAL
Logical value indicating if the node type represents an ABL keyword
Top

Consultingwerk.Studio.ProparseApi.IParseUnit ParseFile (character)
Purpose: Parses a file and returns the Parse Unit
Notes:

Parameters:
pcFileName CHARACTER
The name of the file to parse
Returns Consultingwerk.Studio.ProparseApi.IParseUnit
The reference to the IParseUnit instance
Top

SetDatabaseSchema ()
Purpose: Helper method to execute a POST-request on the /proparse/setDatabase interface
Notes:

Top

SetEnvironment ()
Purpose: Helper method to execute a POST-request on the /proparse/setEnvironment interface
Notes:



Constructor Detail
Top

ProparseWebApi ()
Purpose: Constructor for the ProparseWebApi class
Notes:



Property Detail
Top

CHARACTER BaseUrl

Returns CHARACTER


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       20.07.2026 16:11:36