Source for file ResultMetaDataIterator.php

Documentation is available at ResultMetaDataIterator.php

  1. <?php
  2. /**
  3. * ResultMetaDataIterator provides access to these objects sequentially, one at
  4. * a time. The purpose of all Iterators is to to offer a way for OSID methods
  5. * to return multiple values of a common type and not use an array. Returning
  6. * an array may not be appropriate if the number of values returned is large
  7. * or 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.sql
  22. */
  23. class ResultMetaDataIterator
  24. {
  25. /**
  26. * Return true if there is an additional ResultMetaData ; false otherwise.
  27. *
  28. * @return boolean
  29. *
  30. * @throws object SqlException An exception with one of the following
  31. * messages defined in org.osid.sql.SqlException may be thrown:
  32. * {@link org.osid.sql.SqlException#OPERATION_FAILED}
  33. * OPERATION_FAILED}, {@link }
  34. * org.osid.sql.SqlException#PERMISSION_DENIED PERMISSION_DENIED},
  35. * {@link org.osid.sql.SqlException#CONFIGURATION_ERROR}
  36. * CONFIGURATION_ERROR}, {@link }
  37. * org.osid.sql.SqlException#UNIMPLEMENTED UNIMPLEMENTED}
  38. *
  39. * @access public
  40. */
  41. function hasNextResultMetaData () {
  42. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  43. }
  44.  
  45. /**
  46. * return the next Row.
  47. *
  48. * @return object ResultMetaData
  49. *
  50. * @throws object SqlException An exception with one of the following
  51. * messages defined in org.osid.sql.SqlException may be thrown:
  52. * {@link org.osid.sql.SqlException#OPERATION_FAILED}
  53. * OPERATION_FAILED}, {@link }
  54. * org.osid.sql.SqlException#PERMISSION_DENIED PERMISSION_DENIED},
  55. * {@link org.osid.sql.SqlException#CONFIGURATION_ERROR}
  56. * CONFIGURATION_ERROR}, {@link }
  57. * org.osid.sql.SqlException#UNIMPLEMENTED UNIMPLEMENTED}
  58. *
  59. * @access public
  60. */
  61. function nextResultMetaData () {
  62. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  63. }
  64. }
  65.  
  66. ?>

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