org.apache.jackrabbit.webdav.search.SearchResource Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jackrabbit.webdav.search;
import org.apache.jackrabbit.webdav.DavException;
import org.apache.jackrabbit.webdav.MultiStatus;
/**
* SearchResource defines METHODS required in order to handle
* a SEARCH request.
*/
public interface SearchResource {
/**
* The 'SEARCH' method
*/
public String METHODS = "SEARCH";
/**
* 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).
*
* @return the DAV:supported-query-grammer-set
* @see SearchConstants#QUERY_GRAMMER_SET
*/
public QueryGrammerSet getQueryGrammerSet();
/**
* Runs a search with the language and query defined in the {@link SearchInfo}
* object specified and returns a {@link MultiStatus} object listing the
* results.
*
* @param sInfo SearchInfo element encapsulating the SEARCH
* request body.
* @return MultiStatus object listing the results.
* @throws DavException
*/
public MultiStatus search(SearchInfo sInfo) throws DavException;
}