Search.ISearchProvider Interface
Namespace: Nucleus.Abstractions.Search
Assembly: Nucleus.Abstractions.dll
Defines the interface for a search provider.
Remarks
Search providers retrieve search results from a search engine. The interface for search index management is provided by a separate interface, Search.ISearchIndexManager.
Methods
GetCapabilities
GetCapabilities ()
Return a Search.ISearchProviderCapabilities object which reports the search provider's cababilities and limitations.
Remarks
This method has a default implementation, which returns a Search.ISearchProviderCapabilities with no restrictions. Therefore, Search providers which support all features do not need to implement this method.
Search (SearchQuery) Method
Search (SearchQuery query)
Return results matching the values specified by query.
Parameters
| Name | Type |
|---|---|
| query | Nucleus.Abstractions.Search.SearchQuery |
Suggest (SearchQuery) Method
Suggest (SearchQuery query)
Return search suggestions matching the values specified by query.
Parameters
| Name | Type |
|---|---|
| query | Nucleus.Abstractions.Search.SearchQuery |
Remarks
Implementations of this interface which do not provide search suggestions can throw a NotImplementedException.