Package org.somda.sdc.glue.provider.localization

Interface LocalizationService

All Superinterfaces:

com.google.common.util.concurrent.Service

All Known Implementing Classes:

LocalizationServiceImpl

public interface LocalizationService
extends com.google.common.util.concurrent.Service

Localization service provider side.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Method Summary

Modifier and Type	Method	Description
List<LocalizedText>	getLocalizedText(List<String> ref, BigInteger version, List<String> lang, List<LocalizedTextWidth> textWidth, List<BigInteger> numberOfLines)	Gets a localized text that is referenced in the MDIB.
List<String>	getSupportedLanguages()	Gets a list of all supported languages.

Methods inherited from interface com.google.common.util.concurrent.Service

addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, failureCause, isRunning, startAsync, state, stopAsync

Method Details

getLocalizedText

List<LocalizedText> getLocalizedText(List<String> ref,
 @Nullable
 BigInteger version,
 List<String> lang,
 List<LocalizedTextWidth> textWidth,
 List<BigInteger> numberOfLines)

Gets a localized text that is referenced in the MDIB.

Parameters:

ref - a zero or more reference names of the texts that are requested.

version - of the referenced text that is requested. The latest version is used if parameter is null.

lang - a zero or more language identifiers to get different translations of the requested text.

textWidth - a zero or more LocalizedTextWidth identifiers to filter for different text widths.

numberOfLines - a zero or more BigInteger to filter for number of lines.

Returns:

a list of LocalizedText texts that matches search criteria.

getSupportedLanguages

List<String> getSupportedLanguages()

Gets a list of all supported languages.

Returns:

a list of supported language identifiers.