Bona Iqiniso Application Board

V3BiFreeTextBase

Bona iqiniso is designed to handle multilingual text translations. The system allows for the creation and management of text references and their corresponding translations in various languages. This system facilitates the retrieval of text in a specified language, returning a default message if the language is not available.

Entities

Entity: V3BiFreeTextBase

FieldDescriptionData TypeValidation Rules
referenceThe unique identifier for the free textstringMust be a non-empty string; Must be unique across all instances
translationsA list of translations associated with the referencearray of V3BiTranslationBaseMust contain at least one translation; Each translation must adhere to the V3BiTranslationBase structure

Actions:

ActionDescriptionEffects
Constructor(reference: string, translations: V3BiTranslationBase[])Initializes a new instance with a reference and translationsCreates a new free text base with the given reference and translations. Translations may be an empty array.
getFreeText(language: string) : stringRetrieves the translation text for the specified languageReturns the text in the specified language or ‘unknown language’ if not found