public interface ISearchQuery
ISearchResult
that can be accessed via getSearchResult().
Note that getSearchResult
may be called at any time, even
before the run()
method has been called. An empty search
result should be returned in that case.
Clients may implement this interface.
Modifier and Type | Method and Description |
---|---|
boolean |
canRerun()
Returns whether the query can be run more than once.
|
boolean |
canRunInBackground()
Returns whether this query can be run in the background.
|
String |
getLabel()
Returns a user readable label for this query.
|
ISearchResult |
getSearchResult()
Returns the search result associated with this query.
|
IStatus |
run(IProgressMonitor monitor)
This is the method that actually does the work, i.e. finds the results of
the search query.
|
IStatus run(IProgressMonitor monitor) throws OperationCanceledException
monitor
- the progress monitor to be usedOperationCanceledException
- Thrown when the search query has been canceled.String getLabel()
Job
name if this query is executed in
the background. Note that progress notification (for example, the number
of matches found) should be done via the progress monitor passed into the
run(IProgressMonitor)
methodboolean canRerun()
false
.boolean canRunInBackground()
ISearchResult getSearchResult()
Guidelines for using Eclipse APIs. Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.