Results are now searchable and iterateable, insertDataSet renamed to queryInsertDataS...

[shipsimu.git] / inc / classes / interfaces / database / frontend / class_DatabaseFrontendInterface.php

diff --git a/inc/classes/interfaces/database/frontend/class_DatabaseFrontendInterface.php b/inc/classes/interfaces/database/frontend/class_DatabaseFrontendInterface.php
index 839ba634c1a87abc28420415d0a29d1b5a1857d8..0bdf820adfffe262929e4368be80cc9aeccf3016 100644 (file)
--- a/inc/classes/interfaces/database/frontend/class_DatabaseFrontendInterface.php
+++ b/inc/classes/interfaces/database/frontend/class_DatabaseFrontendInterface.php
@@ -7,9 +7,10 @@
  * compressed before they got saved to a local file.
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
- * @version            0.0
+ * @version            0.0.0
  * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
  * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.ship-simu.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
@@ -33,8 +34,38 @@ interface DatabaseFrontendInterface extends FrameworkDatabaseInterface {
         *
         * @return      Object  The fully re-created object or instance to
         *                                      ObjectContainer
+        * @deprecated
         */
        function loadObject ();
+
+       /**
+        * Makes sure that the database connection is up and alive
+        *
+        * @return      void
+        */
+       function connectToDatabase ();
+
+       /**
+        * Starts a SELECT query on the database by given return type, table name
+        * and search criteria
+        *
+        * @param       $resultType             Result type ("array", "object" and "indexed" are valid)
+        * @param       $tableName              Name of the database table
+        * @param       $criteria               Search criteria class
+        * @return      $resultData             Result data of the query
+        * @throws      UnsupportedCriteriaException    If the criteria is unsupported
+        * @throws      SqlException                                    If an SQL error occurs
+        */
+       function querySelect ($resultType, $tableName, LocalSearchCriteria $criteriaInstance);
+
+       /**
+        * "Inserts" a data set instance into a local file database folder
+        *
+        * @param       $dataSetInstance        A storeable data set
+        * @return      void
+        * @throws      SqlException    If an SQL error occurs
+        */
+       function queryInsertDataSet (StoreableCriteria $dataSetInstance);
 }
 
 // [EOF]