001    // Copyright 2004, 2005 The Apache Software Foundation
002    //
003    // Licensed under the Apache License, Version 2.0 (the "License");
004    // you may not use this file except in compliance with the License.
005    // You may obtain a copy of the License at
006    //
007    //     http://www.apache.org/licenses/LICENSE-2.0
008    //
009    // Unless required by applicable law or agreed to in writing, software
010    // distributed under the License is distributed on an "AS IS" BASIS,
011    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012    // See the License for the specific language governing permissions and
013    // limitations under the License.
014    
015    package org.apache.tapestry.contrib.table.model;
016    
017    import java.util.Iterator;
018    
019    /**
020     * A simplified version of the table model that concerns itself only with
021     * providing the data on the current page. 
022     * 
023     * @author mindbridge
024     * @since 3.0
025     */
026    public interface IBasicTableModel
027    {
028        /**
029         *  Returns the number of all records.
030         *  @return the number of all rows
031         **/
032        int getRowCount();
033    
034        /** 
035         *  Returns the rows on the current page.
036         *  @param nFirst the index of the first item to be dispayed
037         *  @param nPageSize the number of items to be displayed
038         *  @param objSortColumn the column to sort by or null if there is no sorting
039         *  @param bSortOrder determines the sorting order (ascending or descending)
040         **/
041        Iterator getCurrentPageRows(int nFirst, int nPageSize, ITableColumn objSortColumn, boolean bSortOrder);
042    }