3 namespace Org\Mxchange\CoreFramework\Generic;
6 * This is the top-level interface for all other interfaces and should contain
7 * method stubs which is being used in every class
9 * @author Roland Haeder <webmaster@shipsimu.org>
11 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 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
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.
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.
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/>.
29 interface FrameworkInterface {
30 // Exception constants
31 const EXCEPTION_INVALID_ARGUMENT = 0x200;
32 const EXCEPTION_LOGIC_EXCEPTION = 0x201;
33 const EXCEPTION_UNSPPORTED_OPERATION = 0x202;
34 const EXCEPTION_UNEXPECTED_VALUE = 0x203;
35 const EXCEPTION_CLASS_NOT_FOUND = 0x204;
38 * Getter for field name
40 * @param $fieldName Field name which we shall get
41 * @return $fieldValue Field value from the user
42 * @throws NullPointerException If the result instance is null
44 function getField (string $fieldName);
47 * Checks if given field is set
49 * @param $fieldName Field name to check
50 * @return $isSet Whether the given field name is set
51 * @throws NullPointerException If the result instance is null
53 function isFieldSet (string $fieldName);
56 * Setter for call-back instance
58 * @param $callbackInstance An instance of a FrameworkInterface class
61 function setCallbackInstance (FrameworkInterface $callbackInstance);
64 * Checks whether an object equals this object. You should overwrite this
65 * method to implement own equality checks
67 * @param $objectInstance An instance of a FrameworkInterface object
68 * @return $equals Whether both objects equals
70 function equals (FrameworkInterface $objectInstance);
73 * Generates a code for hashes from this class
75 * @return $hashCode The hash code respresenting this class