Namespace: Consultingwerk.BusinessEntityDesigner.Plugins
Class 
RestServiceGeneratorPlugin Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.BusinessEntityDesigner.Plugins.RestServiceGeneratorPlugin

Inherits: Progress.Lang.Object
Implements: Consultingwerk.BusinessEntityDesigner.IBusinessEntityDesignerPlugin

File:RestServiceGeneratorPlugin
Purpose:Business Entity Designer Plugin that allows to generate
Proxy Classes for Business Entities. These proxy classes
allow to expose Business Entities using the REST Adapter
to OpenEdge mobile or compatible clients.
Description:Adds a "Include Files" and "Service Interface" buttons
to the Ribbon of the Business Entity Designer. Those buttons
allow to generate include files (excluding any XML specific
properties in the source code) and REST Service Interface
classes that can be added to a REST service.
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Fri Jun 07 21:40:37 CEST 2013
Notes:The use of the code generated by this plugin is no longer
recommended. We recommend customers to export Business
Entities dynamically using the Generic Service Interface

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



Top Method Summary
Options Name Purpose
# CHARACTER CheckTemplatePath (character) Locates a template file and throws an Error when the template cannot be located
# CHARACTER ChildTablesOf (character) Returns the child tables of the given temp-table
# CHARACTER GenerateDataset () Generates the dataset include file
+ GenerateIncludeFiles (dataset) Generates the Include Files with the data schema used by the REST Service "Business Entity" classes
+ GenerateServiceInterface (dataset) Generates the Service Interface class (called Business Entity in PDSOE)
# CHARACTER GenerateTempTables () Generates the temp-table include files
# CHARACTER GetTopNavBuffers () Returns the comma delimited list of the top-nav buffers of the generated dataset
+ Shutdown () Method called when the Business Entity Designer will get closed
+ Startup (dataset, BusinessEntityDatasetController, BusinessEntityDesignerForm, UltraToolbarsManager) Method called when the Business Entity Designer is starting and has loaded the plugin.
# ToolClickHandler (Object, ToolClickEventArgs) Handles the ToolClick event of the Business Entity Designer's UltraToolbarsManager

Top Constructor Summary
Options Name Purpose
+ RestServiceGeneratorPlugin () Constructor for the RestServiceGeneratorPlugin class


Method Detail
Top

PROTECTED CHARACTER CheckTemplatePath (character)
Purpose: Locates a template file and throws an Error when the template
cannot be located
Notes:

Parameters:
pcFileName CHARACTER
The relative name of the template file
Returns CHARACTER
Full pathname of the template
Top

PROTECTED CHARACTER ChildTablesOf (character)
Purpose: Returns the child tables of the given temp-table
Notes:

Parameters:
pcParentTable CHARACTER
The name of the parent table to return the child tables of
Returns CHARACTER
Comma delimited list of child temp-tables of the parent table
Top

PROTECTED CHARACTER GenerateDataset ()
Purpose: Generates the dataset include file
Notes:

Returns CHARACTER
The file name of the generated dataset include file
Top

PUBLIC GenerateIncludeFiles (dataset)
Purpose: Generates the Include Files with the data schema used by the
REST Service "Business Entity" classes
Notes:

Parameters:
dsBusinessEntity DATASET dsBusinessEntity
Business Entity with the Design dataset, called with the BIND keyword
Top

PUBLIC GenerateServiceInterface (dataset)
Purpose: Generates the Service Interface class (called Business Entity in PDSOE)
Notes:

Parameters:
dsBusinessEntity DATASET dsBusinessEntity
Business Entity with the Design dataset, called with the BIND keyword
Top

PROTECTED CHARACTER GenerateTempTables ()
Purpose: Generates the temp-table include files
Notes:

Returns CHARACTER
Comma-delimited list of the generated temp-table include files
Top

PROTECTED CHARACTER GetTopNavBuffers ()
Purpose: Returns the comma delimited list of the top-nav buffers of the generated dataset
Notes:

Returns CHARACTER
The comma delimited list of the top-nav buffers
Top

PUBLIC Shutdown ()
Purpose: Method called when the Business Entity Designer will get closed
Notes:

Top

PUBLIC Startup (dataset, BusinessEntityDatasetController, BusinessEntityDesignerForm, UltraToolbarsManager)
Purpose: Method called when the Business Entity Designer is starting and
has loaded the plugin.
Notes: Passes references to some key components of the Designer to
the plugin, use this to initialize the plugin, subscribe to events

Parameters:
dsBusinessEntity DATASET dsBusinessEntity
Business Entity with the Design dataset, called with the BIND keyword
poController Consultingwerk.BusinessEntityDesigner.Services.BusinessEntityDatasetController
The BusinessEntityDatasetController
poForm Consultingwerk.BusinessEntityDesigner.UI.BusinessEntityDesignerForm
The main Form of the BusinessEntityDesigner
poToolbar Infragistics.Win.UltraWinToolbars.UltraToolbarsManager
The reference to the UltraToolbarsManager used by the BusinessEntityDesigner
Top

PROTECTED ToolClickHandler (Object, ToolClickEventArgs)
Purpose: Handles the ToolClick event of the Business Entity Designer's
UltraToolbarsManager
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e Infragistics.Win.UltraWinToolbars.ToolClickEventArgs
The ToolClickEventArgs with the data for this event


Constructor Detail
Top

PUBLIC RestServiceGeneratorPlugin ()
Purpose: Constructor for the RestServiceGeneratorPlugin class
Notes:



ProDataset Detail

ProDataset dsBusinessEntity

Member tables: eBusinessEntity, eDataRelation, eDataRelationProperties, eTable, eField, eFieldProperties, eIndex, eIndexProperties, eTableProperties, eBusinessEntityProperties


Temp-Table Detail

Temp-Table eBusinessEntity

Defined in:

Temp-Table eBusinessEntityProperties

Defined in:

Temp-Table eDataRelation

Defined in:

Temp-Table eDataRelationProperties

Defined in:

Temp-Table eField

Defined in:

Temp-Table eFieldProperties

Defined in:

Temp-Table eIndex

Defined in:

Temp-Table eIndexProperties

Defined in:

Temp-Table eTable

Defined in:

Temp-Table eTableProperties

Defined in:


©2006-2025 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       24.10.2025 08:26:17