Interface FacetSearchService
- All Known Subinterfaces:
BackofficeFacetSearchService
- All Known Implementing Classes:
DefaultBackofficeFacetSearchService,DefaultFacetSearchService
public interface FacetSearchService
Implementations of this interface, should be responsible for searching operations.
-
Method Summary
Modifier and TypeMethodDescriptioncreateFreeTextSearchQuery(FacetSearchConfig facetSearchConfig, IndexedType indexedType, String userQuery) Creates the search query, populates, adds free text query fields and user query fieldcreateFreeTextSearchQueryFromTemplate(FacetSearchConfig facetSearchConfig, IndexedType indexedType, String queryTemplateName, String userQuery) Creates the search query from the template, populates, adds free text query fields and user query fieldcreatePopulatedSearchQuery(FacetSearchConfig facetSearchConfig, IndexedType indexedType) Creates the search query and populates itcreateSearchQuery(FacetSearchConfig facetSearchConfig, IndexedType indexedType) Creates the search querycreateSearchQueryFromTemplate(FacetSearchConfig facetSearchConfig, IndexedType indexedType, String queryTemplateName) Creates the search query from the template, populates, adds free text query fields and user query fieldsearch(SearchQuery query) Does the search with the specific search query.search(SearchQuery query, Map<String, String> searchHints) Same assearch(SearchQuery)but allows to pass the search hints as parameter.
-
Method Details
-
createSearchQuery
Creates the search query- Parameters:
facetSearchConfig- the facet search configurationindexedType- the indexed type- Returns:
- the search query
-
createPopulatedSearchQuery
SearchQuery createPopulatedSearchQuery(FacetSearchConfig facetSearchConfig, IndexedType indexedType) Creates the search query and populates it- Parameters:
facetSearchConfig- the facet search configurationindexedType- the indexed type- Returns:
- the search query
-
createFreeTextSearchQuery
SearchQuery createFreeTextSearchQuery(FacetSearchConfig facetSearchConfig, IndexedType indexedType, String userQuery) Creates the search query, populates, adds free text query fields and user query field- Parameters:
facetSearchConfig- the facet search configurationindexedType- the indexed typeuserQuery- the user query- Returns:
- the search query
-
createSearchQueryFromTemplate
SearchQuery createSearchQueryFromTemplate(FacetSearchConfig facetSearchConfig, IndexedType indexedType, String queryTemplateName) Creates the search query from the template, populates, adds free text query fields and user query field- Parameters:
facetSearchConfig- the facet search configurationindexedType- the indexed typequeryTemplateName- template name to create a query from- Returns:
- the search query
-
createFreeTextSearchQueryFromTemplate
SearchQuery createFreeTextSearchQueryFromTemplate(FacetSearchConfig facetSearchConfig, IndexedType indexedType, String queryTemplateName, String userQuery) Creates the search query from the template, populates, adds free text query fields and user query field- Parameters:
facetSearchConfig- the facet search configurationindexedType- the indexed typequeryTemplateName- template name to create a query fromuserQuery- the user query- Returns:
- the search query
-
search
Does the search with the specific search query.- Parameters:
query- the query to be searched- Returns:
- the search result of the given query
- Throws:
FacetSearchException- throws FacetSearchException if the search query is not correctly configured
-
search
Same assearch(SearchQuery)but allows to pass the search hints as parameter.- Parameters:
query- the query to be searchedsearchHints- the search hints- Returns:
- the search result of the given query
- Throws:
FacetSearchException- throws FacetSearchException if the search query is not correctly configured
-