Package org.opencms.jsp.search.config

Interface I_CmsSearchConfigurationDidYouMean

All Known Implementing Classes:
CmsSearchConfigurationDidYouMean
public interface I_CmsSearchConfigurationDidYouMean
Interface of the "Did you mean ...?" configuration for the JSP search form.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getCollate()
    Returns a flag, indicating if collation is turned on or off.
    int
    getCount()
    Returns the maximal number of suggestions.
    boolean
    getEscapeQueryChars()
    Returns a flag, indicating if special query characters (e.g., ":", "(", "[" ...) should be escaped in the query string.
    String
    getQueryParam()
    Returns the parameter name of the request parameter used to send the current query string for spellchecking.

  • Method Details

    • getCollate

      boolean getCollate()
      Returns a flag, indicating if collation is turned on or off.
      Returns:
      A flag, indicating if collation is turned on or off.

    • getCount

      int getCount()
      Returns the maximal number of suggestions.
      Returns:
      The maximal number of suggestions.

    • getEscapeQueryChars

      boolean getEscapeQueryChars()
      Returns a flag, indicating if special query characters (e.g., ":", "(", "[" ...) should be escaped in the query string.
      Returns:
      A flag, indicating if special query characters (e.g., ":", "(", "[" ...) should be escaped in the query string.

    • getQueryParam

      String getQueryParam()
      Returns the parameter name of the request parameter used to send the current query string for spellchecking.
      Returns:
      The request parameter name used to send the current query string for spellchecking.