Namespace: Consultingwerk.OERA.JsdoGenericService
Class 
CatalogV12 Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.JsdoGenericService.CatalogV12

Inherits: Progress.Lang.Object
Implements: Consultingwerk.OERA.JsdoGenericService.ICatalog
Inherited by: Consultingwerk.OERA.JsdoGenericService.CatalogV14

File:CatalogV12
Purpose:Generic JSON/JSDO Catalog generation, V1.2 (OpenEdge 11.5)
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Tue May 19 11:51:31 CEST 2015
Notes:Supports extensions for Kendo UI dialect of the JSDO

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



Top Method Summary
Options Name Purpose
# Consultingwerk.OERA.BusinessEntityDescriptor.IBusinessEntityDescriptor GetBusinessEntityDescriptor (character) Retrieves the Business Entity Descriptor of the Business Entity
+ 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
+ Progress.Json.ObjectModel.JsonObject GetDatasetSchema (handle) Returns the JSON Schema description for the ProDataset
+ Progress.Json.ObjectModel.JsonObject GetOperation (character, logical, character, character) Returns an Operation with the given parameters
+ Progress.Json.ObjectModel.JsonObject GetOperation (character, logical, character, character, character) Returns an Operation with the given parameters
+ Progress.Json.ObjectModel.JsonObject GetOperation (character, logical, character, character, character, character[], character[]) Returns an Operation with the given parameters
+ Progress.Json.ObjectModel.JsonObject GetOperation (character, logical, character, character, character[], character[]) Returns an Operation with the given parameters
+ Progress.Json.ObjectModel.JsonArray GetOperations (character, character) Returns the Array of REST Operations for the given Dataset Name
+ Progress.Json.ObjectModel.JsonArray GetOperations (IBusinessTaskCatalogData) Returns the Array of REST Operations for the given Dataset Name
+ Progress.Json.ObjectModel.JsonArray GetRelations (handle) Returns the JSON Schema description of the Relations for the ProDataset
# Progress.Json.ObjectModel.JsonObject GetResource (character, handle) Returns a Resource instance
# Progress.Json.ObjectModel.JsonObject GetResource (IBusinessTaskCatalogData, HandleList) Returns a Resource instance
+ Progress.Json.ObjectModel.JsonObject GetSchema (handle) Returns the JSON Schema description for the ProDataset
# Progress.Json.ObjectModel.JsonObject GetService (character, RestServiceAddress, handle) Returns a Service instance
# Progress.Json.ObjectModel.JsonObject GetService (IBusinessTaskCatalogData, RestServiceAddress, HandleList) Returns a Service instance
# Progress.Json.ObjectModel.JsonObject GetSmartRestrictions (character) Returns the JSON Object with the information about the restrictions

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

Top Property Summary
Options Name Purpose
+ CHARACTER CatalogVersion
# CHARACTER EntityName


Method Detail
Top

PROTECTED Consultingwerk.OERA.BusinessEntityDescriptor.IBusinessEntityDescriptor GetBusinessEntityDescriptor (character)
Purpose: Retrieves the Business Entity Descriptor of the Business Entity
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
Returns Consultingwerk.OERA.BusinessEntityDescriptor.IBusinessEntityDescriptor
The IBusinessEntityDescriptor instance
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
Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetDatasetSchema (handle)
Purpose: Returns the JSON Schema description for the ProDataset
Notes: Does not include the schema envelope

Parameters:
phDataset HANDLE
The ProDataset to return the schema for
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject representing the schema
Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetOperation (character, logical, character, character)
Purpose: Returns an Operation with the given parameters
Notes:

Parameters:
pcPath CHARACTER
The path of the operation
plUseBeforeImage LOGICAL
Logical value indicating the use of before image
pcType CHARACTER
The type of the operation
pcVerb CHARACTER
The http verb of the operation
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject representing an operation
Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetOperation (character, logical, character, character, character)
Purpose: Returns an Operation with the given parameters
Notes:

Parameters:
pcPath CHARACTER
The path of the operation
plUseBeforeImage LOGICAL
Logical value indicating the use of before image
pcType CHARACTER
The type of the operation
pcVerb CHARACTER
The http verb of the operation
pcName CHARACTER
The name of the operation
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject representing an operation
Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetOperation (character, logical, character, character, character, character[], character[])
Purpose: Returns an Operation with the given parameters
Notes:

