Renamed Registry -> GenericRegistry to make it clear that this registry does
[core.git] / framework / main / interfaces / class_FrameworkInterface.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Generic;
4
5 /**
6  * This is the top-level interface for all other interfaces and should contain
7  * method stubs which is being used in every class
8  *
9  * @author              Roland Haeder <webmaster@shipsimu.org>
10  * @version             0.0.0
11  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
12  * @license             GNU GPL 3.0 or any newer version
13  * @link                http://www.shipsimu.org
14  * @todo                Find a better name for this interface
15  *
16  * This program is free software: you can redistribute it and/or modify
17  * it under the terms of the GNU General Public License as published by
18  * the Free Software Foundation, either version 3 of the License, or
19  * (at your option) any later version.
20  *
21  * This program is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24  * GNU General Public License for more details.
25  *
26  * You should have received a copy of the GNU General Public License
27  * along with this program. If not, see <http://www.gnu.org/licenses/>.
28  */
29 interface FrameworkInterface {
30         /**
31          * Getter for field name
32          *
33          * @param       $fieldName              Field name which we shall get
34          * @return      $fieldValue             Field value from the user
35          * @throws      NullPointerException    If the result instance is null
36          */
37         function getField ($fieldName);
38
39         /**
40          * Checks if given field is set
41          *
42          * @param       $fieldName      Field name to check
43          * @return      $isSet          Whether the given field name is set
44          * @throws      NullPointerException    If the result instance is null
45          */
46         function isFieldSet ($fieldName);
47
48         /**
49          * Setter for call-back instance
50          *
51          * @param       $callbackInstance       An instance of a FrameworkInterface class
52          * @return      void
53          */
54         function setCallbackInstance (FrameworkInterface $callbackInstance);
55
56         /**
57          * Checks whether an object equals this object. You should overwrite this
58          * method to implement own equality checks
59          *
60          * @param       $objectInstance         An instance of a FrameworkInterface object
61          * @return      $equals                         Whether both objects equals
62          */
63         function equals (FrameworkInterface $objectInstance);
64
65         /**
66          * Generates a code for hashes from this class
67          *
68          * @return      $hashCode       The hash code respresenting this class
69          */
70         function hashCode ();
71
72 }