Source for file CourseGradeRecordIterator.class.php

Documentation is available at CourseGradeRecordIterator.class.php

  1. <?php
  2.  
  3. require_once(OKI2."/osid/coursemanagement/CourseGradeRecordIterator.php");
  4. require_once(HARMONI."oki2/shared/HarmoniIterator.class.php");
  5. /**
  6. * CourseGradeRecordIterator provides access to CourseGradeRecords.
  7. * CourseGradeRecord provides access to these objects sequentially, one at a
  8. * time. The purpose of all Iterators is to to offer a way for OSID methods
  9. * to return multiple values of a common type and not use an array. Returning
  10. * an array may not be appropriate if the number of values returned is large
  11. * or is fetched remotely. Iterators do not allow access to values by index,
  12. * rather you must access values in sequence. Similarly, there is no way to go
  13. * backwards through the sequence unless you place the values in a data
  14. * structure, such 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: CourseGradeRecordIterator.class.php,v 1.5 2007/09/04 20:25:39 adamfranco Exp $
  26. */
  27. class HarmoniCourseGradeRecordIterator
  28. extends HarmoniIterator
  29. // implements CourseGradeRecordIterator
  30.  
  31. {
  32. /**
  33. * Return true if there is an additional CourseGradeRecord ; false
  34. * otherwise.
  35. *
  36. * @return boolean
  37. *
  38. * @throws object CourseManagementException An exception
  39. * with one of the following messages defined in
  40. * org.osid.coursemanagement.CourseManagementException may be
  41. * thrown: {@link }
  42. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  43. * OPERATION_FAILED}, {@link }
  44. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  45. * PERMISSION_DENIED}, {@link }
  46. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  47. * CONFIGURATION_ERROR}, {@link }
  48. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  49. * UNIMPLEMENTED}
  50. *
  51. * @access public
  52. */
  53. function hasNextCourseGradeRecord () {
  54. return $this->hasNext();
  55. }
  56.  
  57. /**
  58. * Return the next CourseGradeRecord.
  59. *
  60. * @return object CourseGradeRecord
  61. *
  62. * @throws object CourseManagementException An exception
  63. * with one of the following messages defined in
  64. * org.osid.coursemanagement.CourseManagementException may be
  65. * thrown: {@link }
  66. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  67. * OPERATION_FAILED}, {@link }
  68. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  69. * PERMISSION_DENIED}, {@link }
  70. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  71. * CONFIGURATION_ERROR}, {@link }
  72. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  73. * UNIMPLEMENTED}, {@link }
  74. * org.osid.coursemanagement.CourseManagementException#NO_MORE_ITERATOR_ELEMENTS
  75. * NO_MORE_ITERATOR_ELEMENTS}
  76. *
  77. * @access public
  78. */
  79. function nextCourseGradeRecord () {
  80. return $this->next();
  81. }
  82. }
  83.  
  84. ?>

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