5848674c54c2ead573fd75057a7975b4185b4df3
[core.git] / inc / classes / interfaces / class_FrameworkInterface.php
1 <?php
2 /**
3  * This is the top-level interface for all other interfaces and should contain
4  * method stubs which is being used in every class
5  *
6  * @author              Roland Haeder <webmaster@ship-simu.org>
7  * @version             0.0.0
8  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
9  * @license             GNU GPL 3.0 or any newer version
10  * @link                http://www.ship-simu.org
11  *
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.
16  *
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.
21  *
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/>.
24  */
25 interface FrameworkInterface {
26         /**
27          * Getter for field name
28          *
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
32          */
33         function getField ($fieldName);
34 }
35
36 //
37 ?>