KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > ibm > webdav > impl > SearchManager


1 /*
2  * (C) Copyright Simulacra Media Ltd, 2004. All rights reserved.
3  *
4  * The program is provided "AS IS" without any warranty express or
5  * implied, including the warranty of non-infringement and the implied
6  * warranties of merchantibility and fitness for a particular purpose.
7  * Simulacra Media Ltd will not be liable for any damages suffered by you as a result
8  * of using the Program. In no event will Simulacra Media Ltd be liable for any
9  * special, indirect or consequential damages or lost profits even if
10  * Simulacra Media Ltd has been advised of the possibility of their occurrence.
11  * Simulacra Media Ltd will not be liable for any third party claims against you.
12  *
13  */
14
15 package com.ibm.webdav.impl;
16
17 import com.ibm.webdav.*;
18
19 import java.util.*;
20
21
22 /**
23  * SearchManager implements all WebDAV search methods that are
24  * dependent on a specific repository manager interface. This manager is
25  * used by ResourceImpl and its subclasses to interface with a particular
26  * repository manager for searching over resources.
27  *
28  * @author Michael Bell
29  * @version $Revision: 1.1 $
30  *
31  */
32 public interface SearchManager {
33     /** Initialize this SearchManager instance.
34     * @param resource the resource to manage
35     */
36     public void initialize();
37
38     /**
39      * Returns the query schema for this resource
40      *
41      * @param searchReq
42      * @return
43      * @throws WebDAVException
44      */
45     public SearchSchema getSearchSchema(SearchRequest searchReq)
46                                  throws WebDAVException;
47
48     /**
49      * Executes search and returns result
50      *
51      * @param searchReq
52      * @param resource
53      * @return
54      * @throws WebDAVException
55      */
56     public Vector executeSearch(SearchRequest searchReq, ResourceImpl resource)
57                          throws WebDAVException;
58
59     /**
60      * Validate search request
61      *
62      * @param searchReq
63      * @return
64      * @throws WebDAVException
65      */
66     public boolean validate(SearchRequest searchReq) throws WebDAVException;
67 }
Popular Tags