Source for file HarmoniPartStructureIterator.class.php

Documentation is available at HarmoniPartStructureIterator.class.php

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

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