org.apache.jackrabbit.webdav.search
Interface SearchResource

All Known Implementing Classes:
DefaultItemCollection, DefaultItemResource, RootCollection, SearchResourceImpl, VersionControlledItemCollection, VersionHistoryItemCollection, VersionItemCollection, WorkspaceResourceImpl

public interface SearchResource

SearchResource defines METHODS required in order to handle a SEARCH request.


Field Summary
static String METHODS
          The 'SEARCH' method
 
Method Summary
 QueryGrammerSet getQueryGrammerSet()
          Returns the protected DAV:supported-method-set property which is defined mandatory by RTF 3253.
 MultiStatus search(SearchInfo sInfo)
          Runs a search with the language and query defined in the SearchInfo object specified and returns a MultiStatus object listing the results.
 

Field Detail

METHODS

static final String METHODS
The 'SEARCH' method

See Also:
Constant Field Values
Method Detail

getQueryGrammerSet

QueryGrammerSet getQueryGrammerSet()
Returns the protected DAV:supported-method-set property which is defined mandatory by RTF 3253. This method call is a shortcut for DavResource.getProperty(SearchConstants.QUERY_GRAMMER_SET).

Returns:
the DAV:supported-query-grammer-set
See Also:
SearchConstants.QUERY_GRAMMER_SET

search

MultiStatus search(SearchInfo sInfo)
                   throws DavException
Runs a search with the language and query defined in the SearchInfo object specified and returns a MultiStatus object listing the results.

Parameters:
sInfo - SearchInfo element encapsulating the SEARCH request body.
Returns:
MultiStatus object listing the results.
Throws:
DavException


Copyright © 2004-2010 The Apache Software Foundation. All Rights Reserved.