KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > ibm > webdav > SearchRequest


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 package com.ibm.webdav;
15
16 import org.w3c.dom.*;
17
18 import java.util.*;
19
20 /**
21  * SearchRequest provides a standard interface to an underlying
22  * search implementation which can then be used in the DAV4J
23  * to support the DASL spec.
24  *
25  * Note: Although the DASL spec describes a basic search XML format it
26  * does not exclude the use of other formats.
27  *
28  *
29  * @author Michael Bell
30  * @version $Revision: 1.1 $
31  *
32  */
33 public interface SearchRequest {
34     public static final String JavaDoc ORDER_ASC = "asc";
35     public static final String JavaDoc ORDER_DESC = "desc";
36
37     public static final int ALL_MEMBERS = -1;
38     public static final int THIS_RESOURCE = 0;
39     public static final int IMMEDIATE_MEMBERS = 1;
40
41     public void instantiateFromXML(Element xmlElement)
42                             throws Exception JavaDoc;
43
44     public SearchSchema getSearchSchema() throws Exception JavaDoc;
45
46     public int getResultLimit();
47
48     public String JavaDoc getScopeURI();
49
50     public int getScopeDepth();
51
52     public Vector getOrderByProperties();
53
54     public String JavaDoc getOrderByDirection(PropertyName propName);
55
56     public SearchCondition getCondition();
57
58     public Vector getSelectProperties();
59
60     public boolean isAllSelectProperties();
61
62     public boolean isIncludePropertyDefinitions();
63 }
Popular Tags