org.cyclos.services.contentmanagement

Interface TranslationMessageService

All Superinterfaces:

Service

public interface TranslationMessageService
extends Service

Service interface for translation messages

Author:

luis

Method Summary

Modifier and Type	Method and Description
ApplicationTranslationData	getApplicationTranslationData(LanguageVO language) Gets data for translations for the given language
java.util.Properties	getCustomizedKeysPerLanguage(LanguageVO language) Returns all customized keys for the given language, in form of a Properties object
TranslationKeyData	getTranslationKeyData(BasicTranslationKeyDTO key) Returns data for the given translation key
java.util.List<LanguageDetailedVO>	listTranslatableLanguages() List the languages the current user can translate
void	restoreOriginalTranslation(BasicTranslationKeyDTO key) Reverts any changes on the given key
void	saveKey(TranslationKeyDTO key) Save a customized key
Page<TranslationKeyVO>	searchKeys(TranslationQuery params) Searches for translation keys
void	setCustomizedKeysPerLanguage(SetCustomizedTranslationsDTO params) Set the customized keys for a language

Method Detail

getApplicationTranslationData

ApplicationTranslationData getApplicationTranslationData(@NotNull
                                                         LanguageVO language)
                                                  throws FrameworkException

Gets data for translations for the given language

Throws:

FrameworkException

getCustomizedKeysPerLanguage

java.util.Properties getCustomizedKeysPerLanguage(@NotNull
                                                  LanguageVO language)
                                           throws FrameworkException

Returns all customized keys for the given language, in form of a Properties object

Throws:

FrameworkException

getTranslationKeyData

TranslationKeyData getTranslationKeyData(@NotNull
                                         BasicTranslationKeyDTO key)
                                  throws FrameworkException

Returns data for the given translation key

Throws:

FrameworkException

listTranslatableLanguages

java.util.List<LanguageDetailedVO> listTranslatableLanguages()
                                                      throws FrameworkException

List the languages the current user can translate

Throws:

FrameworkException

restoreOriginalTranslation

void restoreOriginalTranslation(@NotNull
                                BasicTranslationKeyDTO key)
                         throws FrameworkException

Reverts any changes on the given key

Throws:

FrameworkException

saveKey

void saveKey(@NotNull
             TranslationKeyDTO key)
      throws FrameworkException

Save a customized key

Throws:

FrameworkException

searchKeys

Page<TranslationKeyVO> searchKeys(@NotNull
                                  TranslationQuery params)
                           throws FrameworkException,
                                  QueryParseException

Searches for translation keys

Throws:

FrameworkException

QueryParseException

setCustomizedKeysPerLanguage

void setCustomizedKeysPerLanguage(@NotNull
                                  SetCustomizedTranslationsDTO params)
                           throws FrameworkException

Set the customized keys for a language

Throws:

FrameworkException