|
RSE Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
void setParentResultSet(IHostSearchResultSet resultSet)
resultSet
- the parent result set.IHostSearchResultSet getParentResultSet()
IHostSearchResult[] getContainedResults(Object resultContainer)
resultContainer
-
void setSearchTarget(Object searchObject)
searchObject
- the object to be searched.Object getSearchTarget()
void setSearchString(SystemSearchString string)
string
- the search string.SystemSearchString getSearchString()
void addResult(Object result)
result
- a search result.void addResults(Object container, IHostSearchResult[] results)
container
- results
- void removeResult(Object result)
result
- a search result.void removeAndAddResult(Object oldResult, Object newResult)
oldResult
- the old result.newResult
- the new result.Object[] getResults()
int getResultsSize()
void removeResults()
void setStatus(int status)
RUNNING
, FINISHED
,
CANCELLED
, or DISCONNECTED
.
status
- the status.int getStatus()
RUNNING
, FINISHED
,
CANCELLED
, or DISCONNECTED
.
void cancel()
void dispose()
super
first.
void setSearchHandler(ISearchHandler handler)
handler
-
|
RSE Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |