Source for file HarmoniHierarchyIterator.class.php

Documentation is available at HarmoniHierarchyIterator.class.php

  1. <?php
  2.  
  3. require_once(OKI2."/osid/hierarchy/HierarchyIterator.php");
  4. require_once(HARMONI."oki2/shared/HarmoniIterator.class.php");
  5.  
  6. /**
  7. * HierarchyIterator provides access to these objects sequentially, one at a
  8. * 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. * @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: HarmoniHierarchyIterator.class.php,v 1.8 2007/09/04 20:25:41 adamfranco Exp $
  26. */
  27. class HarmoniHierarchyIterator
  28. extends HarmoniIterator
  29. // implements HierarchyIterator
  30.  
  31. {
  32.  
  33. /**
  34. * Return true if there is an additional Hierarchy ; false otherwise.
  35. *
  36. * @return boolean
  37. *
  38. * @throws object HierarchyException An exception with one of
  39. * the following messages defined in
  40. * org.osid.hierarchy.HierarchyException may be thrown: {@link }
  41. * org.osid.hierarchy.HierarchyException#OPERATION_FAILED
  42. * OPERATION_FAILED}, {@link }
  43. * org.osid.hierarchy.HierarchyException#PERMISSION_DENIED
  44. * PERMISSION_DENIED}, {@link }
  45. * org.osid.hierarchy.HierarchyException#CONFIGURATION_ERROR
  46. * CONFIGURATION_ERROR}, {@link }
  47. * org.osid.hierarchy.HierarchyException#UNIMPLEMENTED
  48. * UNIMPLEMENTED}
  49. *
  50. * @access public
  51. */
  52. function hasNextHierarchy () {
  53. return $this->hasNext();
  54. }
  55.  
  56. /**
  57. * Return the next Hierarchy.
  58. *
  59. * @return object Hierarchy
  60. *
  61. * @throws object HierarchyException An exception with one of
  62. * the following messages defined in
  63. * org.osid.hierarchy.HierarchyException may be thrown: {@link }
  64. * org.osid.hierarchy.HierarchyException#OPERATION_FAILED
  65. * OPERATION_FAILED}, {@link }
  66. * org.osid.hierarchy.HierarchyException#PERMISSION_DENIED
  67. * PERMISSION_DENIED}, {@link }
  68. * org.osid.hierarchy.HierarchyException#CONFIGURATION_ERROR
  69. * CONFIGURATION_ERROR}, {@link }
  70. * org.osid.hierarchy.HierarchyException#UNIMPLEMENTED
  71. * UNIMPLEMENTED}, {@link }
  72. * org.osid.hierarchy.HierarchyException#NO_MORE_ITERATOR_ELEMENTS
  73. * NO_MORE_ITERATOR_ELEMENTS}
  74. *
  75. * @access public
  76. */
  77. function nextHierarchy () {
  78. return $this->next();
  79. }
  80. }
  81.  
  82. ?>

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