Source for file GenericQueryResult.interface.php

Documentation is available at GenericQueryResult.interface.php

  1. <?php
  2. /**
  3. * @package harmoni.dbc
  4. *
  5. * @copyright Copyright &copy; 2005, Middlebury College
  6. * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
  7. *
  8. * @version $Id: GenericQueryResult.interface.php,v 1.6 2007/09/05 21:38:59 adamfranco Exp $
  9. */
  10. require_once("QueryResult.interface.php");
  11.  
  12.  
  13. /**
  14. * The GenericQueryResult interface provides methods for accessing the results of
  15. * a generic query. These results can be returned as if they were one of the other
  16. * query types, or the resource links can be returned and accessed directly.
  17. *
  18. *
  19. * @package harmoni.dbc
  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: GenericQueryResult.interface.php,v 1.6 2007/09/05 21:38:59 adamfranco Exp $
  25. */
  26.  
  27. interface GenericQueryResultInterface
  28. extends QueryResultInterface
  29. {
  30.  
  31. /**
  32. * Returns the resource id for this SELECT query.
  33. * Returns the resource id for this SELECT query. The resource id is returned
  34. * by the mysql_query() function.
  35. * @access public
  36. * @return integer The resource id for this SELECT query.
  37. ***/
  38. function getResourceId();
  39. /**
  40. /**
  41. * Returns the result of the query as a SelectQueryResult.
  42. *
  43. * @return object SelectQueryResult
  44. * @access public
  45. * @since 7/1/04
  46. */
  47. function returnAsSelectQueryResult ();
  48. /**
  49. /**
  50. * Returns the result of the query as an InsertQueryResult.
  51. *
  52. * @return object InsertQueryResult
  53. * @access public
  54. * @since 7/1/04
  55. */
  56. function returnAsInsertQueryResult ();
  57. /**
  58. /**
  59. * Returns the result of the query as a UpdateQueryResult.
  60. *
  61. * @return object UpdateQueryResult
  62. * @access public
  63. * @since 7/1/04
  64. */
  65. function returnAsUpdateQueryResult ();
  66. /**
  67. /**
  68. * Returns the result of the query as a DeleteQueryResult.
  69. *
  70. * @return object DeleteQueryResult
  71. * @access public
  72. * @since 7/1/04
  73. */
  74. function returnAsDeleteQueryResult ();
  75.  
  76.  
  77. ?>

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