Documentation is available at CourseGroupIterator.class.php
- <?php
- require_once(OKI2."/osid/coursemanagement/CourseGroupIterator.php");
- require_once(HARMONI."oki2/shared/HarmoniIterator.class.php");
- /**
- * CourseGroupIterator provides access to CourseGroups. CourseGroup provides
- * access to these objects sequentially, one at a time. The purpose of all
- * Iterators is to to offer a way for OSID methods to return multiple values
- * of a common type and not use an array. Returning an array may not be
- * appropriate if the number of values returned is large or is fetched
- * remotely. Iterators do not allow access to values by index, rather you
- * must access values in sequence. Similarly, there is no way to go backwards
- * through the sequence unless you place the values in a data structure, such
- * as an array, that allows for access by index.
- *
- * <p>
- * OSID Version: 2.0
- * </p>
- *
- * @package harmoni.osid_v2.coursemanagement
- *
- * @copyright Copyright © 2005, Middlebury College
- * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
- *
- * @version $Id: CourseGroupIterator.class.php,v 1.5 2007/09/04 20:25:39 adamfranco Exp $
- */
- class HarmoniCourseGroupIterator
- extends HarmoniIterator
- // implements CourseGroupIterator
- {
- /**
- * Return true if there is an additional CourseGroup ; false otherwise.
- *
- * @return boolean
- *
- * @throws object CourseManagementException An exception
- * with one of the following messages defined in
- * org.osid.coursemanagement.CourseManagementException may be
- * thrown: {@link }
- * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
- * OPERATION_FAILED}, {@link }
- * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
- * PERMISSION_DENIED}, {@link }
- * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
- * CONFIGURATION_ERROR}, {@link }
- * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
- * UNIMPLEMENTED}
- *
- * @access public
- */
- function hasNextCourseGroup () {
- return $this->hasNext();
- }
- /**
- * Return the next CourseGroup.
- *
- * @return object CourseGroup
- *
- * @throws object CourseManagementException An exception
- * with one of the following messages defined in
- * org.osid.coursemanagement.CourseManagementException may be
- * thrown: {@link }
- * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
- * OPERATION_FAILED}, {@link }
- * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
- * PERMISSION_DENIED}, {@link }
- * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
- * CONFIGURATION_ERROR}, {@link }
- * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
- * UNIMPLEMENTED}, {@link }
- * org.osid.coursemanagement.CourseManagementException#NO_MORE_ITERATOR_ELEMENTS
- * NO_MORE_ITERATOR_ELEMENTS}
- *
- * @access public
- */
- function nextCourseGroup () {
- return $this->next();
- }
- }
- ?>
Documentation generated on Wed, 19 Sep 2007 10:22:14 -0400 by phpDocumentor 1.3.0RC3