Moving to root below branch label

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@2005 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/web/data/IDataContainer.java

@@ -0,0 +1,90 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+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";
+}