Source for file HarmoniTraversalInfoIterator.class.php

Documentation is available at HarmoniTraversalInfoIterator.class.php

  1. <?php
  2.  
  3. require_once(OKI2."/osid/hierarchy/TraversalInfoIterator.php");
  4. require_once(HARMONI."oki2/shared/HarmoniIterator.class.php");
  5.  
  6. /**
  7. * TraversalInfoIterator 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. *
  21. * @package harmoni.osid_v2.hierarchy
  22. *
  23. * @copyright Copyright &copy; 2005, Middlebury College
  24. * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
  25. *
  26. * @version $Id: HarmoniTraversalInfoIterator.class.php,v 1.8 2007/09/04 20:25:41 adamfranco Exp $
  27. */
  28. class HarmoniTraversalInfoIterator
  29. extends HarmoniIterator
  30. // implements TraversalInfoIterator
  31.  
  32. {
  33.  
  34. /**
  35. * Return true if there is an additional TraversalInfo ; false otherwise.
  36. *
  37. * @return boolean
  38. *
  39. * @throws object HierarchyException An exception with one of
  40. * the following messages defined in
  41. * org.osid.hierarchy.HierarchyException may be thrown: {@link }
  42. * org.osid.hierarchy.HierarchyException#OPERATION_FAILED
  43. * OPERATION_FAILED}, {@link }
  44. * org.osid.hierarchy.HierarchyException#PERMISSION_DENIED
  45. * PERMISSION_DENIED}, {@link }
  46. * org.osid.hierarchy.HierarchyException#CONFIGURATION_ERROR
  47. * CONFIGURATION_ERROR}, {@link }
  48. * org.osid.hierarchy.HierarchyException#UNIMPLEMENTED
  49. * UNIMPLEMENTED}
  50. *
  51. * @access public
  52. */
  53. function hasNextTraversalInfo () {
  54. return $this->hasNext();
  55. }
  56.  
  57. /**
  58. * Return the next TraversalInfo.
  59. *
  60. * @return object TraversalInfo
  61. *
  62. * @throws object HierarchyException An exception with one of
  63. * the following messages defined in
  64. * org.osid.hierarchy.HierarchyException may be thrown: {@link }
  65. * org.osid.hierarchy.HierarchyException#OPERATION_FAILED
  66. * OPERATION_FAILED}, {@link }
  67. * org.osid.hierarchy.HierarchyException#PERMISSION_DENIED
  68. * PERMISSION_DENIED}, {@link }
  69. * org.osid.hierarchy.HierarchyException#CONFIGURATION_ERROR
  70. * CONFIGURATION_ERROR}, {@link }
  71. * org.osid.hierarchy.HierarchyException#UNIMPLEMENTED
  72. * UNIMPLEMENTED}, {@link }
  73. * org.osid.hierarchy.HierarchyException#NO_MORE_ITERATOR_ELEMENTS
  74. * NO_MORE_ITERATOR_ELEMENTS}
  75. *
  76. * @access public
  77. */
  78. function nextTraversalInfo () {
  79. return $this->next();
  80. }
  81. }
  82.  
  83. ?>

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