Package se.conciliate.extensions.attribute

Interface RefinementOption

public interface RefinementOption
A refinement option describes a single option value type. A refinement element can have a list of such options, together giving the only valid values for the refinement element.
Author:
Per-Erik

  • Method Summary

    Modifier and Type
    Method
    Description
    Icon
    getIcon()
    Returns the icon for the option, or null if no option is available.
    String
    getLabel(Locale l)
    Returns the label for the option in the given locale (if available in the given locale).
    String
    getValue()
    Returns the value of the option.

  • Method Details

    • getIcon

      Icon getIcon()
      Returns the icon for the option, or null if no option is available.
      Returns:
      the icon for the option, or null if no option is available.

    • getLabel

      String getLabel(Locale l)
      Returns the label for the option in the given locale (if available in the given locale). If no label exists for the given locale, a default label is returned.
      Parameters:
      l - a locale in which to localize the return value.
      Returns:
      the label for the option

    • getValue

      String getValue()
      Returns the value of the option. The value must have a type consistent with the refinement element that this option originates from.
      Returns:
      the value of the option.