KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > mlw > vlh > PagingInfo


1 /**
2  * Copyright (c) 2003 held jointly by the individual authors.
3  *
4  * This library is free software; you can redistribute it and/or modify it
5  * under the terms of the GNU Lesser General Public License as published
6  * by the Free Software Foundation; either version 2.1 of the License, or
7  * (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; with out even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public License
15  * along with this library; if not, write to the Free Software Foundation,
16  * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
17  *
18  * > http://www.gnu.org/copyleft/lesser.html
19  * > http://www.opensource.org/licenses/lgpl-license.php
20  */

21 package net.mlw.vlh;
22
23 /**
24  * @author Matthew L. Wilson, Andrej Zachar
25  * @version $Revision: 1.6 $ $Date: 2006/03/29 19:47:49 $
26  */

27 public interface PagingInfo
28 {
29    /**
30     * Returns an array of column (property) names.
31     *
32     * @return a String array of column (property) names. null if no sorting
33     * information exists.
34     */

35    String JavaDoc getSortingColumn();
36
37    /**
38     * Returns an array of directions.
39     *
40     * @return an Integer array of directions. null if no sorting information
41     * exists.
42     */

43    Integer JavaDoc getSortingDirection();
44
45    /**
46     * Getter for the curent page to display.
47     *
48     * @return the curent page to display.
49     */

50    int getPagingPage();
51
52    /**
53     * Getter for the number of VOs per page. -1 if it is not set.
54     *
55     * @return the number of VOs per page.
56     */

57    int getPagingNumberPer();
58    
59    /**
60     * Getter for the total number VOs.
61     *
62     * @return the total number of VOs.
63     */

64    int getTotalNumberOfEntries();
65
66    /**
67     * Getter for the total number VOs.
68     *
69     * @return the total number of VOs.
70     */

71    int getTotalNumberOfPages();
72    
73    /**
74     * @return The property used for focusing.
75     */

76    String JavaDoc getFocusProperty();
77    
78      /**
79      * @return The value for focusing.
80      */

81     String JavaDoc getFocusValue();
82
83     /**
84      * Return true if the focusing is enabled.
85      * @return boolean
86      */

87     boolean isFocusEnabled();
88      
89     /**
90      * @return true if is set DoFocus true
91      */

92     boolean isDoFocus();
93      
94     /**
95      * Used for generating links, if any errors found, doFocus is set to false
96      * for next retrieving of the valueList.
97      * @return boolean
98      */

99     boolean isDoFocusAgain();
100
101     byte getFocusStatus();
102 }
Popular Tags