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    /**
018     * An interface defining the management of the table's sorting state.
019     * 
020     * @author mindbridge
021     */
022    public interface ITableSortingState
023    {
024    
025        boolean SORT_ASCENDING = false;
026        boolean SORT_DESCENDING = true;
027    
028        /**
029         * Method getSortColumn defines the column that the table should be sorted
030         * upon.
031         * 
032         * @return String the name of the sorting column or null if the table is not
033         *         sorted
034         */
035        String getSortColumn();
036    
037        /**
038         * Method getSortOrder defines the direction of the table sorting .
039         * 
040         * @return boolean the sorting order (see constants)
041         */
042        boolean getSortOrder();
043    
044        /**
045         * Method setSortColumn updates the table sorting column and order.
046         * 
047         * @param strName
048         *            the name of the column to sort by
049         * @param bOrder
050         *            the sorting order (see constants)
051         */
052        void setSortColumn(String strName, boolean bOrder);
053    }