Source for file HarmoniPartIterator.class.php

Documentation is available at HarmoniPartIterator.class.php

  1. <?php
  2. require_once(OKI2."osid/repository/PartIterator.php");
  3. require_once(HARMONI."oki2/shared/HarmoniIterator.class.php");
  4.  
  5. /**
  6. * PartIterator provides access to these objects sequentially, one at a time.
  7. * The purpose of all Iterators is to to offer a way for OSID methods to
  8. * return multiple values of a common type and not use an array. Returning an
  9. * array may not be appropriate if the number of values returned is large or
  10. * 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: HarmoniPartIterator.class.php,v 1.9 2007/09/04 20:25:43 adamfranco Exp $
  25. */
  26. class HarmoniPartIterator
  27. extends HarmoniIterator
  28. //implements PartIterator
  29.  
  30. {
  31.  
  32. /**
  33. * Return true if there is an additional Part ; false otherwise.
  34. *
  35. * @return boolean
  36. *
  37. * @throws object RepositoryException An exception with one of
  38. * the following messages defined in
  39. * org.osid.repository.RepositoryException may be thrown: {@link }
  40. * org.osid.repository.RepositoryException#OPERATION_FAILED
  41. * OPERATION_FAILED}, {@link }
  42. * org.osid.repository.RepositoryException#PERMISSION_DENIED
  43. * PERMISSION_DENIED}, {@link }
  44. * org.osid.repository.RepositoryException#CONFIGURATION_ERROR
  45. * CONFIGURATION_ERROR}, {@link }
  46. * org.osid.repository.RepositoryException#UNIMPLEMENTED
  47. * UNIMPLEMENTED}
  48. *
  49. * @access public
  50. */
  51. function hasNextPart () {
  52. return $this->hasNext();
  53. }
  54.  
  55. /**
  56. * Return the next Part.
  57. *
  58. * @return object Part
  59. *
  60. * @throws object RepositoryException An exception with one of
  61. * the following messages defined in
  62. * org.osid.repository.RepositoryException may be thrown: {@link }
  63. * org.osid.repository.RepositoryException#OPERATION_FAILED
  64. * OPERATION_FAILED}, {@link }
  65. * org.osid.repository.RepositoryException#PERMISSION_DENIED
  66. * PERMISSION_DENIED}, {@link }
  67. * org.osid.repository.RepositoryException#CONFIGURATION_ERROR
  68. * CONFIGURATION_ERROR}, {@link }
  69. * org.osid.repository.RepositoryException#UNIMPLEMENTED
  70. * UNIMPLEMENTED}, {@link }
  71. * org.osid.repository.RepositoryException#NO_MORE_ITERATOR_ELEMENTS
  72. * NO_MORE_ITERATOR_ELEMENTS}
  73. *
  74. * @access public
  75. */
  76. function nextPart () {
  77. return $this->next();
  78. }
  79.  
  80. }
  81.  
  82. ?>

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