Files
alfresco-community-repo/source/java/org/alfresco/web/data/IDataContainer.java
Raluca Munteanu d6f9f50c39 Merged 5.1.N (5.1.2) to 5.2.N (5.2.1)
125603 rmunteanu: Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)
      125484 slanglois: MNT-16155 Update source headers - remove old Copyrights from Java and JSP dource files


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@125781 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2016-04-26 12:48:49 +00:00

75 lines
2.0 KiB
Java

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";
}