net.firstpartners.rp.plugins.events
Interface IInterestedInSearch

All Superinterfaces:

IPlugin

All Known Implementing Classes:

RpSearcher

public interface IInterestedInSearch
extends IPlugin

Implemented by a plugin to mark if it is interested in feedback or not.

Author:

brownpa

Method Summary

void	doSearch(ISearchQuery searchQuery, java.lang.String sortField, boolean sortDescendent, int maxDocsNo) Search the known data
ISearchResult	getResults() Get the Search results generated by doSearch
boolean	isReady() Poll to see if the search has finished

Methods inherited from interface net.firstpartners.rp.plugins.IPlugin

onLoad

Method Detail

doSearch

void doSearch(ISearchQuery searchQuery,
              java.lang.String sortField,
              boolean sortDescendent,
              int maxDocsNo)
              throws RpException

Search the known data

Parameters:

searchQuery - Search query

sortField - Sort field

sortDescendent - Sort descendent mode = true, false - otherwise

maxDocsNo - The maxim number of documents (top documents) for the searcher

Throws:

RpException - Error occur in search operation

isReady

boolean isReady()

Poll to see if the search has finished

Returns:

True / False

getResults

ISearchResult getResults()

Get the Search results generated by doSearch

Returns:

searchResults