Package com.flowable.platform.api.translation

Interface TranslationService

All Known Implementing Classes:

TranslationServiceImpl

public interface TranslationService

Author:

Filip Hrisafov

Method Summary

Modifier and Type	Method	Description
TranslationQuery	createTranslationQuery()
void	deleteByScopeIdAndScopeType(String scopeId, String scopeType)	Delete translation values for the given scope id 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 Detail

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