1c22f6b7d5f3b26948389f7803f702048970fbcb
[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, 2010 Core Developer Team
9  * @license             GNU GPL 3.0 or any newer version
10  * @link                http://www.ship-simu.org
11  * @todo                Find a better name for this interface
12  *
13  * This program is free software: you can redistribute it and/or modify
14  * it under the terms of the GNU General Public License as published by
15  * the Free Software Foundation, either version 3 of the License, or
16  * (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program. If not, see <http://www.gnu.org/licenses/>.
25  */
26 interface FrameworkInterface {
27         /**
28          * Getter for field name
29          *
30          * @param       $fieldName              Field name which we shall get
31          * @return      $fieldValue             Field value from the user
32          * @throws      NullPointerException    If the result instance is null
33          */
34         function getField ($fieldName);
35
36         /**
37          * Generates a code for hashes from this class
38          *
39          * @return      $hashCode       The hash code respresenting this class
40          */
41         function hashCode ();
42 }
43
44 // [EOF]
45 ?>