Source for file ResultTable.php

Documentation is available at ResultTable.php

  1. <?php
  2. /**
  3. * A ResultTable is tabular data returned by a query. You access the returned
  4. * data by calling the method getRows() which returns a RowIterator.
  5. *
  6. * <p>
  7. * OSID Version: 2.0
  8. * </p>
  9. *
  10. * <p>
  11. * Licensed under the {@link org.osid.SidImplementationLicenseMIT MIT}
  12. * O.K.I&#46; OSID Definition License}.
  13. * </p>
  14. *
  15. * @package org.osid.sql
  16. */
  17. class ResultTable
  18. {
  19. /**
  20. * return the number of columns in this ResultTable.
  21. *
  22. * @return int
  23. *
  24. * @throws object SqlException An exception with one of the following
  25. * messages defined in org.osid.sql.SqlException may be thrown:
  26. * {@link org.osid.sql.SqlException#OPERATION_FAILED}
  27. * OPERATION_FAILED}, {@link }
  28. * org.osid.sql.SqlException#PERMISSION_DENIED PERMISSION_DENIED},
  29. * {@link org.osid.sql.SqlException#CONFIGURATION_ERROR}
  30. * CONFIGURATION_ERROR}, {@link }
  31. * org.osid.sql.SqlException#UNIMPLEMENTED UNIMPLEMENTED}
  32. *
  33. * @access public
  34. */
  35. function getColumnCount () {
  36. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  37. }
  38.  
  39. /**
  40. * return the columnar metadata of this ResultTable.
  41. *
  42. * @return object ResultMetaDataIterator
  43. *
  44. * @throws object SqlException An exception with one of the following
  45. * messages defined in org.osid.sql.SqlException may be thrown:
  46. * {@link org.osid.sql.SqlException#DATA_RETRIEVAL_ERROR}, {@link }
  47. * org.osid.sql.SqlException#OPERATION_FAILED OPERATION_FAILED},
  48. * {@link org.osid.sql.SqlException#PERMISSION_DENIED}
  49. * PERMISSION_DENIED}, {@link }
  50. * org.osid.sql.SqlException#CONFIGURATION_ERROR
  51. * CONFIGURATION_ERROR}, {@link }
  52. * org.osid.sql.SqlException#UNIMPLEMENTED UNIMPLEMENTED}
  53. *
  54. * @access public
  55. */
  56. function getResultMetaData () {
  57. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  58. }
  59.  
  60. /**
  61. * return the rows of this ResultTable.
  62. *
  63. * @return object RowIterator
  64. *
  65. * @throws object SqlException An exception with one of the following
  66. * messages defined in org.osid.sql.SqlException may be thrown:
  67. * {@link org.osid.sql.SqlException#DATA_RETRIEVAL_ERROR}, {@link }
  68. * org.osid.sql.SqlException#OPERATION_FAILED OPERATION_FAILED},
  69. * {@link org.osid.sql.SqlException#PERMISSION_DENIED}
  70. * PERMISSION_DENIED}, {@link }
  71. * org.osid.sql.SqlException#CONFIGURATION_ERROR
  72. * CONFIGURATION_ERROR}, {@link }
  73. * org.osid.sql.SqlException#UNIMPLEMENTED UNIMPLEMENTED}
  74. *
  75. * @access public
  76. */
  77. function getRows () {
  78. die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
  79. }
  80. }
  81.  
  82. ?>

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