com.communote.server.core.user

Interface MasterDataManagement

All Known Implementing Classes:

MasterDataManagementBase, MasterDataManagementImpl

public interface MasterDataManagement

Management class for master data.

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields

Modifier and Type	Field and Description
static String	MASTERDATA_LANGUAGE_PREFIX The property prefix for the language values.

Method Summary

Modifier and Type	Method and Description
void	addLanguage(String languageCode, String name) Adds a new language or updates an existing language for the given code.
Country	findCountryByCode(String countryCode) Finds a country by the country code.
Language	findLanguageByCode(String languageCode) Finds a language by the language code.
Map<String,String>	getAllLanguages() Returns all languages for the client.
Collection<Language>	getAvailableLanguages() This method returns all available languages.
List<Country>	getCountries(Locale locale) Returns a list of all countries in the database.
List<Language>	getLanguages()
List<SimplifiedTimeZone>	getTimeZones()
Collection<Language>	getUsedLanguages() This method returns all available languages plus the language of the current user.
boolean	isAvailableLanguage(Locale locale) Test whether the language of the locale belongs to the available languages.
void	postInitialization()
void	removeLanguage(String languageCode) Removes the language for the given code.

Field Detail

MASTERDATA_LANGUAGE_PREFIX

static final String MASTERDATA_LANGUAGE_PREFIX

The property prefix for the language values.

See Also:

Constant Field Values

Method Detail

addLanguage

void addLanguage(String languageCode,
                 String name)

Adds a new language or updates an existing language for the given code.

Parameters:

languageCode - The language code as LANGUAGE_COUNTY_VARIANT

name - The name of the language (Should be the foreign name).

findCountryByCode

Country findCountryByCode(String countryCode)

Finds a country by the country code.

findLanguageByCode

Language findLanguageByCode(String languageCode)

Finds a language by the language code.

getAllLanguages

@Transactional(readOnly=true)
Map<String,String> getAllLanguages()

Returns all languages for the client.

Returns:

Map of all language codes with their names.

getAvailableLanguages

@Transactional(readOnly=true)
Collection<Language> getAvailableLanguages()

This method returns all available languages. In contrast to getUsedLanguages() it will not include an inactive language of the current user. Will maintain the languages itself and not use the database.

Returns:

All languages which currently have at least one active localization.

See Also:

getUsedLanguages()

getCountries

List<Country> getCountries(Locale locale)

Returns a list of all countries in the database.

getLanguages

List<Language> getLanguages()

Returns:

All known languages. Includes also languages, there is currently no localization active.

getTimeZones

List<SimplifiedTimeZone> getTimeZones()

Returns:

The available list of time zones.

getUsedLanguages

@Transactional(readOnly=true)
Collection<Language> getUsedLanguages()

This method returns all available languages plus the language of the current user. For only retrieving the available languages use getAvailableLanguages() Will use the database only for getting the language of the current user.

Returns:

All languages which currently have at least one active localization. Includes the current users language, even if there is no localization for it.

See Also:

getAvailableLanguages()

isAvailableLanguage

@Transactional(readOnly=true)
boolean isAvailableLanguage(Locale locale)

Test whether the language of the locale belongs to the available languages.

Parameters:

locale - the locale to test

Returns:

true if the language of the locale is among the available languages

postInitialization

void postInitialization()

removeLanguage

void removeLanguage(String languageCode)

Removes the language for the given code.

Parameters:

languageCode - The code of the language to remove.