content: /*
   * This library is part of OpenCms -
   * the Open Source Content Management System
   *
   * Copyright (c) Alkacon Software GmbH & Co. KG (https://www.alkacon.com)
   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU Lesser General Public
   * License as published by the Free Software Foundation; either
   * version 2.1 of the License, or (at your option) any later version.
   *
   * This library is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   * Lesser General Public License for more details.
   *
   * For further information about Alkacon Software, please see the
   * company website: https://www.alkacon.com
   *
   * For further information about OpenCms, please see the
   * project website: https://www.opencms.org
   *
   * You should have received a copy of the GNU Lesser General Public
   * License along with this library; if not, write to the Free Software
   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   */
  
  package org.opencms.jsp.search.config.parser;
  
  import org.opencms.file.CmsObject;
  import org.opencms.jsp.search.config.I_CmsSearchConfigurationCommon;
  import org.opencms.jsp.search.config.I_CmsSearchConfigurationDidYouMean;
  import org.opencms.jsp.search.config.I_CmsSearchConfigurationFacetField;
  import org.opencms.jsp.search.config.I_CmsSearchConfigurationFacetQuery;
  import org.opencms.jsp.search.config.I_CmsSearchConfigurationFacetRange;
  import org.opencms.jsp.search.config.I_CmsSearchConfigurationGeoFilter;
  import org.opencms.jsp.search.config.I_CmsSearchConfigurationHighlighting;
  import org.opencms.jsp.search.config.I_CmsSearchConfigurationPagination;
  import org.opencms.jsp.search.config.I_CmsSearchConfigurationSorting;
  
  import java.util.Map;
  
  /** The interface that must be implemented by search (form) configuration parsers. */
  public interface I_CmsSearchConfigurationParser {
  
      /** Returns the common search configuration.
       * @param cms the current context
       * @return The common search configuration.
       */
      I_CmsSearchConfigurationCommon parseCommon(CmsObject cms);
  
      /** Returns the configuration for the "Did you mean ...?" feature.
       * @return The configuration for the "Did you mean ...?" feature.
       */
      I_CmsSearchConfigurationDidYouMean parseDidYouMean();
  
      /** Returns the configuration for the field facets.
       * @return The configuration for the field facets.
       */
      Map<String, I_CmsSearchConfigurationFacetField> parseFieldFacets();
  
      /** Returns the configuration for the Geo filter.
       * @return The configuration for the Geo filter.
       */
      I_CmsSearchConfigurationGeoFilter parseGeoFilter();
  
      /** Returns the configuration for the highlighting.
       * @return The configuration for the highlighting.
       */
      I_CmsSearchConfigurationHighlighting parseHighlighter();
  
      /** Returns the configuration for the pagination.
       * @return The configuration for the pagination.
       */
      I_CmsSearchConfigurationPagination parsePagination();
  
      /** Returns the configuration for the query facet.
       * @return The configuration for the query facet.
       */
      I_CmsSearchConfigurationFacetQuery parseQueryFacet();
  
      /** Returns the configuration for the range facets.
       * @return The configuration for the range facets.
       */
      Map<String, I_CmsSearchConfigurationFacetRange> parseRangeFacets();
  
      /** Returns the configuration for sorting.
       * @return The configuration for sorting.
       */
      I_CmsSearchConfigurationSorting parseSorting();
  }
  