3 * An interface for front-end database classes. The classes should prepare the
4 * objects for saving in the database. So for server-bases database classes SQL
5 * queries shall be generated and send to the backend classes. In case of local
6 * file databases the object shall be serialized and (maybe) transparently
7 * compressed before they got saved to a local file.
9 * @author Roland Haeder <webmaster@shipsimu.org>
11 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
12 * @license GNU GPL 3.0 or any newer version
13 * @link http://www.shipsimu.org
15 * This program is free software: you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License as published by
17 * the Free Software Foundation, either version 3 of the License, or
18 * (at your option) any later version.
20 * This program is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
25 * You should have received a copy of the GNU General Public License
26 * along with this program. If not, see <http://www.gnu.org/licenses/>.
28 interface DatabaseBackendInterface extends FrameworkDatabaseInterface {
30 * Makes sure that the database connection is up and alive
34 function connectToDatabase ();
37 * Starts a SELECT query on the database by given return type, table name
40 * @param $tableName Name of the database table
41 * @param $criteria Search criteria class
42 * @return $resultData Result data of the query
43 * @throws UnsupportedCriteriaException If the criteria is unsupported
44 * @throws SqlException If an SQL error occurs
46 function querySelect ($tableName, LocalSearchCriteria $criteriaInstance);
49 * 'Inserts' a data set instance into a local file database folder
51 * @param $dataSetInstance A storeable data set
53 * @throws SqlException If an SQL error occurs
55 function queryInsertDataSet (StoreableCriteria $dataSetInstance);
58 * 'Updates' a data set instance with a database layer
60 * @param $dataSetInstance A storeable data set
62 * @throws SqlException If an SQL error occurs
64 function queryUpdateDataSet (StoreableCriteria $dataSetInstance);