Source for file HarmoniGradableObjectIterator.class.php

Documentation is available at HarmoniGradableObjectIterator.class.php

  1. <?php
  2.  
  3. require_once(OKI2."/osid/grading/GradableObjectIterator.php");
  4. require_once(HARMONI."oki2/shared/HarmoniIterator.class.php");
  5.  
  6. /**
  7. * GradableObjectIterator provides access to these objects sequentially, one at
  8. * a 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. * <p>
  21. * Licensed under the {@link org.osid.SidImplementationLicenseMIT MIT}
  22. * O.K.I&#46; OSID Definition License}.
  23. * </p>
  24. *
  25. * @package org.osid.grading
  26. */
  27. class HarmoniGradableObjectIterator
  28. extends HarmoniIterator
  29. {
  30. /**
  31. * Return true if there is an additional GradableObject ; false otherwise.
  32. *
  33. * @return boolean
  34. *
  35. * @throws object GradingException An exception with one of the
  36. * following messages defined in org.osid.grading.GradingException
  37. * may be thrown: {@link }
  38. * org.osid.grading.GradingException#OPERATION_FAILED
  39. * OPERATION_FAILED}, {@link }
  40. * org.osid.grading.GradingException#PERMISSION_DENIED
  41. * PERMISSION_DENIED}, {@link }
  42. * org.osid.grading.GradingException#CONFIGURATION_ERROR
  43. * CONFIGURATION_ERROR}, {@link }
  44. * org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED}
  45. *
  46. * @access public
  47. */
  48. function hasNextGradableObject () {
  49. return $this->hasNext();
  50. }
  51.  
  52. /**
  53. * Return the next GradableObject.
  54. *
  55. * @return object GradableObject
  56. *
  57. * @throws object GradingException An exception with one of the
  58. * following messages defined in org.osid.grading.GradingException
  59. * may be thrown: {@link }
  60. * org.osid.grading.GradingException#OPERATION_FAILED
  61. * OPERATION_FAILED}, {@link }
  62. * org.osid.grading.GradingException#PERMISSION_DENIED
  63. * PERMISSION_DENIED}, {@link }
  64. * org.osid.grading.GradingException#CONFIGURATION_ERROR
  65. * CONFIGURATION_ERROR}, {@link }
  66. * org.osid.grading.GradingException#UNIMPLEMENTED UNIMPLEMENTED},
  67. * {@link }
  68. * org.osid.grading.GradingException#NO_MORE_ITERATOR_ELEMENTS
  69. * NO_MORE_ITERATOR_ELEMENTS}
  70. *
  71. * @access public
  72. */
  73. function nextGradableObject () {
  74. return $this->next();
  75. }
  76. }
  77.  
  78. ?>

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