Namespace: Consultingwerk.SmartFramework.System
Class 
MessageBusinessEntity Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.BusinessEntity
Consultingwerk.SmartFramework.SmartBusinessEntity
Consultingwerk.SmartFramework.System.MessageBusinessEntity

Inherits: Consultingwerk.SmartFramework.SmartBusinessEntity
Implements: Ccs.BusinessLogic.IBusinessEntity, Ccs.BusinessLogic.IUpdatableBusinessEntity, Consultingwerk.OERA.IBusinessEntity, Consultingwerk.OERA.IBusinessService, Consultingwerk.OERA.IFetchDataByReference, Consultingwerk.OERA.IHasContextID, IProvidesBusinessEntityDescriptor, Consultingwerk.OERA.IProvidesDatasetModel, Consultingwerk.OERA.RestResource.ISupportsETagValue, Consultingwerk.OERA.ISupportsResetState, Consultingwerk.OERA.RestResource.ISupportsRestMethods, Consultingwerk.OERA.ISupportsStaticQueryRequests


Consultingwerk.SmartFramework.System.MessageBusinessEntity
Consultingwerk.SmartFramework.System.MessageBusinessEntity

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



Top Method Summary
Options Name Purpose
ClearMessageCache () Empties the message cache shared by all instances of the MessageBusinessEntity in the session
Progress.Json.ObjectModel.JsonObject CreateMessage (CreateMessageParameter) Returns the list of currently used MessageGroups
F FetchData (IFetchDataRequest, dataset) Fetch data from the Data Access object
FetchDataByKeyTable (dataset, IFetchDataByKeyTableParameter) Supports to retrieve multiple DB records from a Business Entity based on a temp-table with key values
F FetchDataByReference (IFetchDataRequest, dataset) Fetch data from the Data Access object
GetMessage (dataset, GetMessageParameter) Client callable method to retrieve a specific message either in the client's language, the unspecified language or the first language found in the SmartMessage table
GetMessageFromCache (GetMessageParameter) Fetches a message from the cache
Consultingwerk.LongcharHolder GetMessageGroups () Returns the list of currently used MessageGroups
Progress.Json.ObjectModel.JsonArray GetMessageGroups2 () Returns the list of currently used MessageGroups
Consultingwerk.OERA.IFetchDataByStaticQueryRequest GetStaticQueryRequest (character, character, character, character) Returns a strong-typed static query request instance for the given table and field combination
ReceiveData () Provides a hook to modify data in the ProDataset after Read and Update operations (i.e. population of aggregated values)
RefreshMessageCache () Refreshes the Message Cache
ValidateData () Provides a hook for high level data validation before Update operations

Top Constructor Summary
Options Name Purpose
MessageBusinessEntity () Constructor of the MessageBusinessEntity class

Top Property Summary
Options Name Purpose
LOGICAL CacheMessagesAtStartup


Method Detail
Top

ClearMessageCache ()
Purpose: Empties the message cache shared by all instances of the
MessageBusinessEntity in the session
Notes: SCL-5837. The next instance created while CacheMessagesAtStartup
is set loads the cache again

Top

Progress.Json.ObjectModel.JsonObject CreateMessage (CreateMessageParameter)
Purpose: Returns the list of currently used MessageGroups
Notes:

Parameters:
poParameter Consultingwerk.SmartFramework.System.CreateMessageParameter
The CreateMessageParameter with the request data
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the Message group and message number
Top

FetchData (IFetchDataRequest, dataset)
Purpose: Fetch data from the Data Access object
Notes:

Parameters:
poFetchDataRequest Consultingwerk.OERA.IFetchDataRequest
The IFetchDataRequest object with the parameters for this call
dsMessage DATASET dsMessage
Top

FetchDataByKeyTable (dataset, IFetchDataByKeyTableParameter)
Purpose: Supports to retrieve multiple DB records from a Business Entity based on
a temp-table with key values
Notes:

