Package de.hybris.platform.commercefacades.search

Interface ProductSearchFacade<ITEM extends ProductData>

Type Parameters:

ITEM - The type of the product result items

All Known Subinterfaces:

VendorProductSearchFacade

All Known Implementing Classes:

DefaultB2BSolrProductSearchFacade, DefaultSolrProductSearchFacade, DefaultVendorProductSearchFacade

public interface ProductSearchFacade<ITEM extends ProductData>

Product search facade interface. Used to retrieve products of type ProductData (or subclasses of).

Method Summary

Modifier and Type	Method	Description
ProductCategorySearchPageData<SearchStateData,ITEM,CategoryData>	categorySearch(java.lang.String categoryCode)	Initiate a new search in category.
ProductCategorySearchPageData<SearchStateData,ITEM,CategoryData>	categorySearch(java.lang.String categoryCode, SearchStateData searchState, PageableData pageableData)	Refine an exiting search.
ProductCategorySearchPageData<SearchStateData,ITEM,CategoryData>	categorySearch(java.lang.String categoryCode, SearchQueryContext searchQueryContext)	Initiate a new search in category in a search query context.
java.util.List<AutocompleteSuggestionData>	getAutocompleteSuggestions(java.lang.String input)	Get the auto complete suggestions for the provided input.
ProductSearchPageData<SearchStateData,ITEM>	textSearch(SearchStateData searchState, PageableData pageableData)	Refine an exiting search.
ProductSearchPageData<SearchStateData,ITEM>	textSearch(java.lang.String text)	Initiate a new search using simple free text query.
ProductSearchPageData<SearchStateData,ITEM>	textSearch(java.lang.String text, SearchQueryContext searchQueryContext)	Initiate a new search using simple free text query in a search query context.

Method Detail

textSearch

ProductSearchPageData<SearchStateData,ITEM> textSearch(java.lang.String text)

Initiate a new search using simple free text query.

Parameters:

text - the search text

Returns:

the search results

textSearch

ProductSearchPageData<SearchStateData,ITEM> textSearch(java.lang.String text,
                                                             SearchQueryContext searchQueryContext)

Initiate a new search using simple free text query in a search query context.

Parameters:

text - the search text

searchQueryContext - search query context

Returns:

the search results

textSearch

ProductSearchPageData<SearchStateData,ITEM> textSearch(SearchStateData searchState,
                                                             PageableData pageableData)

Refine an exiting search. The query object allows more complex queries using facet selection. The SearchStateData must have been obtained from the results of a call to textSearch(String).

Parameters:

searchState - the search query object

pageableData - the page to return

Returns:

the search results

categorySearch

ProductCategorySearchPageData<SearchStateData,ITEM,CategoryData> categorySearch(java.lang.String categoryCode)

Initiate a new search in category.

Parameters:

categoryCode - the category to search in

Returns:

the search results

categorySearch

ProductCategorySearchPageData<SearchStateData,ITEM,CategoryData> categorySearch(java.lang.String categoryCode,
                                                                                            SearchQueryContext searchQueryContext)

Initiate a new search in category in a search query context.

Parameters:

categoryCode - the category to search in

searchQueryContext - search query context

Returns:

the search results

categorySearch

ProductCategorySearchPageData<SearchStateData,ITEM,CategoryData> categorySearch(java.lang.String categoryCode,
                                                                                            SearchStateData searchState,
                                                                                            PageableData pageableData)

Refine an exiting search. The query object allows more complex queries using facet selection. The SearchStateData must have been obtained from the results of a call to categorySearch(String).

Parameters:

categoryCode - the category to search in

searchState - the search query object

pageableData - the page to return

Returns:

the search results

getAutocompleteSuggestions

java.util.List<AutocompleteSuggestionData> getAutocompleteSuggestions(java.lang.String input)

Get the auto complete suggestions for the provided input.

Parameters:

input - the user's input

Returns:

a list of suggested search terms