KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > mondrian > xmla > XmlaRequest


1 /*
2 // $Id: //open/mondrian/src/main/mondrian/xmla/XmlaRequest.java#5 $
3 // This software is subject to the terms of the Common Public License
4 // Agreement, available at the following URL:
5 // http://www.opensource.org/licenses/cpl.html.
6 // Copyright (C) 2005-2006 Julian Hyde
7 // All Rights Reserved.
8 // You must accept the terms of that agreement to use this software.
9 */

10 package mondrian.xmla;
11
12 import java.util.Map JavaDoc;
13 import java.util.List JavaDoc;
14
15 /**
16  * XML/A request interface.
17  *
18  * @author Gang Chen
19  * @version $Id: //open/mondrian/src/main/mondrian/xmla/XmlaRequest.java#5 $
20  */

21 public interface XmlaRequest {
22
23     /**
24      * Indicate DISCOVER or EXECUTE method.
25      */

26     int getMethod();
27
28     /**
29      * Properties of XML/A request.
30      */

31     Map JavaDoc<String JavaDoc, String JavaDoc> getProperties();
32
33     /**
34      * Restrictions of DISCOVER method.
35      */

36     Map JavaDoc<String JavaDoc, List JavaDoc<String JavaDoc>> getRestrictions();
37
38     /**
39      * Statement of EXECUTE method.
40      */

41     String JavaDoc getStatement();
42
43     /**
44      * Role binds with this XML/A reqeust.
45      */

46     String JavaDoc getRole();
47
48     /**
49      * Request type of DISCOVER method.
50      */

51     String JavaDoc getRequestType();
52
53     /**
54      * Indicate whether statement is a drill through statement of
55      * EXECUTE method.
56      */

57     boolean isDrillThrough();
58
59     /**
60      * Drill through option: max returning rows of query.
61      *
62      * Value -1 means this option isn't provided.
63      */

64     int drillThroughMaxRows();
65
66     /**
67      * Drill through option: first returning row of query.
68      *
69      * Value -1 means this option isn't provided.
70      */

71     int drillThroughFirstRowset();
72
73 }
74
75 // End XmlaRequest.java
76
Popular Tags