| org.columba.core.search.api.ISearchProvider
All known Subclasses: org.columba.contact.search.ContactSearchProvider, org.columba.calendar.search.CalendarSearchProvider, org.columba.mail.search.MailSearchProvider,
| ISearchProvider | | public interface ISearchProvider extends IExtensionInterface(Code) | | Provider does the actual search and furthermore contains a description
of the search criteria.
author:
frd |
| Method Summary | |
| public List<ISearchCriteria> | getAllCriteria(String searchTerm)
Retrieve search criteria for given search term. | | public IResultPanel | getComplexResultPanel()
Get result panel for a complex search across a couple of specific criteria. | | public ISearchCriteria | getCriteria(String technicalName, String searchTerm)
Retrieve single search criteria for given search term. | | public ICriteriaRenderer | getCriteriaRenderer(String criteriaTechnicalName)
| | public ISearchCriteria | getDefaultCriteria(String searchTerm)
| | public String | getDescription()
| | public ImageIcon | getIcon()
| | public String | getName()
| | public IResultPanel | getResultPanel(String searchCriteriaTechnicalName)
Get result panel for given search criteria. | | public String | getTechnicalName()
Returns technical name. | | public int | getTotalResultCount()
Return total number of search results. | | public boolean | hasSingleCriteriaSearchResult()
Check if search provider has executed a single criteria search.
true, in case single criteria search was done. | | public List<ISearchResult> | query(String searchTerm, String searchCriteriaTechnicalName, boolean searchInside, int startIndex, int resultCount)
Execute query and retrieve pageable search result for given search term and
a single search criteria.
The query returns resultCount individual results, from
a given startIndex. | | public List<ISearchResult> | query(List<ISearchRequest> list, boolean matchAll, boolean searchInside, int startIndex, int resultCount)
| | public void | showAllResults(IFrameMediator mediator, String searchTerm, String searchCriteriaTechnicalName)
|
| getAllCriteria | | public List<ISearchCriteria> getAllCriteria(String searchTerm)(Code) | | Retrieve search criteria for given search term.
Parameters:
searchTerm - |
| getComplexResultPanel | | public IResultPanel getComplexResultPanel()(Code) | | Get result panel for a complex search across a couple of specific criteria.
|
| getCriteria | | public ISearchCriteria getCriteria(String technicalName, String searchTerm)(Code) | | Retrieve single search criteria for given search term.
Parameters:
technicalName -
Parameters:
searchTerm - |
| getCriteriaRenderer | | public ICriteriaRenderer getCriteriaRenderer(String criteriaTechnicalName)(Code) | | Get criteria renderer fo given search criteria technical name
Parameters:
searchCriteriaTechnicalName - |
| getDescription | | public String getDescription()(Code) | | Return provider human-readable description
|
| getName | | public String getName()(Code) | | Return provider human-readable name
|
| getResultPanel | | public IResultPanel getResultPanel(String searchCriteriaTechnicalName)(Code) | | Get result panel for given search criteria.
Parameters:
searchCriteriaTechnicalName - |
| getTechnicalName | | public String getTechnicalName()(Code) | | Returns technical name. Should be unique.
|
| getTotalResultCount | | public int getTotalResultCount()(Code) | | Return total number of search results. Method only returns valid result after calling
query first.
total number of search results. -1, in case query was not called, yet |
| hasSingleCriteriaSearchResult | | public boolean hasSingleCriteriaSearchResult()(Code) | | Check if search provider has executed a single criteria search.
true, in case single criteria search was done. False, otherwise. |
| query | | public List<ISearchResult> query(String searchTerm, String searchCriteriaTechnicalName, boolean searchInside, int startIndex, int resultCount)(Code) | | Execute query and retrieve pageable search result for given search term and
a single search criteria.
The query returns resultCount individual results, from
a given startIndex. Paging should be supported, so its
up to the underlying implementation to use an intelligent caching
strategy or whatever necessary to make repetitive calls to this
method fast.
Parameters:
searchTerm - search term
Parameters:
searchCriteriaTechnicalName - search criteria technical name
Parameters:
searchInside - search inside previous search results
Parameters:
startIndex - start index of search results
Parameters:
resultCount - total count of results |
|
|