Source for file HarmoniGradeRecordIterator.class.php

Documentation is available at HarmoniGradeRecordIterator.class.php

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

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