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​(java.lang.String scopeId, java.lang.String scopeType)
    Delete translation values for the given scope id and scope type.
    java.util.List<Translation> findByScopeIdAndScopeType​(java.lang.String scopeId, java.lang.String scopeType)
    Find all translations for the given scope id and scope type.
    Translation save​(java.lang.String scopeId, java.lang.String scopeType, java.lang.String key, java.lang.String locale, java.lang.String value)
    Create or update a translation for the given scoped object.
    Translation updateValue​(java.lang.String translationId, java.lang.String value)
    Update the translation with the given value

  • Method Details

    • createTranslationQuery

      TranslationQuery createTranslationQuery()

    • save

      Translation save​(java.lang.String scopeId, java.lang.String scopeType, java.lang.String key, java.lang.String locale, java.lang.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​(java.lang.String translationId, java.lang.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

      java.util.List<Translation> findByScopeIdAndScopeType​(java.lang.String scopeId, java.lang.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​(java.lang.String scopeId, java.lang.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