Renamed Registry -> GenericRegistry to make it clear that this registry does

[core.git] / framework / main / interfaces / registry / class_Register.php

diff --git a/framework/main/interfaces/registry/class_Register.php b/framework/main/interfaces/registry/class_Register.php
index 3fc6b55b21943a18f441e7ab365809dc61fc78cd..177be13947b24bfb9df002237df4af61a681f90c 100644 (file)
--- a/framework/main/interfaces/registry/class_Register.php
+++ b/framework/main/interfaces/registry/class_Register.php
@@ -1,9 +1,9 @@
 <?php
 // Own namespace
-namespace CoreFramework\Registry;
+namespace Org\Mxchange\CoreFramework\Registry;
 
 // Import framework stuff
-use CoreFramework\Generic\FrameworkInterface;
+use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
 
 /**
  * An interface for registries
@@ -45,11 +45,52 @@ interface Register extends FrameworkInterface {
         */
        function addInstance ($instanceKey, Registerable $objectInstance);
 
+       /**
+        * Getter for whole generic registry
+        *
+        * @return      $instanceRegistry       The whole generic registry array
+        */
+       function getGenericRegistry ();
+
+       /**
+        * Getter for whole instance registry
+        *
+        * @return      $instanceRegistry       The whole instance registry array
+        */
+       function getInstanceRegistry ();
+
+       /**
+        * Adds a new entry to the given list name. If you want to add objects
+        * please use addInstance() and getInstance() instead.
+        *
+        * @param       $key    The key to identify the whole list
+        * @param       $value  The value to be stored
+        * @return      void
+        */
+       function addEntry ($key, $value);
+
+       /**
+        * Getter for entries or "sub entries"
+        *
+        * @return      $entries        An array with entries from this registry
+        */
+       function getEntries ($key = NULL);
+
+       /**
+        * "Getter" for an array of all entries for given key
+        *
+        * @param       $arrayKey       The array (key) to look in
+        * @param       $lookFor        The key to look for
+        * @return      $entry          An array with all keys
+        */
+       function getArrayFromKey ($arrayKey, $lookFor);
+
        /**
         * Gets a registered instance or null if not found
         *
         * @param       $instanceKey            The key to identify the instance
         * @return      $objectInstance         An instance we shall store
+        * @throws      NullPointerException    If the requested key is not found
         */
        function getInstance ($instanceKey);