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

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.ISupportsResetState, Consultingwerk.OERA.RestResource.ISupportsRestMethods


Consultingwerk.SmartFramework.System.TranslationBusinessEntity
Consultingwerk.SmartFramework.System.TranslationBusinessEntity

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



Top Method Summary
Options Name Purpose
CacheAllTranslations (dataset-handle, CacheTranslationParameter) Caches all translations
CacheTranslationsByScope (dataset-handle, CacheTranslationParameter) Caches all translations by a given scope
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
GetTranslationByKey (dataset, GetTranslationByKeyParameter) Returns a translation based on a key value and an optional scope
GetTranslationByString (dataset, GetTranslationByStringParameter) Returns a translation based on an original string and an optional scope
Consultingwerk.LongcharHolder GetTranslationScopes () Returns the list of currently used Translation Scopes @return The LongcharHolder with the currently used Translation Scopes */
Progress.Json.ObjectModel.JsonArray GetTranslationScopesAsJsonArray () Returns the list of currently used Translation Scopes @return The JsonArray with the currently used Translation Scopes */
ReceiveData () Provides a hook to modify data in the ProDataset after Read and Update operations (i.e. population of aggregated values)
ValidateData () Provides a hook for high level data validation before Update operations

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


Method Detail
Top

CacheAllTranslations (dataset-handle, CacheTranslationParameter)
Purpose: Caches all translations
Notes:

Parameters:
hDataset DATASET-HANDLE
INPUT-OUTPUT Dataset with the translation
poParameter Consultingwerk.SmartFramework.System.CacheTranslationParameter
The CacheTranslationParameter value with the request data
Top

CacheTranslationsByScope (dataset-handle, CacheTranslationParameter)
Purpose: Caches all translations by a given scope
Notes:

Parameters:
hDataset DATASET-HANDLE
INPUT-OUTPUT Dataset with the translation
poParameter Consultingwerk.SmartFramework.System.CacheTranslationParameter
The CacheTranslationParameter value with the request data
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
dsTranslation DATASET dsTranslation
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:
dsTranslation DATASET dsTranslation
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
dsTranslation DATASET dsTranslation
Top

GetTranslationByKey (dataset, GetTranslationByKeyParameter)
Purpose: Returns a translation based on a key value and an optional scope
Notes: Returns ? when no translation is available

Parameters:
dsTranslation DATASET dsTranslation
INPUT-OUTPUT Dataset with the translation
poParameter Consultingwerk.SmartFramework.System.GetTranslationByKeyParameter
The GetTranslationByKeyParameter value with the request data
Top

GetTranslationByString (dataset, GetTranslationByStringParameter)
Purpose: Returns a translation based on an original string and an optional scope
Notes: Returns ? when no translation is available

Parameters:
dsTranslation DATASET dsTranslation
INPUT-OUTPUT Dataset with the translation
poParameter Consultingwerk.SmartFramework.System.GetTranslationByStringParameter
The GetTranslationByKeyParameter value with the request data
Top

Consultingwerk.LongcharHolder GetTranslationScopes ()
Purpose: Returns the list of currently used Translation Scopes

Returns Consultingwerk.LongcharHolder
The LongcharHolder with the currently used Translation Scopes
Top

Progress.Json.ObjectModel.JsonArray GetTranslationScopesAsJsonArray ()
Purpose: Returns the list of currently used Translation Scopes

Returns Progress.Json.ObjectModel.JsonArray
The JsonArray with the currently used Translation Scopes
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

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

TranslationBusinessEntity ()
Purpose: Constructor of the TranslationBusinessEntity class
Notes: Passes the handle of the dataset instance to the base class and
sets the default DataAccessName



ProDataset Detail

ProDataset dsTranslation

Member tables: eSmartTranslation


Temp-Table Detail

Temp-Table eSmartTranslation

Defined in:


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       13.04.2026 10:28:51