3 * An interface for registries
5 * @author Roland Haeder <webmaster@mxchange.org>
7 * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 interface Register extends FrameworkInterface {
26 * Checks wether an instance key was found
28 * @param $instanceKey The key holding an instance in the registry
29 * @return $exists Wether the key exists in the registry
31 function instanceExists ($instanceKey);
34 * Adds/overwrites a new instance to the registry at the given key
36 * @param $instanceKey The key to identify the instance
37 * @param $objectInstance An instance we shall store
40 function addInstance ($instanceKey, Registerable $objectInstance);
43 * Gets a registered instance or null if not found
45 * @param $instanceKey The key to identify the instance
46 * @return $objectInstance An instance we shall store
48 function getInstance ($instanceKey);