Namespace: Consultingwerk.OERA.JsdoGenericService
Interface 
ICatalog Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implemented by: Consultingwerk.OERA.JsdoGenericService.CatalogV12, Consultingwerk.OERA.JsdoGenericService.CatalogV14

File:ICatalog
Purpose:Interface for classes that can generate the JSON/JSDO
Catalog file dynamically
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Tue May 19 11:53:54 CEST 2015
Purpose: Returns the Catalog for a given Business Entity
Notes: Defaults to the count method type of the .restapplicationsettings file



Top Method Summary
Options Name Purpose
+ Progress.Json.ObjectModel.JsonObject GetCatalogForBusinessEntity (character, RestServiceAddress) Returns the Catalog for a given Business Entity
+ Progress.Json.ObjectModel.JsonObject GetCatalogForBusinessEntity (character, RestServiceAddress, character) Returns the Catalog for a given Business Entity
+ GetCatalogForBusinessEntity (character, RestServiceAddress, longchar) Returns the Catalog for a given Business Entity
+ Progress.Json.ObjectModel.JsonObject GetCatalogForBusinessTask (IBusinessTaskCatalogData, RestServiceAddress) Returns the Catalog for a given Business Task


Method Detail
Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetCatalogForBusinessEntity (character, RestServiceAddress)

Purpose: Returns the Catalog for a given Business Entity
Notes: Defaults to the count method type of the .restapplicationsettings file

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
poAddress Consultingwerk.OERA.JsdoGenericService.RestServiceAddress
The RestServiceAddress to include in the catalog output
Returns Progress.Json.ObjectModel.JsonObject
The JSON Object describing the Catalog for the Business Entity
Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetCatalogForBusinessEntity (character, RestServiceAddress, character)

Purpose: Returns the Catalog for a given Business Entity
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
poAddress Consultingwerk.OERA.JsdoGenericService.RestServiceAddress
The RestServiceAddress to include in the catalog output
pcCountMethodType CHARACTER
The type (count/invoke) for the count method
Returns Progress.Json.ObjectModel.JsonObject
The JSON Object describing the Catalog for the Business Entity
Top

PUBLIC GetCatalogForBusinessEntity (character, RestServiceAddress, longchar)

Purpose: Returns the Catalog for a given Business Entity
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
poAddress Consultingwerk.OERA.JsdoGenericService.RestServiceAddress
The RestServiceAddress to include in the catalog output
pcJsonCatalog LONGCHAR
OUTPUT The JSON Catalog for the Business Entity
Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetCatalogForBusinessTask (IBusinessTaskCatalogData, RestServiceAddress)

Purpose: Returns the Catalog for a given Business Task
Notes:

Parameters:
poBusinessTask Consultingwerk.OERA.IBusinessTaskCatalogData
The name of the Business Task
poAddress Consultingwerk.OERA.JsdoGenericService.RestServiceAddress
The RestServiceAddress to include in the catalog output
Returns Progress.Json.ObjectModel.JsonObject
The JSON Object describing the Catalog for the Business Task


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.12.2024 13:00:10