Source for file HarmoniPropertiesIterator.class.php

Documentation is available at HarmoniPropertiesIterator.class.php

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

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