Eclipse RSE Development Guide (Galileo) - IHostSearchResultConfiguration (RSE API Specification)

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 IHostSearchResultConfiguration

All Known Implementing Classes:: AbstractSearchResultConfiguration, RemoteSearchResultConfiguration

public interface IHostSearchResultConfiguration

An interface representing a search result configuration.

Method Summary

void addResult ( Object result)
          Adds a search result.

void addResults ( Object container, IHostSearchResult[] results)
          Adds a set of search results along their associated container

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

void dispose ()
          Cancels the search and then removes the search results.

IHostSearchResult[] getContainedResults ( Object resultContainer)
          Gets the results contained within the resultContainer

IHostSearchResultSet 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 ( IHostSearchResultSet resultSet)
          Sets the parent result set.

void setSearchHandler ( ISearchHandler handler)
          Sets the search handler

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

void setParentResultSet(
IHostSearchResultSet resultSet)

Sets the parent result set.

Parameters:: resultSet - the parent result set.

getParentResultSet


IHostSearchResultSet getParentResultSet()

Gets the parent result set.

Returns:: the parent result set.

getContainedResults


IHostSearchResult[] getContainedResults(
Object resultContainer)

Gets the results contained within the resultContainer

Parameters:: resultContainer -
Returns:: the results

setSearchTarget

void setSearchTarget(
Object searchObject)

Sets the object to be searched.

Parameters:: searchObject - the object to be searched.

getSearchTarget


Object getSearchTarget()

Gets the object to be searched.

Returns:: the object to be searched.

setSearchString

void setSearchString(
SystemSearchString string)

Sets the search string.

Parameters:: string - the search string.

getSearchString


SystemSearchString getSearchString()

Gets the search string.

Returns:: string the search string.

addResult

void addResult(
Object result)

Adds a search result.

Parameters:: result - a search result.

addResults

void addResults(
Object container,
                
IHostSearchResult[] results)

Adds a set of search results along their associated container

Parameters:: container -; results -

removeResult

void removeResult(
Object result)

Removes a search result.

Parameters:: result - a search result.

removeAndAddResult

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


Object[] getResults()

Gets search results.

Returns:: search results.

getResultsSize

int getResultsSize()

Gets the size of the results.

Returns:: the size of the results.

removeResults

void removeResults()

Removes all search results.

setStatus

void setStatus(int status)

Sets the status of the search. One of RUNNING, FINISHED, CANCELLED, or DISCONNECTED.

Parameters:: status - the status.

getStatus

int getStatus()

Gets the status of the search. One of RUNNING, FINISHED, CANCELLED, or DISCONNECTED.

Returns:: the status of the search.

cancel

void cancel()

Cancels the search if it is running.

dispose

void dispose()

Cancels the search and then removes the search results. Implementors should call super first.

setSearchHandler

void setSearchHandler(
ISearchHandler handler)

Sets the search handler

Parameters:: handler -