Interface SearchResource
-
- All Known Implementing Classes:
DefaultItemCollection
,DefaultItemResource
,EventJournalResourceImpl
,RootCollection
,SearchResourceImpl
,VersionControlledItemCollection
,VersionHistoryItemCollection
,VersionItemCollection
,WorkspaceResourceImpl
public interface SearchResource
SearchResource
defines METHODS required in order to handle a SEARCH request.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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 theSearchInfo
object specified and returns aMultiStatus
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 forDavResource.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 theSearchInfo
object specified and returns aMultiStatus
object listing the results.- Parameters:
sInfo
-SearchInfo
element encapsulating the SEARCH request body.- Returns:
MultiStatus
object listing the results.- Throws:
DavException
-
-