org.broadleafcommerce.core.search.service

Interface SearchService

All Known Implementing Classes:

DatabaseSearchServiceImpl, SolrSearchServiceImpl

public interface SearchService

Author:

Andre Azzolini (apazzolini)

Method Summary

Modifier and Type	Method and Description
SearchResult	findExplicitSearchResultsByCategory(Category category, SearchCriteria searchCriteria) Performs a search for search results in the given category, taking into consideration the SearchCriteria This method will NOT return search results that are in a sub-level of a given category.
SearchResult	findSearchResultsByCategory(Category category, SearchCriteria searchCriteria) Performs a search for search results in the given category, taking into consideration the SearchCriteria This method will return search results that are in any sub-level of a given category.
SearchResult	findSearchResultsByCategoryAndQuery(Category category, String query, SearchCriteria searchCriteria) Performs a search for search results in the given category for the given query, taking into consideration the SearchCriteria
SearchResult	findSearchResultsByQuery(String query, SearchCriteria searchCriteria) Performs a search for search results across all categories for the given query, taking into consideration the SearchCriteria
List<SearchFacetDTO>	getCategoryFacets(Category category) Gets all available facets for a given category
List<SearchFacetDTO>	getSearchFacets() Gets all available facets for search results page
void	rebuildIndex() This method delegates to SolrIndexService.rebuildIndex().

Method Detail

rebuildIndex

void rebuildIndex()
           throws ServiceException,
                  IOException

This method delegates to 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

IOException

findSearchResultsByCategory

SearchResult findSearchResultsByCategory(Category category,
                                         SearchCriteria searchCriteria)
                                  throws ServiceException

Performs a search for search results in the given category, taking into consideration the SearchCriteria This method will return search results 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 search results in "Routers", would return search results that are in the "Enterprise Routers" category.

Parameters:

category -

searchCriteria -

Returns:

the result of the search

Throws:

ServiceException

See Also:

findExplicitSearchResultsByCategory(Category, SearchCriteria)

findExplicitSearchResultsByCategory

SearchResult findExplicitSearchResultsByCategory(Category category,
                                                 SearchCriteria searchCriteria)
                                          throws ServiceException

Performs a search for search results in the given category, taking into consideration the SearchCriteria This method will NOT return search results 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 search results in "Routers", would NOT return search results that are in the "Enterprise Routers" category.

Parameters:

category -

searchCriteria -

Returns:

Throws:

ServiceException

See Also:

findSearchResultsByCategory(Category, SearchCriteria)

findSearchResultsByQuery

SearchResult findSearchResultsByQuery(String query,
                                      SearchCriteria searchCriteria)
                               throws ServiceException

Performs a search for search results across all categories for the given query, taking into consideration the SearchCriteria

Parameters:

query -

searchCriteria -

Returns:

the result of the search

Throws:

ServiceException

findSearchResultsByCategoryAndQuery

SearchResult findSearchResultsByCategoryAndQuery(Category category,
                                                 String query,
                                                 SearchCriteria searchCriteria)
                                          throws ServiceException

Performs a search for search results in the given category for the given query, taking into consideration the SearchCriteria

Parameters:

category -

query -

searchCriteria -

Throws:

ServiceException

getSearchFacets

List<SearchFacetDTO> getSearchFacets()

Gets all available facets for search results page

Returns:

the available facets

getCategoryFacets

List<SearchFacetDTO> getCategoryFacets(Category category)

Gets all available facets for a given category

Parameters:

category -

Returns:

the available facets