Source for file CourseGroupIterator.class.php

Documentation is available at CourseGroupIterator.class.php

  1. <?php
  2.  
  3. require_once(OKI2."/osid/coursemanagement/CourseGroupIterator.php");
  4. require_once(HARMONI."oki2/shared/HarmoniIterator.class.php");
  5. /**
  6. * CourseGroupIterator provides access to CourseGroups. CourseGroup provides
  7. * access to these objects sequentially, one at a time. The purpose of all
  8. * Iterators is to to offer a way for OSID methods to return multiple values
  9. * of a common type and not use an array. Returning an array may not be
  10. * appropriate if the number of values returned is large or is fetched
  11. * remotely. Iterators do not allow access to values by index, rather you
  12. * must access values in sequence. Similarly, there is no way to go backwards
  13. * through the sequence unless you place the values in a data structure, such
  14. * as an array, that allows for access by index.
  15. *
  16. * <p>
  17. * OSID Version: 2.0
  18. * </p>
  19. *
  20. * @package harmoni.osid_v2.coursemanagement
  21. *
  22. * @copyright Copyright &copy; 2005, Middlebury College
  23. * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
  24. *
  25. * @version $Id: CourseGroupIterator.class.php,v 1.5 2007/09/04 20:25:39 adamfranco Exp $
  26. */
  27. class HarmoniCourseGroupIterator
  28. extends HarmoniIterator
  29. // implements CourseGroupIterator
  30.  
  31. {
  32. /**
  33. * Return true if there is an additional CourseGroup ; false otherwise.
  34. *
  35. * @return boolean
  36. *
  37. * @throws object CourseManagementException An exception
  38. * with one of the following messages defined in
  39. * org.osid.coursemanagement.CourseManagementException may be
  40. * thrown: {@link }
  41. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  42. * OPERATION_FAILED}, {@link }
  43. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  44. * PERMISSION_DENIED}, {@link }
  45. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  46. * CONFIGURATION_ERROR}, {@link }
  47. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  48. * UNIMPLEMENTED}
  49. *
  50. * @access public
  51. */
  52. function hasNextCourseGroup () {
  53. return $this->hasNext();
  54. }
  55.  
  56. /**
  57. * Return the next CourseGroup.
  58. *
  59. * @return object CourseGroup
  60. *
  61. * @throws object CourseManagementException An exception
  62. * with one of the following messages defined in
  63. * org.osid.coursemanagement.CourseManagementException may be
  64. * thrown: {@link }
  65. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  66. * OPERATION_FAILED}, {@link }
  67. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  68. * PERMISSION_DENIED}, {@link }
  69. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  70. * CONFIGURATION_ERROR}, {@link }
  71. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  72. * UNIMPLEMENTED}, {@link }
  73. * org.osid.coursemanagement.CourseManagementException#NO_MORE_ITERATOR_ELEMENTS
  74. * NO_MORE_ITERATOR_ELEMENTS}
  75. *
  76. * @access public
  77. */
  78. function nextCourseGroup () {
  79. return $this->next();
  80. }
  81. }
  82.  
  83. ?>

Documentation generated on Wed, 19 Sep 2007 10:22:14 -0400 by phpDocumentor 1.3.0RC3