Initial import of current development status
[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 <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
10  * @version     0.1
11  */
12 interface DatabaseFrontendInterface extends FrameworkDatabaseInterface {
13         /**
14          * Loads data saved with saveObject from the database and re-creates a
15          * full object from it.
16          * If limitObject() was called before a new object ObjectContainer with
17          * all requested attributes will be returned instead.
18          *
19          * @return      Object  The fully re-created object or instance to
20          *                                      ObjectContainer
21          */
22         function loadObject ();
23 }
24
25 // [EOF]
26 ?>