Package org.opencms.jsp.search.state

Interface I_CmsSearchStateCommon

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.String,​java.lang.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.
      java.lang.String getLastQuery()
      Returns the last query string (as entered by the user).
      java.lang.String getQuery()
      Returns the current query string (as entered by the user).
      void setAdditionalParameters​(java.util.Map<java.lang.String,​java.lang.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​(java.lang.String lastquery)
      Setter for the last query string (as entered by the user).
      void setQuery​(java.lang.String query)
      Setter for the current query string (as entered by the user).

    • Method Detail

      • getAdditionalParameters

        java.util.Map<java.lang.String,​java.lang.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

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

      • getQuery

        java.lang.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​(java.util.Map<java.lang.String,​java.lang.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​(java.lang.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​(java.lang.String query)
        Setter for the current query string (as entered by the user).
        Parameters:
        query - The current query string (as entered by the user).