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

Inherits: Progress.Lang.Object


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



Top Method Summary
Options Name Purpose
AddMessage (character, character) Appends a validation message to the list of messages
Progress.Json.ObjectModel.JsonObject BusinessEntityDescriptorFromAnnotations (JsonArray) Returns the Business Entity Descriptor for the given @BusinessEntityView annotations
CHARACTER BusinessEntityDescriptorToAnnotations (JsonObject) Returns the @BusinessEntityView annotation statements for the given Business Entity Descriptor
LOGICAL DescriptorsAreEqual (JsonObject, JsonObject, logical) Returns if two descriptors are equal
CHARACTER DescriptorToCharacter (JsonObject) Returns the JSON value of a descriptor for storing it in a design property
CHARACTER GetCharacterValue (JsonObject, character) Returns the character value of the given property of a canonical descriptor
LOGICAL IsFieldOfTable (character, character, character) Returns if the given field reference names a field of the temp-table
Progress.Json.ObjectModel.JsonObject NormalizeAttributes (JsonObject, character, character) Returns the canonical form of a set of annotation attributes
Progress.Json.ObjectModel.JsonObject NormalizeBusinessEntityDescriptor (JsonObject) Returns the canonical form of a Business Entity Descriptor
Progress.Json.ObjectModel.JsonObject NormalizeTableDescriptor (JsonObject) Returns the canonical form of a Table Descriptor
Progress.Json.ObjectModel.JsonObject NormalizeView (JsonObject) Returns the canonical form of a view of the Business Entity Descriptor
Progress.Json.ObjectModel.JsonObject ParseDescriptor (character) Parses the JSON value of a descriptor design property
CHARACTER TableDescriptorToAnnotation (character, JsonObject) Returns the @BusinessEntityTable annotation statement for the given Table Descriptor
CHARACTER ValidateBusinessEntityDescriptor (JsonObject, character, character) Validates a Business Entity Descriptor against the temp-tables and fields of the design
CHARACTER ValidateTableDescriptor (character, JsonObject, character) Validates a Table Descriptor against the fields of its temp-table

Top Property Summary
Options Name Purpose
CHARACTER BusinessEntityDescriptorProperty
CHARACTER DefaultFilterOperators
INTEGER MaxDescriptionFields
CHARACTER TableAnnotation
CHARACTER TableDescriptorAttributes
CHARACTER TableDescriptorColumnListAttributes
CHARACTER TableDescriptorLogicalAttributes
CHARACTER TableDescriptorProperty
CHARACTER ViewAnnotation
CHARACTER ViewAttributes
CHARACTER ViewLogicalAttributes
CHARACTER ViewsProperty


Method Detail
Top

AddMessage (character, character)
Purpose: Appends a validation message to the list of messages
Notes:

Parameters:
pcMessages CHARACTER
INPUT-OUTPUT The messages separated by line breaks
pcMessage CHARACTER
The message to append
Top

Progress.Json.ObjectModel.JsonObject BusinessEntityDescriptorFromAnnotations (JsonArray)
Purpose: Returns the Business Entity Descriptor for the given
@BusinessEntityView annotations
Notes:

Parameters:
poViews Progress.Json.ObjectModel.JsonArray
The JsonArray with the attributes of the @BusinessEntityView annotations
Returns Progress.Json.ObjectModel.JsonObject
The canonical Business Entity Descriptor
Top

CHARACTER BusinessEntityDescriptorToAnnotations (JsonObject)
Purpose: Returns the @BusinessEntityView annotation statements for the
given Business Entity Descriptor
Notes: One statement per view, separated by line breaks. Returns an
empty string when the descriptor has no views

Parameters:
poDescriptor Progress.Json.ObjectModel.JsonObject
The JsonObject with the Business Entity Descriptor
Returns CHARACTER
The annotation statements or an empty string
Top

LOGICAL DescriptorsAreEqual (JsonObject, JsonObject, logical)
Purpose: Returns if two descriptors are equal
Notes: Compares the canonical forms, so that attribute casing and
order do not matter

Parameters:
poDescriptorA Progress.Json.ObjectModel.JsonObject
The first descriptor
poDescriptorB Progress.Json.ObjectModel.JsonObject
The second descriptor
plTableDescriptor LOGICAL
TRUE for Table Descriptors, FALSE for Business Entity Descriptors
Returns LOGICAL
TRUE when both descriptors describe the same annotations
Top

CHARACTER DescriptorToCharacter (JsonObject)
Purpose: Returns the JSON value of a descriptor for storing it in a
design property
Notes:

Parameters:
poDescriptor Progress.Json.ObjectModel.JsonObject
The JsonObject with the descriptor
Returns CHARACTER
The JSON value of the descriptor
Top

CHARACTER GetCharacterValue (JsonObject, character)
Purpose: Returns the character value of the given property of a
canonical descriptor
Notes: Returns an empty string when the property does not exist or
is not a string

Parameters:
poDescriptor Progress.Json.ObjectModel.JsonObject
The canonical descriptor
pcPropertyName CHARACTER
The name of the property
Returns CHARACTER
The character value of the property or an empty string
Top

LOGICAL IsFieldOfTable (character, character, character)
Purpose: Returns if the given field reference names a field of the
temp-table
Notes: The reference may be qualified with the temp-table name

Parameters:
pcFieldReference CHARACTER
The field reference, e.g. CustNum or eCustomer.CustNum
pcTableName CHARACTER
The name of the temp-table
pcFieldNames CHARACTER
The comma-delimited list of the field names of the temp-table
Returns LOGICAL
TRUE when the reference names a field of the temp-table
Top

