com.plumtree.remote.prc.search
Interface ISearchRequest

All Known Subinterfaces:

IPortalSearchRequest

public interface ISearchRequest

Superinterface of IPortalSearchRequest and possibly other search requests, such as Collaboration.

Method Summary

ISearchResponse	execute() Executes the Search Request.
void	setQuery(IFilterClause filterClause) Set the query associated with this request.
void	setQuery(java.lang.String queryString) Sets the query associated with this request.
void	setQuery(java.lang.String queryString, IFilterClause filterClause) Set the query associated with this request.

Method Detail

setQuery

public void setQuery(java.lang.String queryString)

Sets the query associated with this request. The search string is a case-insensitive collection of terms and operators which documents must match in order to be returned from search. For example, a search for 'dog cat' would return documents containing 'dog', 'cat', or both. If double quotes are present, as in '"dog cat"', the phrase 'dog cat' must be present. Note: At least three characters must be present between wildcard characters: *ad* is invalid. Note: And, or, not, and near are considered operators in the search string, rather than terms. Note: When they appear in quoted strings, and, or, not, and near are treated as search terms. See search syntax for more examples. Note: This overrides any query previously set by a call to any version of setQuery().

Parameters:

queryString - the String to search

setQuery

public void setQuery(IFilterClause filterClause)

Set the query associated with this request. Some services may not be able to handle a complex filter clause, others will throw an exception if the clause is too complex. Note: This overrides any query previously set by a call to any version of setQuery().

Parameters:

filterClause - the Filter Clause created from ISearchFactory

Throws:

java.lang.IllegalStateException - if used in conjunction with particular attributes in subinterfaces

setQuery

public void setQuery(java.lang.String queryString,
                     IFilterClause filterClause)

Set the query associated with this request. The returned ISearchResponse will match both the query string and the filter clause. The search string is a case-insensitive collection of terms and operators which documents must match in order to be returned from search. For example, a search for 'dog cat' would return documents containing 'dog', 'cat', or both. If double quotes are present, as in '"dog cat"', the phrase 'dog cat' must be present. Note: At least three characters must be present between wildcard characters: *ad* is invalid. Note: And, or, not, and near are considered operators in the search string, rather than terms. Note: When they appear in quoted strings, and, or, not, and near are treated as search terms. See search syntax for more examples. Note: This overrides any query previously set by a call to any version of setQuery().

Parameters:

queryString - the String to search

filterClause - the Filter Clause created from ISearchFactory

Throws:

java.lang.IllegalStateException - if used in conjunction with particular attributes in subinterfaces

execute

public ISearchResponse execute()
                        throws SearchException,
                               java.rmi.RemoteException

Executes the Search Request.

Returns:

the ISearchResponse

Throws:

SearchException - if there was an error connecting to the search server, or an error occurred when executing the search on the search server

java.rmi.RemoteException - if there was a communication problem during the execution of the remote method call

java.lang.IllegalStateException - if the query has not been set