/**
* An interface for lists
*
- * @author Roland Haeder <webmaster@ship-simu.org>
+ * @author Roland Haeder <webmaster@shipsimu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
* @license GNU GPL 3.0 or any newer version
- * @link http://www.ship-simu.org
+ * @link http://www.shipsimu.org
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
*/
interface Listable extends FrameworkInterface, IteratorAggregate {
/**
- * Checks wether the given group is set
+ * Checks whether the given group is set
*
* @param $groupName Group to check if found in list
- * @return $isset Wether the group is valid
+ * @return $isset Whether the group is valid
*/
function isGroupSet ($groupName);
/**
* Adds the given instance to list group and sub group
*
- * @param $groupName Group to add instance to
- * @param $subGroup Sub group to add instance to
- * @param $instance An instance of Visitable
+ * @param $groupName Group to add instance to
+ * @param $subGroup Sub group to add instance to
+ * @param $visitableInstance An instance of Visitable
* @return void
* @throws NoListGroupException If the given group is not found
*/
- function addInstance ($groupName, $subGroup, Visitable $instance);
+ function addInstance ($groupName, $subGroup, Visitable $visitableInstance);
/**
* Adds the given entry to list group
* @return $iteratorInstance An instance of a Iterator class
*/
function getListIterator ();
+
+ /**
+ * Clears this list (mostly by clearing all groups together)
+ *
+ * @return void
+ */
+ function clearList ();
}
// [EOF]