Package org.opencms.jsp.search.state

Interface I_CmsSearchStateFacet

All Known Implementing Classes:
CmsSearchStateFacet
public interface I_CmsSearchStateFacet
Interface for the state all facet types have in common.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addChecked(String entry)
    Add a facet entry to the collection of checked entries.
    void
    clearChecked()
    Clear the collection of checked entries - i.e., tell that nothing is checked.
    List<String>
    getCheckedEntries()
    Returns all checked entries of a facet.
    boolean
    getIgnoreChecked()
    Returns a flag, indicating if the checked entries should be ignored.
    Map<String,Boolean>
    getIsChecked()
    Returns a map that tells for each facet entry (an arbitrary string), if it is checked.
    boolean
    getUseLimit()
    Returns a flag, indicating if the limit for the maximal number of facet entries should be used.
    void
    setIgnoreChecked(boolean ignore)
    Set, if the checked facet entries should be ignored.
    void
    setUseLimit(boolean useLimit)
    Set, if the limit for the maximal number of facet entries should be used.

  • Method Details

    • addChecked

      void addChecked(String entry)
      Add a facet entry to the collection of checked entries.
      Parameters:
      entry - The facet entry.

    • clearChecked

      void clearChecked()
      Clear the collection of checked entries - i.e., tell that nothing is checked.

    • getCheckedEntries

      List<String> getCheckedEntries()
      Returns all checked entries of a facet.
      Returns:
      List of the facet's entries that are checked.

    • getIgnoreChecked

      boolean getIgnoreChecked()
      Returns a flag, indicating if the checked entries should be ignored.
      Returns:
      Flag, indicating if the checked entries should be ignored.

    • getIsChecked

      Map<String,Boolean> getIsChecked()
      Returns a map that tells for each facet entry (an arbitrary string), if it is checked.
      Returns:
      Map from facet entries to their check state.

    • getUseLimit

      boolean getUseLimit()
      Returns a flag, indicating if the limit for the maximal number of facet entries should be used.
      Returns:
      A flag, indicating if the limit for the maximal number of facet entries should be used.

    • setIgnoreChecked

      void setIgnoreChecked(boolean ignore)
      Set, if the checked facet entries should be ignored. (This influences the generated query part, by (not) adding specific filter queries.)
      Parameters:
      ignore - Flag, indicating if the checked entries should be ignored or not.

    • setUseLimit

      void setUseLimit(boolean useLimit)
      Set, if the limit for the maximal number of facet entries should be used.
      Parameters:
      useLimit - Flag, indicating if the configured limit for the maximal number of facet entries should be used.