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

Inherits: Progress.Lang.Object

File:OpenAccessSdkGenerator
Purpose:Generator for OpenAccess SDK interface procedures and
JSON catalog file
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Mon Nov 03 23:21:28 CET 2014
Purpose: Generates the OpenAccess SDK interface procedure and JSON catalog file
Notes:

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



Top Method Summary
Options Name Purpose
+ Generate (character, character, character, character, character, character, character, integer, integer, logical, handle, character) Generates the OpenAccess SDK interface procedure and JSON catalog file
# CHARACTER GenerateCatalogFile (character, character, character, character, character, handle) Generates the JSON Catalog file for the DataDirect OpenAccess SDK
# CHARACTER GenerateInterfaceProcedure (character, character, character, character, character, character, integer, integer, logical, character) Generates the Interface Procedure


Method Detail
Top

PUBLIC Generate (character, character, character, character, character, character, character, integer, integer, logical, handle, character)
Purpose: Generates the OpenAccess SDK interface procedure and JSON catalog file
Notes:

Parameters:
pcBusinessEntityName CHARACTER
The name of the Business Entity
pcEntityTable CHARACTER
The primary table
pcEntityView CHARACTER
The list of secondary tables
pcInterfaceName CHARACTER
The name of the service interface to generate
pcRootFolder CHARACTER
The root folder of the AppServer code base
pcRelativeFolder CHARACTER
The name of the relative folder that will contain the service interface procedure
pcCatalogFolder CHARACTER
The name of the folder to generate the catalog into
piNumRecords INTEGER
The batch size to retrieve from the Business Entity
piStopAfter INTEGER
The stop-after value
plOuterJoin LOGICAL
Use outer-join when joining the Business Entity Tables
phDataset HANDLE
The handle of the ProDataset of the Business Entity
pcDatasetIncludeFile CHARACTER
The name and path of the ProDataset include file
Top

PROTECTED CHARACTER GenerateCatalogFile (character, character, character, character, character, handle)
Purpose: Generates the JSON Catalog file for the DataDirect OpenAccess SDK
Notes:

Parameters:
pcInterfaceName CHARACTER
The name of the service interface to generate
pcRelativeFolder CHARACTER
The name of the relative folder that will contain the service interface procedure
pcCatalogFolder CHARACTER
The name of the folder to generate the catalog into
pcEntityTable CHARACTER
The primary table
pcEntityView CHARACTER
The list of secondary tables
phDataset HANDLE
The handle of the ProDataset of the Business Entity
Returns CHARACTER
The path of to the generated catalog file
Top

PROTECTED CHARACTER GenerateInterfaceProcedure (character, character, character, character, character, character, integer, integer, logical, character)
Purpose: Generates the Interface Procedure
Notes:

Parameters:
pcBusinessEntityName CHARACTER
The name of the Business Entity
pcEntityTable CHARACTER
The primary table
pcEntityView CHARACTER
The list of secondary tables
pcInterfaceName CHARACTER
The name of the service interface to generate
pcRootFolder CHARACTER
The root folder of the AppServer code base
pcRelativeFolder CHARACTER
The name of the relative folder that will contain the service interface procedure
piNumRecords INTEGER
The batch size to retrieve from the Business Entity
piStopAfter INTEGER
The stop-after value
plOuterJoin LOGICAL
Use outer-join when joining the Business Entity Tables
pcDatasetIncludeFile CHARACTER
The name and path of the ProDataset include file
Returns CHARACTER
The path of to the generated interface procedure


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 05:49:21