3 * An interface for lists
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 interface Listable extends FrameworkInterface, IteratorAggregate {
26 * Checks wether the given group is set
28 * @param $groupName Group to check if found in list
29 * @return $isset Wether the group is valid
31 function isGroupSet ($groupName);
34 * Adds the given group or if already added issues a ListGroupAlreadyAddedException
36 * @param $groupName Group to add
38 * @throws ListGroupAlreadyAddedException If the given group is already added
40 function addGroup ($groupName);
43 * Adds the given instance to list group and sub group
45 * @param $groupName Group to add instance to
46 * @param $subGroup Sub group to add instance to
47 * @param $instance An instance of Visitable
49 * @throws NoListGroupException If the given group is not found
51 function addInstance ($groupName, $subGroup, Visitable $instance);
54 * Adds the given entry to list group
56 * @param $groupName Group to add instance to
57 * @param $entry An entry of any type
59 * @throws NoListGroupException If the given group is not found
61 function addEntry ($groupName, $entry);