ILocalization (formcycle: bom 8.4.0 API)

Type Parameters:

TBase - type of the base entity for which the localization is intended.

Id - Type of the primary key.

All Superinterfaces:

ILocalizedDatabaseObject<String,Id>, IScopedLocalizedDatabaseObject<String,Id>, Serializable

All Known Implementing Classes:

ALocalization, ClientAuthenticatorLocalization, EndUserStateLocalization, ProjectLocalization, ProjectPortalTagLocalization, SystemAuthenticatorLocalization, UserPortalLocalization
```
public interface ILocalization<TBase extends de.xima.cmn.dao.interfaces.IEntity<Long>,Id extends Serializable & Comparable<Id>>
extends IScopedLocalizedDatabaseObject<String,Id>
```
Common interface for entity localizations. Entity localizations persist the localization strings defined by a key for a given language and intended base entity.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ATTR_DATA`
`static String`	`ATTR_ENTITY`
`static String`	`ATTR_KEY`
`static String`	`COL_DATA`
`static String`	`COL_ENTITY_ID`
`static String`	`COL_KEY`

Fields inherited from interface de.xima.fc.entities.interfaces.i18n.ILocalizedDatabaseObject
ATTR_LANGUAGE_TAG, COL_LANGUAGE_TAG

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`TBase`	`getBaseEntity()`	Gets the entity for which this localization is intended.
`void`	`setBaseEntity(TBase baseEntity)`	Sets the entity for which this localization is intended.
`void`	`setData(String data)`	Sets the localized data.
`void`	`setKey(String key)`	Sets the key for this localization.

Methods inherited from interface de.xima.fc.entities.interfaces.i18n.ILocalizedDatabaseObject
getData, getLanguageTag, getLocale, setLanguageTag, setLocale

Methods inherited from interface de.xima.fc.entities.interfaces.i18n.IScopedLocalizedDatabaseObject
getKey

- Field Detail
  - ATTR_ENTITY
```
static final String ATTR_ENTITY
```
    See Also:
    
    Constant Field Values
  - ATTR_KEY
```
static final String ATTR_KEY
```
    See Also:
    
    Constant Field Values
  - ATTR_DATA
```
static final String ATTR_DATA
```
    See Also:
    
    Constant Field Values
  - COL_ENTITY_ID
```
static final String COL_ENTITY_ID
```
    See Also:
    
    Constant Field Values
  - COL_KEY
```
static final String COL_KEY
```
    See Also:
    
    Constant Field Values
  - COL_DATA
```
static final String COL_DATA
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getBaseEntity
```
TBase getBaseEntity()
```
    Gets the entity for which this localization is intended.
    
    Returns:
    
    the base entity
  - setBaseEntity
```
void setBaseEntity(TBase baseEntity)
```
    Sets the entity for which this localization is intended.
    
    Parameters:
    
    baseEntity - the base entity to set
  - setKey
```
void setKey(String key)
```
    Sets the key for this localization. The key is used to identify the localization.
    
    Parameters:
    
    key - the key to set
  - setData
```
void setData(String data)
```
    Sets the localized data.
    
    Parameters:
    
    data - the data to set