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 /** 40 * @author Sameer Charles $Id:ListModelIterator.java 2544 2006-04-04 12:47:32Z philipp $ 41 */ 42 public interface ListModelIterator extends Iterator { 43 44 /** 45 * get named value 46 * @param name its a key to which value is attached in this record 47 */ 48 public Object getValue(String name); 49 50 /** 51 * The current object representing a row. Can be of any type. 52 * @return the object. 53 */ 54 public Object getValueObject(); 55 56 /** 57 * get group name 58 * @return name of the group of the current record 59 */ 60 public String getGroupName(); 61 62 /** 63 * jump to next group 64 */ 65 public Object nextGroup(); 66 67 /** 68 * checks if there are more records in the current group 69 * @return true if not EOF 70 */ 71 public boolean hasNextInGroup(); 72 73 /** 74 * An id to identify the current row 75 */ 76 public String getId(); 77 78 }