3 * The general interface for all other database interfaces
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software
8 * @license GNU GPL 3.0 or any newer version
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 interface FrameworkDatabaseInterface extends FrameworkInterface {
25 * Saves a whole object by serializing it entirely or some specifyable
26 * parts. Specifying parts must be done before this method is called. If
27 * it is not done this method will serialize the whole object.
29 * @param $object An instance to the object we want to save
31 * @see limitObject(ObjectLimits) limitObject
33 function saveObject ($object);
36 * Analyses if a unique ID has already been used or not. This method does
37 * only pass the given ID through to the "real" database layer.
39 * @param $uniqueID A unique ID number which shall be checked
40 * before it will be used
41 * @param $inConstructor If called from a constructor or from
43 * @return $isUnused true = The unique ID was not found in the database,
44 * false = It is already in use by an other object
45 * @throws NullPointerException If $dbInstance is null
46 * @throws NoObjectException If $dbInstance is not an object
47 * @throws MissingMethodException If the required method
48 * isUniqueIdUsed() was not found
50 function isUniqueIdUsed ($uniqueID, $inConstructor = false);
53 * Gets cached data from the database layer and if not found fetch it from
54 * the database again. This method does not return the header stuff because
55 * The underlaying database class will return only the requested content.
57 * @param $idNumber The ID number which we need for looking up
59 * @return $cachedArray The maybe cached data from the database
60 * @throws NullPointerException If $dbInstance is null
61 * @throws NoObjectException If $dbInstance is not an object
62 * @throws MissingMethodException If the required method
63 * isUniqueIdUsed() was not found
65 function getObjectFromCachedData ($idNumber);