Package org.opencms.jsp.util

Interface I_CmsInfoWrapper

All Known Subinterfaces:
I_CmsFormatterInfo
All Known Implementing Classes:
CmsFormatterInfoWrapper, CmsResourceTypeInfoWrapper, CmsSchemaInfo.Field, CmsSchemaInfo.Tab, CmsSettingDefinitionWrapper
public interface I_CmsInfoWrapper
Contains common methods for various beans used to generate the template documentation.

  • Method Details

    • getDescription

      String getDescription()
      Gets the description in the current locale.
      Returns:
      the description

    • getDescription

      String getDescription(Locale locale)
      Gets the description in the given locale.
      Parameters:
      locale - the locale to use
      Returns:
      the description

    • getDescription

      default String getDescription(String locale)
      Gets the description in the given locale.
      Parameters:
      locale - the locale to use
      Returns:
      the description

    • getDescriptionKey

      String getDescriptionKey()
      Returns the localization key for the description if one was used, and null otherwise.
      Returns:
      the localization key

    • getDescriptionRaw

      String getDescriptionRaw()
      Gets the raw description, without resolving any macros.
      Returns:
      the raw description