Package org.gatein.pc.api.info

Interface PreferenceInfo

public interface PreferenceInfo
Describes a Portlet preference.
Since:
2.4
Version:
$Revision: 6818 $
Author:
Julien Viet

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    getDefaultValue()
    Return the default value or null if it cannot be determined (for instance WSRP v1 does not define it).
    org.gatein.common.i18n.LocalizedString
    getDescription()
    Retrieves the localized description of the described preference.
    org.gatein.common.i18n.LocalizedString
    getDisplayName()
    Retrieves the localized display name of the described preference.
    String
    getKey()
    Retrieves the key associated to the described preference.
    Boolean
    isReadOnly()
    Return true if the preference is read-only, false otherwise or null if it cannot be determined.

  • Method Details

    • getKey

      String getKey()
      Retrieves the key associated to the described preference.
      Returns:
      the key associated to the described preference.

    • getDisplayName

      org.gatein.common.i18n.LocalizedString getDisplayName()
      Retrieves the localized display name of the described preference.
      Returns:
      the localized display name of the described preference.
      See Also:
      • LocalizedString

    • getDescription

      org.gatein.common.i18n.LocalizedString getDescription()
      Retrieves the localized description of the described preference.
      Returns:
      the localized description of the described preference.
      See Also:
      • LocalizedString

    • isReadOnly

      Boolean isReadOnly()
      Return true if the preference is read-only, false otherwise or null if it cannot be determined.
      Returns:
      true if the described preference is read-only, false otherwise.

    • getDefaultValue

      List<String> getDefaultValue()
      Return the default value or null if it cannot be determined (for instance WSRP v1 does not define it).
      Returns:
      the default value