01: /*
02: * (C) Copyright Simulacra Media Ltd, 2004. All rights reserved.
03: *
04: * The program is provided "AS IS" without any warranty express or
05: * implied, including the warranty of non-infringement and the implied
06: * warranties of merchantibility and fitness for a particular purpose.
07: * Simulacra Media Ltd will not be liable for any damages suffered by you as a result
08: * of using the Program. In no event will Simulacra Media Ltd be liable for any
09: * 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 ORDER_ASC = "asc";
35: public static final String 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) throws Exception;
42:
43: public SearchSchema getSearchSchema() throws Exception;
44:
45: public int getResultLimit();
46:
47: public String getScopeURI();
48:
49: public int getScopeDepth();
50:
51: public Vector getOrderByProperties();
52:
53: public String getOrderByDirection(PropertyName propName);
54:
55: public SearchCondition getCondition();
56:
57: public Vector getSelectProperties();
58:
59: public boolean isAllSelectProperties();
60:
61: public boolean isIncludePropertyDefinitions();
62: }
|