Source for file HarmoniTimespanIterator.class.php

Documentation is available at HarmoniTimespanIterator.class.php

  1. <?php
  2. require_once(OKI2."/osid/scheduling/TimespanIterator.php");
  3. require_once(HARMONI."oki2/shared/HarmoniIterator.class.php");
  4.  
  5. /**
  6. * TimespanIterator 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.scheduling
  25. */
  26. class HarmoniTimespanIterator
  27. extends HarmoniIterator
  28. {
  29. /**
  30. * Return true if there is an additional Timespan ; false otherwise.
  31. *
  32. * @return boolean
  33. *
  34. * @throws object SchedulingException An exception with one of
  35. * the following messages defined in
  36. * org.osid.scheduling.SchedulingException may be thrown: {@link }
  37. * org.osid.scheduling.SchedulingException#OPERATION_FAILED
  38. * OPERATION_FAILED}, {@link }
  39. * org.osid.scheduling.SchedulingException#PERMISSION_DENIED
  40. * PERMISSION_DENIED}, {@link }
  41. * org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
  42. * CONFIGURATION_ERROR}, {@link }
  43. * org.osid.scheduling.SchedulingException#UNIMPLEMENTED
  44. * UNIMPLEMENTED}
  45. *
  46. * @access public
  47. */
  48. function hasNextTimespan () {
  49. return $this->hasNext();
  50. }
  51.  
  52. /**
  53. * Return the next Timespan.
  54. *
  55. * @return object Timespan
  56. *
  57. * @throws object SchedulingException An exception with one of
  58. * the following messages defined in
  59. * org.osid.scheduling.SchedulingException may be thrown: {@link }
  60. * org.osid.scheduling.SchedulingException#OPERATION_FAILED
  61. * OPERATION_FAILED}, {@link }
  62. * org.osid.scheduling.SchedulingException#PERMISSION_DENIED
  63. * PERMISSION_DENIED}, {@link }
  64. * org.osid.scheduling.SchedulingException#CONFIGURATION_ERROR
  65. * CONFIGURATION_ERROR}, {@link }
  66. * org.osid.scheduling.SchedulingException#UNIMPLEMENTED
  67. * UNIMPLEMENTED}, {@link }
  68. * org.osid.scheduling.SchedulingException#NO_MORE_ITERATOR_ELEMENTS
  69. * NO_MORE_ITERATOR_ELEMENTS}
  70. *
  71. * @access public
  72. */
  73. function nextTimespan () {
  74. return $this->next();
  75. }
  76. }
  77.  
  78. ?>

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