Source for file EntryIterator.php

Documentation is available at EntryIterator.php

  1. <?php
  2. /**
  3. * EntryIterator provides access to these objects sequentially, one at a time.
  4. * The purpose of all Iterators is to to offer a way for OSID methods to
  5. * return multiple values of a common type and not use an array. Returning an
  6. * array may not be appropriate if the number of values returned is large or
  7. * is fetched remotely. Iterators do not allow access to values by index,
  8. * rather you must access values in sequence. Similarly, there is no way to go
  9. * backwards through the sequence unless you place the values in a data
  10. * structure, such as an array, that allows for access by index.
  11. *
  12. * <p>
  13. * OSID Version: 2.0
  14. * </p>
  15. *
  16. * <p>
  17. * Licensed under the {@link org.osid.SidImplementationLicenseMIT MIT}
  18. * O.K.I&#46; OSID Definition License}.
  19. * </p>
  20. *
  21. * @package org.osid.logging
  22. */
  23. class EntryIterator
  24. {
  25. /**
  26. * Return true if there is an additional Entry
  27. * Description_IteratorHasNext2]
  28. *
  29. * @return boolean
  30. *
  31. * @throws object LoggingException An exception with one of the
  32. * following messages defined in org.osid.logging.LoggingException
  33. * may be thrown: {@link }
  34. * org.osid.logging.LoggingException#UNIMPLEMENTED UNIMPLEMENTED},
  35. * {@link org.osid.logging.LoggingException#OPERATION_FAILED}
  36. * OPERATION_FAILED}, {@link }
  37. * org.osid.logging.LoggingException#CONFIGURATION_ERROR
  38. * CONFIGURATION_ERROR}, {@link }
  39. * org.osid.logging.LoggingException#PERMISSION_DENIED
  40. * PERMISSION_DENIED}
  41. *
  42. * @access public
  43. */
  44. function hasNextEntry () {
  45. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  46. }
  47.  
  48. /**
  49. * Return the next Entry.
  50. *
  51. * @return object Entry
  52. *
  53. * @throws object LoggingException An exception with one of the
  54. * following messages defined in org.osid.logging.LoggingException
  55. * may be thrown: {@link }
  56. * org.osid.logging.LoggingException#UNIMPLEMENTED UNIMPLEMENTED},
  57. * {@link org.osid.logging.LoggingException#OPERATION_FAILED}
  58. * OPERATION_FAILED}, {@link }
  59. * org.osid.logging.LoggingException#CONFIGURATION_ERROR
  60. * CONFIGURATION_ERROR}, {@link }
  61. * org.osid.logging.LoggingException#PERMISSION_DENIED
  62. * PERMISSION_DENIED}, {@link }
  63. * org.osid.logging.LoggingException#NO_MORE_ITERATOR_ELEMENTS
  64. * NO_MORE_ITERATOR_ELEMENTS}
  65. *
  66. * @access public
  67. */
  68. function nextEntry () {
  69. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  70. }
  71. }
  72.  
  73. ?>

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