org.broadleafcommerce.core.search.service.SearchService Maven / Gradle / Ivy
/*
* #%L
* BroadleafCommerce Framework
* %%
* Copyright (C) 2009 - 2013 Broadleaf Commerce
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
package org.broadleafcommerce.core.search.service;
import org.broadleafcommerce.common.exception.ServiceException;
import org.broadleafcommerce.core.catalog.domain.Category;
import org.broadleafcommerce.core.search.domain.ProductSearchCriteria;
import org.broadleafcommerce.core.search.domain.ProductSearchResult;
import org.broadleafcommerce.core.search.domain.SearchFacetDTO;
import org.broadleafcommerce.core.search.service.solr.SolrIndexService;
import java.io.IOException;
import java.util.List;
/**
*
* @author Andre Azzolini (apazzolini)
*/
public interface SearchService {
/**
* This method delegates to {@link SolrIndexService#rebuildIndex()}. It is here to preserve backwards-compatibility
* with sites that were originally configured to run Broadleaf with Solr before 2.2.0.
*
* @throws ServiceException
* @throws IOException
*/
public void rebuildIndex() throws ServiceException, IOException;
/**
* Performs a search for products in the given category, taking into consideration the ProductSearchCriteria
*
* This method will return products that are in any sub-level of a given category. For example, if you had a
* "Routers" category and a "Enterprise Routers" sub-category, asking for products in "Routers", would return
* products that are in the "Enterprise Routers" category.
*
* @see #findExplicitProductsByCategory(Category, ProductSearchCriteria)
*
* @param category
* @param searchCriteria
* @return the result of the search
* @throws ServiceException
*/
public ProductSearchResult findProductsByCategory(Category category, ProductSearchCriteria searchCriteria)
throws ServiceException;
/**
* Performs a search for products in the given category, taking into consideration the ProductSearchCriteria
*
* This method will NOT return products that are in a sub-level of a given category. For example, if you had a
* "Routers" category and a "Enterprise Routers" sub-category, asking for products in "Routers", would NOT return
* products that are in the "Enterprise Routers" category.
*
* @see #findProductsByCategory(Category, ProductSearchCriteria)
*
* @param category
* @param searchCriteria
* @return
* @throws ServiceException
*/
public ProductSearchResult findExplicitProductsByCategory(Category category, ProductSearchCriteria searchCriteria)
throws ServiceException;
/**
* Performs a search for products across all categories for the given query, taking into consideration
* the ProductSearchCriteria
*
* @param query
* @param searchCriteria
* @return the result of the search
* @throws ServiceException
*/
public ProductSearchResult findProductsByQuery(String query, ProductSearchCriteria searchCriteria)
throws ServiceException;
/**
* Performs a search for products in the given category for the given query, taking into consideration
* the ProductSearchCriteria
*
* @param category
* @param query
* @param searchCriteria
* @throws ServiceException
*/
public ProductSearchResult findProductsByCategoryAndQuery(Category category, String query,
ProductSearchCriteria searchCriteria) throws ServiceException;
/**
* Gets all available facets for search results page
*
* @return the available facets
*/
public List getSearchFacets();
/**
* Gets all available facets for a given category
*
* @param category
* @return the available facets
*/
public List getCategoryFacets(Category category);
}