Interface ILabels

All Superinterfaces:
Cloneable, ICObject, Serializable
All Known Implementing Classes:
Labels

public interface ILabels extends ICObject
The Interface ILabels to manage localized labels.
  • Field Details

  • Method Details

    • getLocales

      List<Locale> getLocales()
      Gets the label locales.
      Returns:
      the locales
    • getLocalizedMapValues

      Map<Locale,String> getLocalizedMapValues()
      Gets the localized map values to have all localized labels
      Returns:
      the localized map of label values
    • getLocalizedMapValues

      Map<Locale,String> getLocalizedMapValues(String defaultValue, Locale fallbackLocale)
      Gets the localized map values to have all localized labels
      Parameters:
      defaultValue - the default value if label is NULL or empty
      fallbackLocale - the fallback locale to use if label is empty or NULL
      Returns:
      the localized map values
    • getLocalizedValue

      String getLocalizedValue(Locale locale)
      Gets the localized value for a locale.
      Parameters:
      locale - the locale
      Returns:
      the localized value
    • getLocalizedValue

      String getLocalizedValue(Locale locale, String defValue)
      Gets the localized value for a locale.
      Parameters:
      locale - the locale
      defValue - the default value if locale is not managed
      Returns:
      the localized value
    • getLocalizedValue

      String getLocalizedValue(Locale locale, String defValue, Locale fallbackLocale)
      Gets the localized value for a locale.
      Parameters:
      locale - the locale
      defValue - the default value if locale is not managed and default locale has not value
      fallbackLocale - the fallback locale if locale is not managed
      Returns:
      the localized value
    • setLocalizedMapValue

      void setLocalizedMapValue(Map<Locale,String> values)
      Sets the localized map values.
      Parameters:
      values - the values
    • setLabel

      void setLabel(Locale locale, String label)
      Sets the label for a locale.
      Parameters:
      locale - the locale
      label - the label
    • getLabelAsString

      String getLabelAsString(Locale locale)
      Gets the label as string representation.
      Parameters:
      locale - the locale
      Returns:
      the label as string
    • hasNoLabelValue

      boolean hasNoLabelValue()
      Checks for no label value.
      Returns:
      true, if one of the label is NULL or empty
    • hasNoLabelValue

      boolean hasNoLabelValue(Locale locale)
      Checks for no label value for a locale.
      Parameters:
      locale - the locale
      Returns:
      true, if label of the locale is NULL or empty
    • removeLabel

      void removeLabel(Locale locale)
      Removes the label for a locale.
      Parameters:
      locale - the locale