3 * This is the top-level interface for all other interfaces and should contain
4 * method stubs which is being used in every class
6 * @author Roland Haeder <webmaster@ship-simu.org>
8 * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
9 * @license GNU GPL 3.0 or any newer version
10 * @link http://www.ship-simu.org
12 * This program is free software: you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation, either version 3 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 interface FrameworkInterface {
27 * Getter for field name
29 * @param $fieldName Field name which we shall get
30 * @return $fieldValue Field value from the user
31 * @throws NullPointerException If the result instance is null
33 function getField ($fieldName);
36 * Updates a given field with new value
38 * @param $fieldName Field to update
39 * @param $fieldValue New value to store
41 * @throws DatabaseUpdateSupportException If this class does not support database updates
43 function updateDatabaseField ($fieldName, $fieldValue);