Remote Systems
v6.4.1

com.ibm.etools.systems.subsystems
Interface IRemoteSearchResultConfiguration

All Superinterfaces:
IRemoteSearchConstants
All Known Implementing Classes:
RemoteSearchResultConfigurationImpl

public interface IRemoteSearchResultConfiguration
extends IRemoteSearchConstants

An interface representing a search result configuration.


Field Summary
 
Fields inherited from interface com.ibm.etools.systems.subsystems.IRemoteSearchConstants
CANCELLED, DISCONNECTED, FINISHED, RUNNING
 
Method Summary
 void addResult(Object result)
          Adds a search result.
 void cancel()
          Cancels the search if it is running.
 void dispose()
          Cancels the search and then removes the search results.
 IRemoteSearchResultSet getParentResultSet()
          Gets the parent result set.
 Object[] getResults()
          Gets search results.
 int getResultsSize()
          Gets the size of the results.
 SystemSearchString getSearchString()
          Gets the search string.
 Object getSearchTarget()
          Gets the object to be searched.
 int getStatus()
          Gets the status of the search.
 void removeAndAddResult(Object oldResult, Object newResult)
          Removes the old result and adds a new result.
 void removeResult(Object result)
          Removes a search result.
 void removeResults()
          Removes all search results.
 void setParentResultSet(IRemoteSearchResultSet resultSet)
          Sets the parent result set.
 void setSearchString(SystemSearchString string)
          Sets the search string.
 void setSearchTarget(Object searchObject)
          Sets the object to be searched.
 void setStatus(int status)
          Sets the status of the search.
 

Method Detail

setParentResultSet

public void setParentResultSet(IRemoteSearchResultSet resultSet)
Sets the parent result set.

Parameters:
resultSet - the parent result set.

getParentResultSet

public IRemoteSearchResultSet getParentResultSet()
Gets the parent result set.

Returns:
the parent result set.

setSearchTarget

public void setSearchTarget(Object searchObject)
Sets the object to be searched.

Parameters:
searchObject - the object to be searched.

getSearchTarget

public Object getSearchTarget()
Gets the object to be searched.

Returns:
the object to be searched.

setSearchString

public void setSearchString(SystemSearchString string)
Sets the search string.

Parameters:
string - the search string.

getSearchString

public SystemSearchString getSearchString()
Gets the search string.

Returns:
string the search string.

addResult

public void addResult(Object result)
Adds a search result.

Parameters:
result - a search result.

removeResult

public void removeResult(Object result)
Removes a search result.

Parameters:
result - a search result.

removeAndAddResult

public void removeAndAddResult(Object oldResult,
                               Object newResult)
Removes the old result and adds a new result.

Parameters:
oldResult - the old result.
newResult - the new result.

getResults

public Object[] getResults()
Gets search results.

Returns:
search results.

getResultsSize

public int getResultsSize()
Gets the size of the results.

Returns:
the size of the results.

removeResults

public void removeResults()
Removes all search results.


setStatus

public void setStatus(int status)
Sets the status of the search. One of RUNNING, FINISHED, CANCELLED, or DISCONNECTED.


getStatus

public int getStatus()
Gets the status of the search. One of RUNNING, FINISHED, CANCELLED, or DISCONNECTED.

Returns:
the status of the search.

cancel

public void cancel()
Cancels the search if it is running.


dispose

public void dispose()
Cancels the search and then removes the search results. Implementors should call super first.


Remote Systems
v6.4.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.