Parameters:
dsMessage DATASET dsMessage
poParameter Consultingwerk.OERA.IFetchDataByKeyTableParameter
The IFetchDataByKeyTableParameter with the data for this call
Top

FetchDataByReference (IFetchDataRequest, dataset)
Purpose: Fetch data from the Data Access object
Notes:

Parameters:
poFetchDataRequest Consultingwerk.OERA.IFetchDataRequest
The IFetchDataRequest object with the parameters for this call
dsMessage DATASET dsMessage
Top

GetMessage (dataset, GetMessageParameter)
Purpose: Client callable method to retrieve a specific message either
in the client's language, the unspecified language or the first
language found in the SmartMessage table
Notes:

Parameters:
dsMessage DATASET dsMessage
INPUT-OUTPUT Dataset with the message
poGetMessageParameter Consultingwerk.SmartFramework.System.GetMessageParameter
The GetMessageParameter with the request data
Top

GetMessageFromCache (GetMessageParameter)
Purpose: Fetches a message from the cache
Notes:

Parameters:
poGetMessageParameter Consultingwerk.SmartFramework.System.GetMessageParameter
The GetMessageParameter with the current request
Top

Consultingwerk.LongcharHolder GetMessageGroups ()
Purpose: Returns the list of currently used MessageGroups
Notes:

Returns Consultingwerk.LongcharHolder
The LongcharHolder with the currently used MessageGroups
Top

Progress.Json.ObjectModel.JsonArray GetMessageGroups2 ()
Purpose: Returns the list of currently used MessageGroups
Notes:

Returns Progress.Json.ObjectModel.JsonArray
The LongcharHolder with the currently used MessageGroups
Top

Consultingwerk.OERA.IFetchDataByStaticQueryRequest GetStaticQueryRequest (character, character, character, character)
Purpose: Returns a strong-typed static query request instance for the
given table and field combination
Notes: Returns the unknown value when no static query covers the
given table / field combination

Parameters:
pcTableName CHARACTER
The name of the (temp-)table the request is for
pcFieldNames CHARACTER
Comma-separated list of temp-table field names
pcFieldValues CHARACTER
CHR(1)-separated list of field values, positionally matching pcFieldNames
pcChildTables CHARACTER
Comma-separated list of child table names to be filled
Returns Consultingwerk.OERA.IFetchDataByStaticQueryRequest
The IFetchDataByStaticQueryRequest instance or the unknown value
Top

ReceiveData ()
Purpose: Provides a hook to modify data in the ProDataset after Read and
Update operations (i.e. population of aggregated values)
Notes: Invoked during FetchData () and SaveChanges ()

Top

RefreshMessageCache ()
Purpose: Refreshes the Message Cache
Notes: SCL-5837: Reloads the message cache shared by all instances of
the MessageBusinessEntity in the session. A refresh requested
while another one is running (nested, e.g. through a message
lookup during the fetch) is skipped - the running refresh fills
the cache, lookups meanwhile fall back to the database

Top

ValidateData ()
Purpose: Provides a hook for high level data validation before Update
operations
Notes: Invoked during SaveChanges (). When the ERROR flag of the ProDataset
is set, the Update operation will be cancelled before writing back
the data to the database using the DataAccess object



Constructor Detail
Top

MessageBusinessEntity ()
Purpose: Constructor of the MessageBusinessEntity class
Notes: Passes the handle of the dataset instance to the base class and
sets the default DataAccessName. Loads the message cache shared
by all instances when CacheMessagesAtStartup is set and the
cache has not been loaded in this session yet



Property Detail
Top

LOGICAL CacheMessagesAtStartup

Returns LOGICAL


ProDataset Detail

ProDataset dsMessage

Member tables: eSmartMessage


Temp-Table Detail

Temp-Table eSmartMessage

Defined in:


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       10.10.2026 15:31:52