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	findSearchResults(SearchCriteria searchCriteria) Performs a search for search results based on the given SearchCriteria, if SearchCriteria has a category, the category is considering for the search.
SearchResult	findSearchResultsByCategory(Category category, SearchCriteria searchCriteria) Deprecated. use #findSearchResults(SearchCriteria)
SearchResult	findSearchResultsByCategoryAndQuery(Category category, String query, SearchCriteria searchCriteria) Deprecated. use #findSearchResults(SearchCriteria)
SearchResult	findSearchResultsByQuery(String query, SearchCriteria searchCriteria) Deprecated. use #findSearchResults(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
List<SearchFacetDTO>	getSearchFacets(Category category) Gets all available facets for the given category and global search
boolean	isActive() Determines whether or not the necessary configuration is in place

Method Detail

findSearchResultsByCategory

@Deprecated
SearchResult findSearchResultsByCategory(Category category,
                                                     SearchCriteria searchCriteria)
                                              throws ServiceException

Deprecated. use #findSearchResults(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. 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

@Deprecated
SearchResult findSearchResultsByQuery(String query,
                                                  SearchCriteria searchCriteria)
                                           throws ServiceException

Deprecated. use #findSearchResults(SearchCriteria)

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

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

Deprecated. use #findSearchResults(SearchCriteria)

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

findSearchResults

SearchResult findSearchResults(SearchCriteria searchCriteria)
                        throws ServiceException

Performs a search for search results based on the given SearchCriteria, if SearchCriteria has a category, the category is considering for the search.

Parameters:

searchCriteria - contains the information about this given search

Returns:

the SearchResult

Throws:

ServiceException

getSearchFacets

List<SearchFacetDTO> getSearchFacets()

Gets all available facets for search results page

Returns:

the available facets

getSearchFacets

List<SearchFacetDTO> getSearchFacets(Category category)

Gets all available facets for the given category and global search

Parameters:

category -

Returns:

getCategoryFacets

List<SearchFacetDTO> getCategoryFacets(Category category)

Gets all available facets for a given category

Parameters:

category -

Returns:

the available facets

isActive

boolean isActive()

Determines whether or not the necessary configuration is in place

Returns:

whether or not the necessary configuration is in place