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 static final boolean SORT_ASCENDING = false; 025 static final boolean SORT_DESCENDING = true; 026 027 /** 028 * Method getSortColumn defines the column that the table should be sorted upon 029 * @return String the name of the sorting column or null if the table is not sorted 030 */ 031 String getSortColumn(); 032 033 /** 034 * Method getSortOrder defines the direction of the table sorting 035 * @return boolean the sorting order (see constants) 036 */ 037 boolean getSortOrder(); 038 039 /** 040 * Method setSortColumn updates the table sorting column and order 041 * @param strName the name of the column to sort by 042 * @param bOrder the sorting order (see constants) 043 */ 044 void setSortColumn(String strName, boolean bOrder); 045 }