Source for file HarmoniNodeIterator.class.php

Documentation is available at HarmoniNodeIterator.class.php

  1. <?php
  2.  
  3. require_once(OKI2."/osid/hierarchy/NodeIterator.php");
  4. require_once(HARMONI."oki2/shared/HarmoniIterator.class.php");
  5.  
  6. /**
  7. * NodeIterator provides access to these objects sequentially, one at a time.
  8. * The purpose of all Iterators is to to offer a way for OSID methods to
  9. * return multiple values of a common type and not use an array. Returning an
  10. * array may not be appropriate if the number of values returned is large or
  11. * 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. * @package harmoni.osid_v2.hierarchy
  21. *
  22. * @copyright Copyright &copy; 2005, Middlebury College
  23. * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
  24. *
  25. * @version $Id: HarmoniNodeIterator.class.php,v 1.7 2007/09/04 20:25:41 adamfranco Exp $
  26. */
  27. class HarmoniNodeIterator
  28. extends HarmoniIterator
  29. // implements NodeIterator
  30.  
  31. {
  32. /**
  33. * Return true if there is an additional Node ; false otherwise.
  34. *
  35. * @return boolean
  36. *
  37. * @throws object HierarchyException An exception with one of
  38. * the following messages defined in
  39. * org.osid.hierarchy.HierarchyException may be thrown: {@link }
  40. * org.osid.hierarchy.HierarchyException#OPERATION_FAILED
  41. * OPERATION_FAILED}, {@link }
  42. * org.osid.hierarchy.HierarchyException#PERMISSION_DENIED
  43. * PERMISSION_DENIED}, {@link }
  44. * org.osid.hierarchy.HierarchyException#CONFIGURATION_ERROR
  45. * CONFIGURATION_ERROR}, {@link }
  46. * org.osid.hierarchy.HierarchyException#UNIMPLEMENTED
  47. * UNIMPLEMENTED}
  48. *
  49. * @access public
  50. */
  51. function hasNextNode () {
  52. return $this->hasNext();
  53. }
  54.  
  55. /**
  56. * Return the next Node.
  57. *
  58. * @return object Node
  59. *
  60. * @throws object HierarchyException An exception with one of
  61. * the following messages defined in
  62. * org.osid.hierarchy.HierarchyException may be thrown: {@link }
  63. * org.osid.hierarchy.HierarchyException#OPERATION_FAILED
  64. * OPERATION_FAILED}, {@link }
  65. * org.osid.hierarchy.HierarchyException#PERMISSION_DENIED
  66. * PERMISSION_DENIED}, {@link }
  67. * org.osid.hierarchy.HierarchyException#CONFIGURATION_ERROR
  68. * CONFIGURATION_ERROR}, {@link }
  69. * org.osid.hierarchy.HierarchyException#UNIMPLEMENTED
  70. * UNIMPLEMENTED}, {@link }
  71. * org.osid.hierarchy.HierarchyException#NO_MORE_ITERATOR_ELEMENTS
  72. * NO_MORE_ITERATOR_ELEMENTS}
  73. *
  74. * @access public
  75. */
  76. function nextNode () {
  77. return $this->next();
  78. }
  79. }
  80.  
  81. ?>

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