Source for file CanonicalCourseIterator.php

Documentation is available at CanonicalCourseIterator.php

  1. <?php
  2. /**
  3. * CanonicalCourseIterator provides access to CanonicalCourses.
  4. * CanonicalCourse provides access to these objects sequentially, one at a
  5. * time. The purpose of all Iterators is to to offer a way for OSID methods
  6. * to return multiple values of a common type and not use an array. Returning
  7. * an array may not be appropriate if the number of values returned is large
  8. * or is fetched remotely. Iterators do not allow access to values by index,
  9. * rather you must access values in sequence. Similarly, there is no way to go
  10. * backwards through the sequence unless you place the values in a data
  11. * structure, such as an array, that allows for access by index.
  12. *
  13. * <p>
  14. * OSID Version: 2.0
  15. * </p>
  16. *
  17. * <p>
  18. * Licensed under the {@link org.osid.SidImplementationLicenseMIT MIT}
  19. * O.K.I&#46; OSID Definition License}.
  20. * </p>
  21. *
  22. * @package org.osid.coursemanagement
  23. */
  24. class CanonicalCourseIterator
  25. {
  26. /**
  27. * Return true if there is an additional CanonicalCourse ; false
  28. * otherwise.
  29. *
  30. * @return boolean
  31. *
  32. * @throws object CourseManagementException An exception
  33. * with one of the following messages defined in
  34. * org.osid.coursemanagement.CourseManagementException may be
  35. * thrown: {@link }
  36. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  37. * OPERATION_FAILED}, {@link }
  38. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  39. * PERMISSION_DENIED}, {@link }
  40. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  41. * CONFIGURATION_ERROR}, {@link }
  42. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  43. * UNIMPLEMENTED}
  44. *
  45. * @access public
  46. */
  47. function hasNextCanonicalCourse () {
  48. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  49. }
  50.  
  51. /**
  52. * Return the next CanonicalCourse.
  53. *
  54. * @return object CanonicalCourse
  55. *
  56. * @throws object CourseManagementException An exception
  57. * with one of the following messages defined in
  58. * org.osid.coursemanagement.CourseManagementException may be
  59. * thrown: {@link }
  60. * org.osid.coursemanagement.CourseManagementException#OPERATION_FAILED
  61. * OPERATION_FAILED}, {@link }
  62. * org.osid.coursemanagement.CourseManagementException#PERMISSION_DENIED
  63. * PERMISSION_DENIED}, {@link }
  64. * org.osid.coursemanagement.CourseManagementException#CONFIGURATION_ERROR
  65. * CONFIGURATION_ERROR}, {@link }
  66. * org.osid.coursemanagement.CourseManagementException#UNIMPLEMENTED
  67. * UNIMPLEMENTED}, {@link }
  68. * org.osid.coursemanagement.CourseManagementException#NO_MORE_ITERATOR_ELEMENTS
  69. * NO_MORE_ITERATOR_ELEMENTS}
  70. *
  71. * @access public
  72. */
  73. function nextCanonicalCourse () {
  74. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  75. }
  76. }
  77.  
  78. ?>

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