Source for file AssessmentPublishedIterator.php

Documentation is available at AssessmentPublishedIterator.php

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

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