Overview  Package    Class   Use  Tree  Deprecated  Index  Help		RSE Release 3.0
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR |  METHOD	DETAIL: FIELD | CONSTR |  METHOD

---

org.eclipse.rse.services.search
Interface IHostSearchResultSet

All Known Implementing Classes:

HostSearchResultSet

---

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

setName

void setName(
String name)

Sets the name of the search.

Parameters:

name - the name of the search.

---

getName

String getName()

Gets the name of the search that is being run.

Returns:

the name of the search.

---

addSearchConfiguration

void addSearchConfiguration(
IHostSearchResultConfiguration config)

Add a search configuration.

Parameters:

config - a search configuration.

---

removeSearchConfiguration

void removeSearchConfiguration(
IHostSearchResultConfiguration config)

Removes a search configuration.

Parameters:

config - a search configuration.

---

getSearchConfigurations

Iterator getSearchConfigurations()

Returns an iterator over search configurations.

Returns:

an iterator over search configurations.

---

addResult

void addResult(
IHostSearchResultConfiguration config,
               
Object result)

Add a result for a search configuration.

Parameters:

config - a search configuration that was previously added.

result - a search result.

---

removeResult

void removeResult(
IHostSearchResultConfiguration config,
                  
Object result)

Removes a result from a search configuration.

Parameters:

config - a search configuration that was previously added.

result - a search result.

---

removeResult

void removeResult(
Object result)

Removes a result from all search configurations where it exists.

Parameters:

result - a search result.

---

removeAndAddResult

void removeAndAddResult(
Object oldResult,
                        
Object newResult)

Removes the old result from configurations where it is found, and add the new result to those configurations.

Parameters:

oldResult - the old result.

newResult - the new result.

---

getResultsForConfiguration

Object[] getResultsForConfiguration(
IHostSearchResultConfiguration config)

Returns the results of a particular search configuration.

Parameters:

config - a search configuration.

Returns:

the results for the given search configuration.

---

getAllResults

Object[] getAllResults()

Returns all results of the search.

Returns:

all results of the search.

---

removeAllResults

void removeAllResults()

Removes all results of the search.

---

getNumOfResults

int getNumOfResults()

Gets the number of results.

Returns:

the number of results.

---

cancel

void cancel()

Cancels the search. Cancel those configurations that are still running.

---

dispose

void dispose()

Removes all configurations. First cancels the search, then calls the dispose method of the configurations before removing them.

---

isRunning

boolean isRunning()

Returns whether search is running. A search is running if any of the configurations is running.

Returns:

true if the search is running, false otherwise.

---

isCancelled

boolean isCancelled()

Returns whether the search is cancelled. A search is cancelled if all of the configurations are cancelled.

Returns:

true if the search is cancelled, false otherwise.

---

isFinished

boolean isFinished()

Returns whether the search is finished. A search is finished if all the configurations are finished.

Returns:

true if the search is finished, false otherwise.

---

isDisconnected

boolean isDisconnected()

Returns whether the search is disconnected. A search is disconnected if all the configurations are disconnected.

Returns:

true if the search is disconnected, false otherwise.

---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help		RSE Release 3.0
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR |  METHOD	DETAIL: FIELD | CONSTR |  METHOD

---

Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.