mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-07 17:49:17 +00:00
60c08702d5
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@18963 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
93 lines
2.7 KiB
Java
93 lines
2.7 KiB
Java
/*
|
|
* Copyright (C) 2005-2010 Alfresco Software Limited.
|
|
*
|
|
* This file is part of Alfresco
|
|
*
|
|
* Alfresco is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Alfresco is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
package org.alfresco.web.data;
|
|
|
|
/**
|
|
* @author kevinr
|
|
*/
|
|
public interface IDataContainer
|
|
{
|
|
/**
|
|
* Return the currently sorted column if any
|
|
*
|
|
* @return current sorted column if any
|
|
*/
|
|
public String getCurrentSortColumn();
|
|
|
|
/**
|
|
* Returns the current sort direction. Only valid if a sort column is set.
|
|
* True is returned for descending sort, false for accending sort.
|
|
*
|
|
* @return true for descending sort, false for accending sort
|
|
*/
|
|
public boolean isCurrentSortDescending();
|
|
|
|
/**
|
|
* Returns the current page size used for this list, or -1 for no paging.
|
|
*/
|
|
public int getPageSize();
|
|
|
|
/**
|
|
* Return the current page the list is displaying
|
|
*
|
|
* @return Current page with zero based index
|
|
*/
|
|
public int getCurrentPage();
|
|
|
|
/**
|
|
* Set the current page to display.
|
|
*
|
|
* @param index Zero based page index to display
|
|
*/
|
|
public void setCurrentPage(int index);
|
|
|
|
/**
|
|
* Return the count of max available pages
|
|
*
|
|
* @return count of max available pages
|
|
*/
|
|
public int getPageCount();
|
|
|
|
/**
|
|
* Returns true if a row of data is available
|
|
*
|
|
* @return true if data is available, false otherwise
|
|
*/
|
|
public boolean isDataAvailable();
|
|
|
|
/**
|
|
* Returns the next row of data from the data model
|
|
*
|
|
* @return next row of data as a Bean object
|
|
*/
|
|
public Object nextRow();
|
|
|
|
/**
|
|
* Sort the dataset using the specified sort parameters
|
|
*
|
|
* @param column Column to sort
|
|
* @param descending True for descending sort, false for ascending
|
|
* @param mode Sort mode to use (see IDataContainer constants)
|
|
*/
|
|
public void sort(String column, boolean descending, String mode);
|
|
|
|
public final static String SORT_CASEINSENSITIVE = "case-insensitive";
|
|
public final static String SORT_CASESENSITIVE = "case-sensitive";
|
|
}
|