KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > riotfamily > riot > dao > ListParams


1 /* ***** BEGIN LICENSE BLOCK *****
2  * Version: MPL 1.1
3  * The contents of this file are subject to the Mozilla Public License Version
4  * 1.1 (the "License"); you may not use this file except in compliance with
5  * the License. You may obtain a copy of the License at
6  * http://www.mozilla.org/MPL/
7  *
8  * Software distributed under the License is distributed on an "AS IS" basis,
9  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
10  * for the specific language governing rights and limitations under the
11  * License.
12  *
13  * The Original Code is Riot.
14  *
15  * The Initial Developer of the Original Code is
16  * Neteye GmbH.
17  * Portions created by the Initial Developer are Copyright (C) 2006
18  * the Initial Developer. All Rights Reserved.
19  *
20  * Contributor(s):
21  * Felix Gnass [fgnass at neteye dot de]
22  *
23  * ***** END LICENSE BLOCK ***** */
24 package org.riotfamily.riot.dao;
25
26 import java.util.List JavaDoc;
27
28 public interface ListParams {
29
30     /**
31      * Returns an object populated by the list's filter-form,
32      * or <code>null</code> if the list does not have a filter.
33      */
34     public Object JavaDoc getFilter();
35
36     /**
37      * Returns the names of all properties bound to the filter-form,
38      * or <code>null</code> if the list does not have a filter.
39      * @since 6.4
40      */
41     public String JavaDoc[] getFilteredProperties();
42     
43     /**
44      * Returns the String that should be used to perform a full-text search,
45      * or <code>null</code> if no search should be performed.
46      * @since 6.4
47      */
48     public String JavaDoc getSearch();
49     
50     /**
51      * Returns the name of all properties that should be included in the
52      * full-text search, or <code>null</code> if searching is disabled.
53      * @since 6.4
54      */
55     public String JavaDoc[] getSearchProperties();
56     
57     /**
58      * Returns whether sort-order was specified.
59      */
60     public boolean hasOrder();
61
62     /**
63      * Returns a list of {@link Order} objects that should be used to sort
64      * the list.
65      */
66     public List JavaDoc getOrder();
67
68     /**
69      * Returns the maximum number of objects that should be displayed on
70      * a page.
71      */
72     public int getPageSize();
73
74     /**
75      * Returns the offset (starting at 0) of the first object that should be
76      * displayed.
77      */
78     public int getOffset();
79
80 }
Popular Tags