|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A search engine that is a participant in the help search. All engines selected by the user to run are executed as background jobs using the same search expression. Engine is expected to accept the expression and the scope object. The results should be passed to the result collector object, and the search progress should be tracked by the progress monitor.
Search engines that have API access to the search server can provide a list of individual search results. Search engines for which only the URL is known are expected to return one search result containing a URL that is sufficient to open a web browser and see the search results there.
Search engine must be cancelable.
This interface is intended to be implemented by clients.
Method Summary | |
---|---|
void |
run(String query,
ISearchScope scope,
ISearchEngineResultCollector collector,
IProgressMonitor monitor)
|
Method Detail |
public void run(String query, ISearchScope scope, ISearchEngineResultCollector collector, IProgressMonitor monitor) throws CoreException
query
- the search expressionscope
- the engine-specific scope object that is used to narrow the
search or null
if the default scope is assumed.collector
- the search result collector handles results as they arrivemonitor
- progress monitor to track the search progress
CoreException
- when there are problems in the engine
|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.