Class TranslationServiceImpl

java.lang.Object

org.flowable.common.engine.impl.service.CommonServiceImpl<PlatformEngineConfiguration>

org.flowable.common.engine.impl.service.CommonEngineServiceImpl<PlatformEngineConfiguration>

com.flowable.platform.engine.impl.translation.TranslationServiceImpl

All Implemented Interfaces:

TranslationService

public class TranslationServiceImpl
extends org.flowable.common.engine.impl.service.CommonEngineServiceImpl<PlatformEngineConfiguration>
implements TranslationService

Author:

Filip Hrisafov

Field Summary

Fields inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

commandExecutor

Fields inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

configuration

Constructor Summary

Constructors

Constructor	Description
TranslationServiceImpl(PlatformEngineConfiguration configuration)

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

Methods inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

getCommandExecutor, setCommandExecutor

Methods inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

getConfiguration

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TranslationServiceImpl

public TranslationServiceImpl(PlatformEngineConfiguration configuration)

Method Details

createTranslationQuery

public TranslationQuery createTranslationQuery()

Specified by:

createTranslationQuery in interface TranslationService

save

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

Description copied from interface: TranslationService

Create or update a translation for the given scoped object.

Specified by:

save in interface TranslationService

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

public Translation updateValue(String translationId,
 String value)

Description copied from interface: TranslationService

Update the translation with the given value

Specified by:

updateValue in interface TranslationService

Parameters:

translationId - the id of the translation that should be updated

value - the new value of the translation

Returns:

The updated translation

findByScopeIdAndScopeType

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

Description copied from interface: TranslationService

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

Specified by:

findByScopeIdAndScopeType in interface TranslationService

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

public void deleteByScopeIdAndScopeType(String scopeId,
 String scopeType)

Description copied from interface: TranslationService

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

Specified by:

deleteByScopeIdAndScopeType in interface TranslationService

Parameters:

scopeId - the scope id for which to find translations

scopeType - the scope type for which to find translations

deleteByScopeIdsAndScopeType

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

Description copied from interface: TranslationService

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

Specified by:

deleteByScopeIdsAndScopeType in interface TranslationService

Parameters:

scopeIds - the scope ids for which to delete translations

scopeType - the scope type for which to delete translations

createTranslation

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

Description copied from interface: TranslationService

Create a new translation for the given scoped object. Unlike TranslationService.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.

Specified by:

createTranslation in interface TranslationService

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

public void createTranslations(List<TranslationCreateRequest> requests)

Description copied from interface: TranslationService

Batch-create new translations. Unlike TranslationService.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.

Specified by:

createTranslations in interface TranslationService

Parameters:

requests - the list of translations to create