|
RSE Release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IHostSearchResultSet
A remote search result set represents a page in the Remote Search view. A search result set contains multiple search configurations and their results. This allows it to contain results from multiple connections, filters, and folders (from different systems).
Method Summary | |
---|---|
void |
addResult(IHostSearchResultConfiguration config,
Object result)
Add a result for a search configuration. |
void |
addSearchConfiguration(IHostSearchResultConfiguration config)
Add a search configuration. |
void |
cancel()
Cancels the search. |
void |
dispose()
Removes all configurations. |
Object[] |
getAllResults()
Returns all results of the search. |
String |
getName()
Gets the name of the search that is being run. |
int |
getNumOfResults()
Gets the number of results. |
Object[] |
getResultsForConfiguration(IHostSearchResultConfiguration config)
Returns the results of a particular search configuration. |
Iterator |
getSearchConfigurations()
Returns an iterator over search configurations. |
boolean |
isCancelled()
Returns whether the search is cancelled. |
boolean |
isDisconnected()
Returns whether the search is disconnected. |
boolean |
isFinished()
Returns whether the search is finished. |
boolean |
isRunning()
Returns whether search is running. |
void |
removeAllResults()
Removes all results of the search. |
void |
removeAndAddResult(Object oldResult,
Object newResult)
Removes the old result from configurations where it is found, and add the new result to those configurations. |
void |
removeResult(IHostSearchResultConfiguration config,
Object result)
Removes a result from a search configuration. |
void |
removeResult(Object result)
Removes a result from all search configurations where it exists. |
void |
removeSearchConfiguration(IHostSearchResultConfiguration config)
Removes a search configuration. |
void |
setName(String name)
Sets the name of the search. |
Method Detail |
---|
void setName(String name)
name
- the name of the search.String getName()
void addSearchConfiguration(IHostSearchResultConfiguration config)
config
- a search configuration.void removeSearchConfiguration(IHostSearchResultConfiguration config)
config
- a search configuration.Iterator getSearchConfigurations()
void addResult(IHostSearchResultConfiguration config, Object result)
config
- a search configuration that was previously added.result
- a search result.void removeResult(IHostSearchResultConfiguration config, Object result)
config
- a search configuration that was previously added.result
- a search result.void removeResult(Object result)
result
- a search result.void removeAndAddResult(Object oldResult, Object newResult)
oldResult
- the old result.newResult
- the new result.Object[] getResultsForConfiguration(IHostSearchResultConfiguration config)
config
- a search configuration.
Object[] getAllResults()
void removeAllResults()
int getNumOfResults()
void cancel()
void dispose()
dispose
method of
the configurations before removing them.
boolean isRunning()
true
if the search is running, false
otherwise.boolean isCancelled()
true
if the search is cancelled, false
otherwise.boolean isFinished()
true
if the search is finished, false
otherwise.boolean isDisconnected()
true
if the search is disconnected, false
otherwise.
|
RSE Release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |