Source for file ScheduleItemIterator.php

Documentation is available at ScheduleItemIterator.php

  1. <?php
  2. /**
  3. * ScheduleItemIterator provides access to these objects sequentially, one at a
  4. * time. The purpose of all Iterators is to to offer a way for OSID methods
  5. * to return multiple values of a common type and not use an array. Returning
  6. * an array may not be appropriate if the number of values returned is large
  7. * or is fetched remotely. Iterators do not allow access to values by index,
  8. * rather you must access values in sequence. Similarly, there is no way to go
  9. * backwards through the sequence unless you place the values in a data
  10. * 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.scheduling
  22. */
  23. class ScheduleItemIterator
  24. {
  25. /**
  26. * Return true if there is an additional ScheduleItem ; false otherwise.
  27. *
  28. * @return boolean
  29. *
  30. * @throws object SchedulingException An exception with one of
  31. * the following messages defined in
  32. * org.osid.scheduling.SchedulingException may be thrown: {@link }
  33. * org.osid.scheduling.SchedulingException#OPERATION_FAILED
  34. * OPERATION_FAILED}, {@link }
  35. * org.osid.scheduling.SchedulingException#PERMISSION_DENIED
  36. * PERMISSION_DENIED}, {@link }
  37. * org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
  38. * CONFIGURATION_ERROR}, {@link }
  39. * org.osid.scheduling.SchedulingException#UNIMPLEMENTED
  40. * UNIMPLEMENTED}
  41. *
  42. * @access public
  43. */
  44. function hasNextScheduleItem () {
  45. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  46. }
  47.  
  48. /**
  49. * Return the next ScheduleItem.
  50. *
  51. * @return object ScheduleItem
  52. *
  53. * @throws object SchedulingException An exception with one of
  54. * the following messages defined in
  55. * org.osid.scheduling.SchedulingException may be thrown: {@link }
  56. * org.osid.scheduling.SchedulingException#OPERATION_FAILED
  57. * OPERATION_FAILED}, {@link }
  58. * org.osid.scheduling.SchedulingException#PERMISSION_DENIED
  59. * PERMISSION_DENIED}, {@link }
  60. * org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
  61. * CONFIGURATION_ERROR}, {@link }
  62. * org.osid.scheduling.SchedulingException#UNIMPLEMENTED
  63. * UNIMPLEMENTED}, {@link }
  64. * org.osid.scheduling.SchedulingException#NO_MORE_ITERATOR_ELEMENTS
  65. * NO_MORE_ITERATOR_ELEMENTS}
  66. *
  67. * @access public
  68. */
  69. function nextScheduleItem () {
  70. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  71. }
  72. }
  73.  
  74. ?>

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