From 3d3f8d3832921f99daf8ce1953304763c2e76c62 Mon Sep 17 00:00:00 2001
From: wei <>
Date: Fri, 14 Apr 2006 06:22:09 +0000
Subject: Importing SQLMap + sample + docs.

---
 .../SQLMap/Statements/IMappedStatement.php         | 71 ++++++++++++++++++++++
 1 file changed, 71 insertions(+)
 create mode 100644 framework/DataAccess/SQLMap/Statements/IMappedStatement.php

(limited to 'framework/DataAccess/SQLMap/Statements/IMappedStatement.php')

diff --git a/framework/DataAccess/SQLMap/Statements/IMappedStatement.php b/framework/DataAccess/SQLMap/Statements/IMappedStatement.php
new file mode 100644
index 00000000..6a4d76db
--- /dev/null
+++ b/framework/DataAccess/SQLMap/Statements/IMappedStatement.php
@@ -0,0 +1,71 @@
+<?php
+
+interface IMappedStatement
+{
+	/**
+	 * @return string Name used to identify the MappedStatement amongst the others.
+	 */
+	public function getID();
+
+	/**
+	 * @return TSqlMapStatement The SQL statment used by this TMappedStatement.
+	 */
+	public function getStatement();
+
+	/**
+	 * @return TSqlMap The TSqlMap used by this TMappedStatement
+	 */
+	public function getSqlMap();
+
+	/**
+	 * Executes the SQL and retuns all rows selected in a map that is keyed on 
+	 * the property named in the <tt>$keyProperty</tt> parameter.  The value at 
+	 * each key will be the value of the property specified  in the 
+	 * <tt>$valueProperty</tt> parameter.  If <tt>$valueProperty</tt> is 
+	 * <tt>null</tt>, the entire result object will be entered.
+	 * @param IDbConnection database connection to execute the query
+	 * @param mixed The object used to set the parameters in the SQL.
+	 * @param string The property of the result object to be used as the key.
+	 * @param string The property of the result object to be used as the value (or null)
+	 * @return TMap A map of object containing the rows keyed by <tt>$keyProperty</tt>.
+	 */
+	public function executeQueryForMap($connection, $parameter, 
+								$keyProperty, $valueProperty=null);
+
+
+	/**
+	 * Execute an update statement. Also used for delete statement. Return the 
+	 * number of row effected.
+	 * @param IDbConnection database connection to execute the query
+	 * @param mixed The object used to set the parameters in the SQL.
+	 * @return integer The number of row effected.
+	 */
+	public function executeUpdate($connection, $parameter);
+
+
+	/**
+	 * Executes the SQL and retuns a subset of the rows selected.
+	 * @param IDbConnection database connection to execute the query
+	 * @param mixed The object used to set the parameters in the SQL.
+	 * @param TList A list to populate the result with.
+	 * @param integer The number of rows to skip over.
+	 * @param integer The maximum number of rows to return.
+	 * @return TList A TList of result objects.
+	 */
+	public function executeQueryForList($connection,
+								$parameter, $result, $skip=-1, $max=-1);
+
+
+	/**
+	 * Executes an SQL statement that returns a single row as an object 
+	 * of the type of the <tt>$result</tt> passed in as a parameter.
+	 * @param IDbConnection database connection to execute the query
+	 * @param mixed The object used to set the parameters in the SQL.
+	 * @param object The result object.
+	 * @return object result.
+	 */
+	public function executeQueryForObject($connection,
+								$parameter, $result);
+}
+
+?>
\ No newline at end of file
-- 
cgit v1.2.3