Top Method Summary
Options Name Purpose
+ Progress.Json.ObjectModel.JsonArray GetBusinessEntities (character) Returns the list of Business Entity class names Notes : Business Entities are found by scanning configured filter paths for classes implementing Consultingwerk.OERA.IBusinessEntity @param pcClassNameFilter Optional filter applied using MATCHES substitute("*&1*", pcClassNameFilter) @return JsonArray with the class names */
# CHARACTER GetBusinessEntityDescription (character) Returns the combined description of a Business Entity Notes : The description is built from the @Description annotation (if present) and the SmartBusinessEntityPurpose value @param pcBusinessEntityName The fully qualified Business Entity class name @return The combined description (newline delimited when both sources differ) */
+ Progress.Json.ObjectModel.JsonObject GetBusinessEntityDetails (character) Returns schema details for a Business Entity Notes : The schema is returned based on FetchDataset and contains fields and indexes for each buffer in the dataset @param pcBusinessEntityName The full Business Entity class name @return JsonObject containing the details of the Business Entity */
# Progress.Json.ObjectModel.JsonArray GetBusinessEntityRelationDetails (handle) Builds relation metadata for all relations defined in the Business Entity dataset Notes : The relations are returned based on the dataset relation definitions @param hDataset The dataset handle as returned from BusinessEntity:FetchDataset @return JsonArray containing relation metadata objects */
# Progress.Json.ObjectModel.JsonObject GetBusinessEntityTableDetails (handle, IProvidesDatasetModel) Builds table schema details (fields and indexes) for all buffers in the Business Entity dataset Notes : Optionally enriches the schema with DatasetModel related information (tableModelClass and tableModelReferenceProperty) @param hDataset The dataset handle as returned from BusinessEntity:FetchDataset @param oProvidesDatasetModel Optional interface to provide DatasetModel and TableModel types @return JsonObject keyed by buffer name containing fields and index metadata */
+ Progress.Json.ObjectModel.JsonArray SearchBusinessEntities (character) Searches Business Entities by name or description Notes : Returns Business Entity class names that match the filter either by class name or by description @param pcFilter Filter value applied using MATCHES substitute("*&1*", pcFilter) @return JsonArray with matching Business Entity class names */


Method Detail
Top

PUBLIC Progress.Json.ObjectModel.JsonArray GetBusinessEntities (character)

Purpose: Returns the list of Business Entity class names
Notes : Business Entities are found by scanning configured filter paths for classes implementing Consultingwerk.OERA.IBusinessEntity

Parameters:
pcClassNameFilter CHARACTER
Optional filter applied using MATCHES substitute("*&1*", pcClassNameFilter)
Returns Progress.Json.ObjectModel.JsonArray
JsonArray with the class names
Top

PROTECTED CHARACTER GetBusinessEntityDescription (character)

Purpose: Returns the combined description of a Business Entity
Notes : The description is built from the @Description annotation (if present) and the SmartBusinessEntityPurpose value

Parameters:
pcBusinessEntityName CHARACTER
The fully qualified Business Entity class name
Returns CHARACTER
The combined description (newline delimited when both sources differ)
Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetBusinessEntityDetails (character)

Purpose: Returns schema details for a Business Entity
Notes : The schema is returned based on FetchDataset and contains fields and indexes for each buffer in the dataset

Parameters:
pcBusinessEntityName CHARACTER
The full Business Entity class name
Returns Progress.Json.ObjectModel.JsonObject
JsonObject containing the details of the Business Entity
Top

PROTECTED Progress.Json.ObjectModel.JsonArray GetBusinessEntityRelationDetails (handle)

Purpose: Builds relation metadata for all relations defined in the Business Entity dataset
Notes : The relations are returned based on the dataset relation definitions

Parameters:
hDataset HANDLE
The dataset handle as returned from BusinessEntity:FetchDataset
Returns Progress.Json.ObjectModel.JsonArray
JsonArray containing relation metadata objects
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetBusinessEntityTableDetails (handle, IProvidesDatasetModel)

Purpose: Builds table schema details (fields and indexes) for all buffers in the Business Entity dataset
Notes : Optionally enriches the schema with DatasetModel related information (tableModelClass and tableModelReferenceProperty)

Parameters:
hDataset HANDLE
The dataset handle as returned from BusinessEntity:FetchDataset
oProvidesDatasetModel Consultingwerk.OERA.IProvidesDatasetModel
Optional interface to provide DatasetModel and TableModel types
Returns Progress.Json.ObjectModel.JsonObject
JsonObject keyed by buffer name containing fields and index metadata
Top

PUBLIC Progress.Json.ObjectModel.JsonArray SearchBusinessEntities (character)

Purpose: Searches Business Entities by name or description
Notes : Returns Business Entity class names that match the filter either by class name or by description

Parameters:
pcFilter CHARACTER
Filter value applied using MATCHES substitute("*&1*", pcFilter)
Returns Progress.Json.ObjectModel.JsonArray
JsonArray with matching Business Entity class names


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.02.2026 20:04:14