Interface ContextTranslationData

All Known Implementing Classes:
FeatureKeyContextData

public interface ContextTranslationData
The Interface for common data object that allows to get translations by context key.
  • Method Details

    • setComment

      void setComment(String comment)
      Sets the top object comment.
      Parameters:
      comment - the new comment, can be null.
    • getComment

      String getComment()
      Gets the top data object comment.
      Returns:
      the comment, can return null.
    • removeTranslation

      String removeTranslation(ContextTranslationKey translationKey)
      Removes the translation by the context key.
      Parameters:
      translationKey - the translation key, cannot be null.
      Returns:
      the removed translation or null if data object had now any translation associated with the key.
    • getComment

      String getComment(ContextTranslationKey translationKey)
      Gets the comment of the context key.
      Parameters:
      translationKey - the translation key, cannot be null.
      Returns:
      the comment, can return null.
    • getTranslation

      String getTranslation(ContextTranslationKey translationKey)
      Gets the translation by the context key.
      Parameters:
      translationKey - the translation key, cannot be null.
      Returns:
      the translation, can return null.
    • setTranslation

      String setTranslation(ContextTranslationKey translationKey, String value, String comment)
      Sets the translation and comment for the context key.
      Parameters:
      translationKey - the translation key, cannot be null.
      value - the value, can be null.
      comment - the comment, can be null.
      Returns:
      the previous stored translation, or null if was absent.