Package org.opencms.jsp.search.state

Interface I_CmsSearchStateCommon

All Known Implementing Classes:
CmsSearchStateCommon
public interface I_CmsSearchStateCommon
Class for keeping the state of the common search options.

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,String>
    getAdditionalParameters()
    Getter for the map from the additional request parameters to their values.
    boolean
    getIsReloaded()
    Getter for the flag indicating if the search is called the first time, or reloaded.
    String
    getLastQuery()
    Returns the last query string (as entered by the user).
    String
    getQuery()
    Returns the current query string (as entered by the user).
    void
    setAdditionalParameters(Map<String,String> parameters)
    Setter for the additional parameters and their values.
    void
    setIsReloaded(boolean isReloaded)
    Setter for the flag indicating if the search is called the first time, or reloaded.
    void
    setLastQuery(String lastquery)
    Setter for the last query string (as entered by the user).
    void
    setQuery(String query)
    Setter for the current query string (as entered by the user).

  • Method Details

    • getAdditionalParameters

      Map<String,String> getAdditionalParameters()
      Getter for the map from the additional request parameters to their values.
      Returns:
      The map from the additional request parameters to their values.

    • getIsReloaded

      boolean getIsReloaded()
      Getter for the flag indicating if the search is called the first time, or reloaded.
      Returns:
      Typically, false only if the search form is loaded the first time, otherwise it should be true.

    • getLastQuery

      String getLastQuery()
      Returns the last query string (as entered by the user).
      Returns:
      The last query string (as entered by the user).

    • getQuery

      String getQuery()
      Returns the current query string (as entered by the user).
      Returns:
      The current query string (as entered by the user).

    • setAdditionalParameters

      void setAdditionalParameters(Map<String,String> parameters)
      Setter for the additional parameters and their values.
      Parameters:
      parameters - Map from the additional parameters and their values.

    • setIsReloaded

      void setIsReloaded(boolean isReloaded)
      Setter for the flag indicating if the search is called the first time, or reloaded.
      Parameters:
      isReloaded - Typically false only if the search form is loaded the first time, otherwise it should be true.

    • setLastQuery

      void setLastQuery(String lastquery)
      Setter for the last query string (as entered by the user).
      Parameters:
      lastquery - The last query string (as entered by the user).

    • setQuery

      void setQuery(String query)
      Setter for the current query string (as entered by the user).
      Parameters:
      query - The current query string (as entered by the user).