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

File:ProparseWebApi
Author(s):Sebastian Wandel / Consultingwerk Ltd.
Created:Mon Oct 26 09:17:44 CET 2020



Top Method Summary
Options Name Purpose
+ dispose () Terminates the attached ParseUnits
+ initialize () Initializes the api
- InitializeSession () Helper method to execute a GET-request on the /proparse/initialize interface
+ 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

PUBLIC dispose ()

Purpose: Terminates the attached ParseUnits
Notes:

Top

PUBLIC initialize ()

Purpose: Initializes the api
Notes:

Top

PRIVATE InitializeSession ()

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

Top

PUBLIC 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

PRIVATE SetDatabaseSchema ()

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

Top

PRIVATE SetEnvironment ()

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



Constructor Detail
Top

PUBLIC ProparseWebApi ()

Purpose: Constructor for the ProparseWebApi class
Notes:



Property Detail
Top

PUBLIC CHARACTER BaseUrl


Returns CHARACTER


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