Interface I_CmsSearchConfigurationCommon

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.String,​java.lang.String> getAdditionalParameters()
      Returns a map from request parameter names to Solr query parts (where the parameter's values are typically inserted).
      boolean getEscapeQueryChars()
      Returns a flag, indicating if special query characters (e.g., ":", "(", "[" ...) should be escaped in the query string.
      java.lang.String getExtraSolrParams()
      Returns the extra params given to Solr.
      boolean getIgnoreExpirationDate()
      Flag, indicating if also resources that are expired.
      boolean getIgnoreQueryParam()
      Returns a flag, indicating if the query and lastquery params should be ignored when generating the query.
      boolean getIgnoreReleaseDate()
      Flag, indicating if also resources that are not yet released.
      java.lang.String getLastQueryParam()
      Returns the parameter name of the request parameter used to send the last query string.
      int getMaxReturnedResults()
      Returns the number of maximally returned results.
      java.lang.String getModifiedQuery​(java.lang.String queryString)
      Modifies the query string according to the specified query modifier.
      java.lang.String getQueryModifier()
      Returns the modifier for queries.
      java.lang.String getQueryParam()
      Returns the parameter name of the request parameter used to send the current query string.
      java.lang.String getReloadedParam()
      Returns the parameter name of the request parameter used to indicate if the search form is loaded the first time or repeatedly.
      boolean getSearchForEmptyQueryParam()
      Returns a flag, indicating if for an empty search query, search should be performed using a wildcard.
      java.lang.String getSolrCore()
      Returns the Solr core that should be used.
      java.lang.String getSolrIndex()
      Returns the Solr index that should be used.
    • Method Detail

      • getAdditionalParameters

        java.util.Map<java.lang.String,​java.lang.String> getAdditionalParameters()
        Returns a map from request parameter names to Solr query parts (where the parameter's values are typically inserted).
        Returns:
        A map from request parameter names to Solr query parts (where the parameter's values are typically inserted).
      • 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.
      • getExtraSolrParams

        java.lang.String getExtraSolrParams()
        Returns the extra params given to Solr.
        Returns:
        The extra params given to Solr - in format "p1=v1&p2=v2".
      • getIgnoreExpirationDate

        boolean getIgnoreExpirationDate()
        Flag, indicating if also resources that are expired.

        NOTE: if you are not in the edit mode, the flag is ignored and expired resources are never returned.

        Returns:
        Flag, indicating if also resources that are expired should be returned.
      • getIgnoreQueryParam

        boolean getIgnoreQueryParam()
        Returns a flag, indicating if the query and lastquery params should be ignored when generating the query. This is useful, if you have a fixed query in the extra Solr params configured.
        Returns:
        A flag, indicating if the query and lastquery params should be ignored.
      • getIgnoreReleaseDate

        boolean getIgnoreReleaseDate()
        Flag, indicating if also resources that are not yet released.

        NOTE: if you are not in the edit mode, the flag is ignored and unreleased resources are never returned.

        Returns:
        Flag, indicating if also resources that are not yet released should be returned.
      • getLastQueryParam

        java.lang.String getLastQueryParam()
        Returns the parameter name of the request parameter used to send the last query string.
        Returns:
        The request parameter name used to send the last query string.
      • getMaxReturnedResults

        int getMaxReturnedResults()
        Returns the number of maximally returned results. NOTE: If not explicitly specified, this value is read from the (index specific) system wide configuration.
        Returns:
        number of maximally returned results,.
      • getModifiedQuery

        java.lang.String getModifiedQuery​(java.lang.String queryString)
        Modifies the query string according to the specified query modifier.
        Parameters:
        queryString - the query to modify.
        Returns:
        the modified query.
      • getQueryModifier

        java.lang.String getQueryModifier()
        Returns the modifier for queries.
        Returns:
        the query modifier.
      • getQueryParam

        java.lang.String getQueryParam()
        Returns the parameter name of the request parameter used to send the current query string.
        Returns:
        The request parameter name used to send the current query string.
      • getReloadedParam

        java.lang.String getReloadedParam()
        Returns the parameter name of the request parameter used to indicate if the search form is loaded the first time or repeatedly.
        Returns:
        The request parameter name used to indicate if the search form is loaded the first time or repeatedly.
      • getSearchForEmptyQueryParam

        boolean getSearchForEmptyQueryParam()
        Returns a flag, indicating if for an empty search query, search should be performed using a wildcard.
        Returns:
        A flag, indicating if for an empty search query, search should be performed using a wildcard.
      • getSolrCore

        java.lang.String getSolrCore()
        Returns the Solr core that should be used. Can also be null.
        Returns:
        The Solr core to use, or null if none is configured.
      • getSolrIndex

        java.lang.String getSolrIndex()
        Returns the Solr index that should be used.
        Returns:
        The Solr index to use.