TODO: We should find something better than BaseFrameworkSystem as a type-hint
[shipsimu.git] / ship-simu / inc / classes / interfaces / database / frontend / class_DatabaseFrontendInterface.php
1 <?php
2 /**
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.
8  *
9  * @author              Roland Haeder <webmaster@ship-simu.org>
10  * @version             0.0
11  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
12  * @license             GNU GPL 3.0 or any newer version
13  *
14  * This program is free software: you can redistribute it and/or modify
15  * it under the terms of the GNU General Public License as published by
16  * the Free Software Foundation, either version 3 of the License, or
17  * (at your option) any later version.
18  *
19  * This program is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU General Public License for more details.
23  *
24  * You should have received a copy of the GNU General Public License
25  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
26  */
27 interface DatabaseFrontendInterface extends FrameworkDatabaseInterface {
28         /**
29          * Loads data saved with saveObject from the database and re-creates a
30          * full object from it.
31          * If limitObject() was called before a new object ObjectContainer with
32          * all requested attributes will be returned instead.
33          *
34          * @return      Object  The fully re-created object or instance to
35          *                                      ObjectContainer
36          */
37         function loadObject ();
38 }
39
40 // [EOF]
41 ?>