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

Inherits: Progress.Lang.Object
Implements: Consultingwerk.OERA.IBusinessEntityDescriptionProvider


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



Top Method Summary
Options Name Purpose
AddTableDescription (character, character, character, character) Stores the description attributes of a table
DetermineFallbackDescription (handle) Determines the fallback description of the table of the given buffer and stores it for the table
Consultingwerk.OERA.IBusinessEntityDescriptionProvider FromEntity (IBusinessEntity) Returns the IBusinessEntityDescriptionProvider for a Business Entity
Consultingwerk.OERA.IBusinessEntityDescriptionProvider FromEntityName (character) Returns the IBusinessEntityDescriptionProvider for an entity name
CHARACTER GetRecordDescription (handle) Returns the description of the record in the given buffer
CHARACTER GetRecordDescription (IBufferHandle) Returns the description of the record in the buffer of the given IBufferHandle instance (e.g. a TableModel)
InitializeFromDescriptor () Resolves the Business Entity Descriptor of the entity and registers the description attributes of its table descriptors
LOGICAL IsExcludedFromFallback (handle) Returns if a buffer field is excluded from the fallback description
RegisterTableDescriptor (IBusinessEntityTableDescriptor) Registers the description attributes of a table descriptor

Top Constructor Summary
Options Name Purpose
BusinessEntityDescriptionProvider (character) Constructor for the BusinessEntityDescriptionProvider class

Top Property Summary
Options Name Purpose
CHARACTER EntityName


Method Detail
Top

AddTableDescription (character, character, character, character)
Purpose: Stores the description attributes of a table
Notes: Replaces an existing entry for the table

Parameters:
pcTableName CHARACTER
The name of the table
pcDescriptionFields CHARACTER
The comma delimited list of the description fields
pcDescriptionSubstitute CHARACTER
The substitute pattern
pcDescriptionFormats CHARACTER
The tilde delimited list of the formats, optional
Top

DetermineFallbackDescription (handle)
Purpose: Determines the fallback description of the table of the given
buffer and stores it for the table
Notes: Uses the first five fields of the buffer that are not excluded
(see IsExcludedFromFallback) with the pattern "&1 / &2 / ..."
and no formats. A buffer without any eligible field gets an
empty description

Parameters:
phBufferHandle HANDLE
The handle of the buffer
Top

Consultingwerk.OERA.IBusinessEntityDescriptionProvider FromEntity (IBusinessEntity)
Purpose: Returns the IBusinessEntityDescriptionProvider for a Business Entity
Notes: Returns the keyed service registered for the class name of
the Business Entity, or registers a new
BusinessEntityDescriptionProvider instance under that key

Parameters:
poBusinessEntity Consultingwerk.OERA.IBusinessEntity
The reference to the Business Entity
Returns Consultingwerk.OERA.IBusinessEntityDescriptionProvider
The IBusinessEntityDescriptionProvider instance for the Business Entity
Top

Consultingwerk.OERA.IBusinessEntityDescriptionProvider FromEntityName (character)
Purpose: Returns the IBusinessEntityDescriptionProvider for an entity name
Notes: Returns the keyed service registered for the entity name, or
registers a new BusinessEntityDescriptionProvider instance
under that key. The instance is never registered as the
default (unkeyed) service of the service type

Parameters:
pcEntityName CHARACTER
The name of the entity (typically the class name of the Business Entity)
Returns Consultingwerk.OERA.IBusinessEntityDescriptionProvider
The IBusinessEntityDescriptionProvider instance for the entity
Top

CHARACTER GetRecordDescription (handle)
Purpose: Returns the description of the record in the given buffer
Notes: Returns the unknown value when the buffer has no record
available. When the table of the buffer has no description
attributes in the Business Entity Descriptor, the fallback
description is determined on the first call for the table

Parameters:
phBufferHandle HANDLE
The handle of the buffer positioned on the record to describe
Returns CHARACTER
The record description
Top

CHARACTER GetRecordDescription (IBufferHandle)
Purpose: Returns the description of the record in the buffer of the
given IBufferHandle instance (e.g. a TableModel)
Notes: Returns the unknown value when the buffer has no record
available

Parameters:
poBufferHandle Consultingwerk.OERA.IBufferHandle
The IBufferHandle instance providing the buffer positioned on the record to describe
Returns CHARACTER
The record description
Top

InitializeFromDescriptor ()
Purpose: Resolves the Business Entity Descriptor of the entity and
registers the description attributes of its table descriptors
Notes: An entity without Business Entity Descriptor is not an error,
the provider then works in fallback mode for every table

Top

LOGICAL IsExcludedFromFallback (handle)
Purpose: Returns if a buffer field is excluded from the fallback description
Notes: Excluded are GUID fields (field name ending with "Guid", the
SmartDB key field convention), CLOB, BLOB and RAW fields and
array fields, as they cannot produce a readable description

Parameters:
phField HANDLE
The handle of the buffer field
Returns LOGICAL
Logical value indicating if the field is excluded from the fallback description
Top

RegisterTableDescriptor (IBusinessEntityTableDescriptor)
Purpose: Registers the description attributes of a table descriptor
Notes: A table descriptor has to provide both the DescriptionFields
and the DescriptionSubstitute. A table descriptor providing
only one of them is ignored (fallback for that table) and a
warning is logged

Parameters:
poTableDescriptor Consultingwerk.OERA.BusinessEntityDescriptor.IBusinessEntityTableDescriptor
The table descriptor


Constructor Detail
Top

BusinessEntityDescriptionProvider (character)
Purpose: Constructor for the BusinessEntityDescriptionProvider class
Notes: Resolves the Business Entity Descriptor of the entity and
keeps the description attributes of its table descriptors

Parameters:
pcEntityName CHARACTER
The name of the entity (typically the class name of the Business Entity)


Property Detail
Top

CHARACTER EntityName

Returns CHARACTER


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