ILocalizedDatabaseObject (formcycle: bom 8.4.0 API)

Type Parameters:

TData - type of the localized data. This may be a String, a file object or any other type of data.

Id - Type of the primary key.

All Superinterfaces:

Serializable

All Known Subinterfaces:

ILocalization<TBase,Id>, ILocalizedScopedFileMetaEntity<TBase,TData>, IScopedLocalizedDatabaseObject<TData,Id>

All Known Implementing Classes:

ALocalization, ALocalizedScopedFileMetaEntity, ClientAuthenticatorLocalization, EndUserStateLocalization, ProjectFile, ProjectLocalization, ProjectPortalTagLocalization, SystemAuthenticatorLocalization, UserPortalFile, UserPortalLocalization
```
public interface ILocalizedDatabaseObject<TData extends Serializable,Id extends Serializable & Comparable<Id>>
extends Serializable
```
Common interface for localized database objects. The localization of the database object is determined by its language tag.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

Field Summary

Fields
Modifier and Type Field Description

static String ATTR_LANGUAGE_TAG

static String COL_LANGUAGE_TAG

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`TData`	`getData()`	Gets the localized data.
`@NotBlank String`	`getLanguageTag()`	Gets the language this database object is localized for in form of its language tag.
`default @NotNull Locale`	`getLocale()`	Gets the locale for which this entity is localized.
`void`	`setLanguageTag(String languageTag)`	Sets the tag of the language this database object is localized for.
`default void`	`setLocale(@NotNull Locale locale)`	Sets the locale for which this entity is localized.

- Field Detail
  - COL_LANGUAGE_TAG
```
static final String COL_LANGUAGE_TAG
```
    See Also:
    
    Constant Field Values
  - ATTR_LANGUAGE_TAG
```
static final String ATTR_LANGUAGE_TAG
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getLanguageTag
```
@NotBlank
@NotBlank String getLanguageTag()
```
    Gets the language this database object is localized for in form of its language tag.
    
    Returns:
    
    the language tag
  - setLanguageTag
```
void setLanguageTag(String languageTag)
```
    Sets the tag of the language this database object is localized for.
    
    Parameters:
    
    languageTag - the language tag to set
  - getLocale
```
@NotNull
default @NotNull Locale getLocale()
```
    Gets the locale for which this entity is localized.
    
    Returns:
    
    the locale or null if this entity is the default localization.
  - setLocale
```
default void setLocale(@NotNull
                       @NotNull Locale locale)
```
    Sets the locale for which this entity is localized. The locale may be null for setting the default localization.
    
    Parameters:
    
    locale - the locale to set.
  - getData
```
TData getData()
```
    Gets the localized data.
    
    Returns:
    
    the localized data