Interface SearchProvider
-
- All Known Implementing Classes:
AbstractSearchProvider
,GenericQuerySearchProvider
,ProductPerspectiveQueryProvider
public interface SearchProvider
The interface SearchProvider. Base interface to implement for simple searches. Only parameter to set is required root type of search result. The interface also declares one method that takesQuery
as an argument and returns search result.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
SELECTED_OBJECT_TEMPLATE
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description SearchType
getDefaultRootType()
Gets the default root type - search result will contain items of this type.ExtendedSearchResult
search(Query query)
Performs search for the givenQuery
object.void
setDefaultRootType(SearchType defaultRootType)
Sets the default root type.
-
-
-
Field Detail
-
SELECTED_OBJECT_TEMPLATE
static final java.lang.String SELECTED_OBJECT_TEMPLATE
- See Also:
- Constant Field Values
-
-
Method Detail
-
getDefaultRootType
SearchType getDefaultRootType()
Gets the default root type - search result will contain items of this type.- Returns:
- the default root type of the provider
-
setDefaultRootType
void setDefaultRootType(SearchType defaultRootType)
Sets the default root type. We will expect items of this type in the search result.- Parameters:
defaultRootType
- the new default root type
-
search
ExtendedSearchResult search(Query query)
Performs search for the givenQuery
object.- Parameters:
query
- the query object. This object contains all required information to perform search in the system.- Returns:
- the extended search result which is a simple POJO that contains result set and some additional information.
-
-