Progress.Json.ObjectModel.JsonObject NormalizeAttributes (JsonObject, character, character)
Purpose: Returns the canonical form of a set of annotation attributes
Notes: See NormalizeTableDescriptor

Parameters:
poAttributes Progress.Json.ObjectModel.JsonObject
The JsonObject with the attributes
pcAttributes CHARACTER
The comma-delimited list of the canonical attribute names in canonical order
pcLogicalAttributes CHARACTER
The comma-delimited list of the logical attributes
Returns Progress.Json.ObjectModel.JsonObject
The canonical JsonObject
Top

Progress.Json.ObjectModel.JsonObject NormalizeBusinessEntityDescriptor (JsonObject)
Purpose: Returns the canonical form of a Business Entity Descriptor
Notes: The Views array is rebuilt from the normalized views

Parameters:
poDescriptor Progress.Json.ObjectModel.JsonObject
The JsonObject with the descriptor
Returns Progress.Json.ObjectModel.JsonObject
The canonical Business Entity Descriptor
Top

Progress.Json.ObjectModel.JsonObject NormalizeTableDescriptor (JsonObject)
Purpose: Returns the canonical form of a Table Descriptor
Notes: Accepts the attributes of a @BusinessEntityTable annotation as
read from the source as well as a stored descriptor. Attribute
names are matched case-insensitively and written with their
canonical casing in the canonical order, logical attributes
become JSON booleans, empty and unknown attributes (including
the name attribute) are dropped

Parameters:
poAttributes Progress.Json.ObjectModel.JsonObject
The JsonObject with the attributes
Returns Progress.Json.ObjectModel.JsonObject
The canonical Table Descriptor
Top

Progress.Json.ObjectModel.JsonObject NormalizeView (JsonObject)
Purpose: Returns the canonical form of a view of the Business Entity
Descriptor
Notes: See NormalizeTableDescriptor

Parameters:
poAttributes Progress.Json.ObjectModel.JsonObject
The JsonObject with the attributes of the view
Returns Progress.Json.ObjectModel.JsonObject
The canonical view
Top

Progress.Json.ObjectModel.JsonObject ParseDescriptor (character)
Purpose: Parses the JSON value of a descriptor design property
Notes: An empty value yields an empty JsonObject

Parameters:
pcJson CHARACTER
The JSON value of the design property
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the descriptor
Top

CHARACTER TableDescriptorToAnnotation (character, JsonObject)
Purpose: Returns the @BusinessEntityTable annotation statement for the
given Table Descriptor
Notes: Returns an empty string when the descriptor has no attributes -
the annotation is omitted then

Parameters:
pcTableName CHARACTER
The name of the temp-table
poDescriptor Progress.Json.ObjectModel.JsonObject
The JsonObject with the Table Descriptor
Returns CHARACTER
The annotation statement or an empty string
Top

CHARACTER ValidateBusinessEntityDescriptor (JsonObject, character, character)
Purpose: Validates a Business Entity Descriptor against the temp-tables
and fields of the design
Notes: Returns the validation messages separated by line breaks, or
an empty string when the descriptor is valid. Every view needs
a unique name and an existing EntityTable, an EntityView has to
be an existing temp-table, at most one view is the default
view, and the ListColumns and ViewerColumns have to reference
existing fields - qualified with the temp-table name or
unqualified for a field of the EntityTable or EntityView

Parameters:
poDescriptor Progress.Json.ObjectModel.JsonObject
The JsonObject with the Business Entity Descriptor
pcTableNames CHARACTER
The comma-delimited list of the temp-table names of the design
pcQualifiedFieldNames CHARACTER
The comma-delimited list of the field names of the design, qualified with the temp-table name
Returns CHARACTER
The validation messages or an empty string
Top

CHARACTER ValidateTableDescriptor (character, JsonObject, character)
Purpose: Validates a Table Descriptor against the fields of its
temp-table
Notes: Returns the validation messages separated by line breaks, or
an empty string when the descriptor is valid. The column list
attributes and the DefaultFilterOperator entries have to
reference fields of the temp-table, the DefaultSort clause may
only reference fields of the temp-table, and the description
attributes have to be consistent: DescriptionFields and
DescriptionSubstitute are required together, at most 9
description fields, the placeholders &1..&n of the substitute
pattern within the number of description fields and at most
as many DescriptionFormats entries as description fields

Parameters:
pcTableName CHARACTER
The name of the temp-table
poDescriptor Progress.Json.ObjectModel.JsonObject
The JsonObject with the Table Descriptor
pcFieldNames CHARACTER
The comma-delimited list of the field names of the temp-table
Returns CHARACTER
The validation messages or an empty string


Property Detail
Top

CHARACTER BusinessEntityDescriptorProperty

Returns CHARACTER
Top

CHARACTER DefaultFilterOperators

Returns CHARACTER
Top

INTEGER MaxDescriptionFields

Returns INTEGER
Top

CHARACTER TableAnnotation

Returns CHARACTER
Top

CHARACTER TableDescriptorAttributes

Returns CHARACTER
Top

CHARACTER TableDescriptorColumnListAttributes

Returns CHARACTER
Top

CHARACTER TableDescriptorLogicalAttributes

Returns CHARACTER
Top

CHARACTER TableDescriptorProperty

Returns CHARACTER
Top

CHARACTER ViewAnnotation

Returns CHARACTER
Top

CHARACTER ViewAttributes

Returns CHARACTER
Top

CHARACTER ViewLogicalAttributes

Returns CHARACTER
Top

CHARACTER ViewsProperty

Returns CHARACTER


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       19.09.2026 10:05:54