1 /** 2 * This file Copyright (c) 2003-2011 Magnolia International 3 * Ltd. (http://www.magnolia-cms.com). All rights reserved. 4 * 5 * 6 * This file is dual-licensed under both the Magnolia 7 * Network Agreement and the GNU General Public License. 8 * You may elect to use one or the other of these licenses. 9 * 10 * This file is distributed in the hope that it will be 11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the 12 * implied warranty of MERCHANTABILITY or FITNESS FOR A 13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT. 14 * Redistribution, except as permitted by whichever of the GPL 15 * or MNA you select, is prohibited. 16 * 17 * 1. For the GPL license (GPL), you can redistribute and/or 18 * modify this file under the terms of the GNU General 19 * Public License, Version 3, as published by the Free Software 20 * Foundation. You should have received a copy of the GNU 21 * General Public License, Version 3 along with this program; 22 * if not, write to the Free Software Foundation, Inc., 51 23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 24 * 25 * 2. For the Magnolia Network Agreement (MNA), this file 26 * and the accompanying materials are made available under the 27 * terms of the MNA which accompanies this distribution, and 28 * is available at http://www.magnolia-cms.com/mna.html 29 * 30 * Any modifications to this file must keep this entire header 31 * intact. 32 * 33 */ 34 package info.magnolia.cms.gui.controlx.list; 35 36 import java.util.Iterator; 37 38 /** 39 * @author Sameer Charles $Id: ListModel.java 41135 2011-01-06 18:12:01Z gjoseph $ 40 */ 41 public interface ListModel { // extends Iterable { // jdl 1.5! 42 43 /** 44 * implement Iterable 45 * @return iterator 46 */ 47 public Iterator iterator(); 48 49 /** 50 * Return the list model iterator 51 * @return 52 */ 53 public ListModelIterator getListModelIterator(); 54 55 /** 56 * set sort on field name 57 * @param name 58 */ 59 public void setSortBy(String name); 60 61 /** 62 * set sort on field name 63 * @param name 64 * @param order 65 */ 66 public void setSortBy(String name, String order); 67 68 /** 69 * set group on field name 70 * @param name 71 */ 72 public void setGroupBy(String name); 73 74 /** 75 * set group on field name 76 * @param name 77 * @param order 78 */ 79 public void setGroupBy(String name, String order); 80 81 /** 82 * get sort on field name 83 * @return String field name 84 */ 85 public String getSortBy(); 86 87 /** 88 * get sort by ordering 89 * @return order ('ASCENDING' | 'DESCENDING') 90 */ 91 public String getSortByOrder(); 92 93 /** 94 * get group on field name 95 * @return String field name 96 */ 97 public String getGroupBy(); 98 99 /** 100 * get group by ordering 101 * @return order ('ASCENDING' | 'DESCENDING') 102 */ 103 public String getGroupByOrder(); 104 105 }