Interface TranslationService

All Known Implementing Classes:

TranslationServiceImpl

public interface TranslationService

Author:

Filip Hrisafov

Method Summary

Modifier and Type	Method	Description
Translation	createTranslation(String scopeId, String scopeType, String key, String locale, String value)	Create a new translation for the given scoped object.
TranslationQuery	createTranslationQuery()
void	createTranslations(List<TranslationCreateRequest> requests)	Batch-create new translations.
void	deleteByScopeIdAndScopeType(String scopeId, String scopeType)	Delete translation values for the given scope id and scope type.
void	deleteByScopeIdsAndScopeType(Collection<String> scopeIds, String scopeType)	Delete translation values for the given scope ids and scope type.
List<Translation>	findByScopeIdAndScopeType(String scopeId, String scopeType)	Find all translations for the given scope id and scope type.
Translation	save(String scopeId, String scopeType, String key, String locale, String value)	Create or update a translation for the given scoped object.
Translation	updateValue(String translationId, String value)	Update the translation with the given value

Method Details

createTranslationQuery

TranslationQuery createTranslationQuery()

save

Translation save(String scopeId,
 String scopeType,
 String key,
 String locale,
 String value)

Create or update a translation for the given scoped object.

Parameters:

scopeId - the id of the scoped object for the translation

scopeType - the type of the scoped object for the translation

key - the key of the translation

locale - the locale of the translation

value - the translation value

Returns:

the created or updated translation

updateValue

Translation updateValue(String translationId,
 String value)

Update the translation with the given value

Parameters:

translationId - the id of the translation that should be updated

value - the new value of the translation

Returns:

The updated translation

findByScopeIdAndScopeType

List<Translation> findByScopeIdAndScopeType(String scopeId,
 String scopeType)

Find all translations for the given scope id and scope type.

Parameters:

scopeId - the scope id for which to find translations

scopeType - the scope type for which to find translations

Returns:

the translations for the given scope

deleteByScopeIdAndScopeType

void deleteByScopeIdAndScopeType(String scopeId,
 String scopeType)

Delete translation values for the given scope id and scope type.

Parameters:

scopeId - the scope id for which to find translations

scopeType - the scope type for which to find translations

deleteByScopeIdsAndScopeType

void deleteByScopeIdsAndScopeType(Collection<String> scopeIds,
 String scopeType)

Delete translation values for the given scope ids and scope type.

Parameters:

scopeIds - the scope ids for which to delete translations

scopeType - the scope type for which to delete translations

createTranslation

Translation createTranslation(String scopeId,
 String scopeType,
 String key,
 String locale,
 String value)

Create a new translation for the given scoped object. Unlike save(String, String, String, String, String), this method does not check for existing translations and always creates a new entry. Use this when you know the translation does not exist yet.

Parameters:

scopeId - the id of the scoped object for the translation

scopeType - the type of the scoped object for the translation

key - the key of the translation

locale - the locale of the translation

value - the translation value

Returns:

the created translation

createTranslations

void createTranslations(List<TranslationCreateRequest> requests)

Batch-create new translations. Unlike save(String, String, String, String, String), this method does not check for existing translations and always creates new entries. All translations are processed in a single command for optimal performance.

Parameters:

requests - the list of translations to create