Added new interfaces Handleable/-DataSet and ProtocolHandler (no content yet).

[core.git] / inc / classes / interfaces / database / class_DatabaseWrapper.php

diff --git a/inc/classes/interfaces/database/class_DatabaseWrapper.php b/inc/classes/interfaces/database/class_DatabaseWrapper.php
index c63b4bb01f7c92708ad2c16b5c656bb8a3de53b0..4488789bf8986fd061b55364e3e772423f49456a 100644 (file)
--- a/inc/classes/interfaces/database/class_DatabaseWrapper.php
+++ b/inc/classes/interfaces/database/class_DatabaseWrapper.php
@@ -2,11 +2,11 @@
 /**
  * The general interface for all other database wrappers
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @link               http://www.shipsimu.org
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -22,6 +22,45 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 interface DatabaseWrapper extends FrameworkInterface {
+       /**
+        * Getter for index key
+        *
+        * @return      $indexKey       Index key
+        */
+       function getIndexKey();
+
+       /**
+        * Getter for last exception
+        *
+        * @return      $lastException  Last exception or NULL if none occured
+        */
+       function getLastException();
+
+       /**
+        * Do a "select" query on the current table with the given search criteria and
+        * store it in cache for later usage
+        *
+        * @param       $criteriaInstance       An instance of a Criteria class
+        * @param       $onlyKeys                       Only use these keys for a cache key
+        * @return      $resultInstance         An instance of a database result class
+        */
+       function doSelectByCriteria(Criteria $criteriaInstance, array $onlyKeys = array());
+
+       /**
+        * Count the numbers of rows we shall receive
+        *
+        * @param       $criteriaInstance       An instance of a Criteria class
+        * @param       $onlyKeys                       Only use these keys for a cache key
+        * @return      $numRows                        Numbers of rows of database entries
+        */
+       function doSelectCountByCriteria(Criteria $criteriaInstance, $onlyKeys =  array());
+
+       /**
+        * Getter for primary key used in wrapped table
+        *
+        * @return      $primaryKey             Primary key used in wrapped table
+        */
+       function getPrimaryKeyValue();
 }
 
 // [EOF]