Parameters:
pcPath CHARACTER
The path of the operation
plUseBeforeImage LOGICAL
Logical value indicating the use of before image
pcType CHARACTER
The type of the operation
pcVerb CHARACTER
The http verb of the operation
pcName CHARACTER
The method name
pcParameterNames CHARACTER
The names of the operation parameters
pcParameterTypes CHARACTER
The types of the operation parameters
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject representing an operation
Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetOperation (character, logical, character, character, character[], character[])
Purpose: Returns an Operation with the given parameters
Notes:

Parameters:
pcPath CHARACTER
The path of the operation
plUseBeforeImage LOGICAL
Logical value indicating the use of before image
pcType CHARACTER
The type of the operation
pcVerb CHARACTER
The http verb of the operation
pcParameterNames CHARACTER
The names of the operation parameters
pcParameterTypes CHARACTER
The types of the operation parameters
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject representing an operation
Top

PUBLIC Progress.Json.ObjectModel.JsonArray GetOperations (character, character)
Purpose: Returns the Array of REST Operations for the given Dataset Name
Notes:

Parameters:
pcEntityName CHARACTER
The name of the business entity
pcDatasetName CHARACTER
The name of the ProDataset parameter
Returns Progress.Json.ObjectModel.JsonArray
The JsonArray representing the operations
Top

PUBLIC Progress.Json.ObjectModel.JsonArray GetOperations (IBusinessTaskCatalogData)
Purpose: Returns the Array of REST Operations for the given Dataset Name
Notes:

Parameters:
poBusinessTask Consultingwerk.OERA.IBusinessTaskCatalogData
The IBusinessTaskCatalogData instance that describes the operations
Returns Progress.Json.ObjectModel.JsonArray
The JsonArray representing the operations
Top

PUBLIC Progress.Json.ObjectModel.JsonArray GetRelations (handle)
Purpose: Returns the JSON Schema description of the Relations for the ProDataset
Notes:

Parameters:
phDataset HANDLE
The ProDataset to return the schema for
Returns Progress.Json.ObjectModel.JsonArray
The JsonObject representing the relations
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetResource (character, handle)
Purpose: Returns a Resource instance
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
phDataset HANDLE
The dataset to return
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject representing the resources
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetResource (IBusinessTaskCatalogData, HandleList)
Purpose: Returns a Resource instance
Notes:

Parameters:
poBusinessTask Consultingwerk.OERA.IBusinessTaskCatalogData
The reference to the IBusinessTaskCatalogData
poDatasets Consultingwerk.Framework.Collections.HandleList
The datasets to add to the catalog
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject representing the service
Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetSchema (handle)
Purpose: Returns the JSON Schema description for the ProDataset
Notes:

Parameters:
phDataset HANDLE
The ProDataset to return the schema for
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject representing the schema
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetService (character, RestServiceAddress, handle)
Purpose: Returns a Service instance
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
poAddress Consultingwerk.OERA.JsdoGenericService.RestServiceAddress
The RestServiceAddress to include in the catalog output
phDataset HANDLE
The dataset to return
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject representing the service
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetService (IBusinessTaskCatalogData, RestServiceAddress, HandleList)
Purpose: Returns a Service instance
Notes:

Parameters:
poBusinessTask Consultingwerk.OERA.IBusinessTaskCatalogData
The reference to the IBusinessTaskCatalogData
poAddress Consultingwerk.OERA.JsdoGenericService.RestServiceAddress
The RestServiceAddress to include in the catalog output
poDatasets Consultingwerk.Framework.Collections.HandleList
The datasets to add to the catalog
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject representing the service
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetSmartRestrictions (character)
Purpose: Returns the JSON Object with the information about the restrictions
Notes:

Parameters:
pcEntityName CHARACTER
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject representing the Business Entities restrictions


Constructor Detail
Top

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



Property Detail
Top

PUBLIC CHARACTER CatalogVersion

Returns CHARACTER
Top

PROTECTED CHARACTER EntityName

Returns CHARACTER


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       09.11.2024 18:38:18