Introduced isFieldSet().

[core.git] / inc / classes / interfaces / class_FrameworkInterface.php

diff --git a/inc/classes/interfaces/class_FrameworkInterface.php b/inc/classes/interfaces/class_FrameworkInterface.php
index bffb8743a1b63e43773d830a16c456b641898648..724e57d7e47b3bebaf884152eb2fa688d96466a7 100644 (file)
--- a/inc/classes/interfaces/class_FrameworkInterface.php
+++ b/inc/classes/interfaces/class_FrameworkInterface.php
@@ -3,11 +3,12 @@
  * This is the top-level interface for all other interfaces and should contain
  * method stubs which is being used in every class
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, this is free software
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @link               http://www.shipsimu.org
+ * @todo               Find a better name for this interface
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -31,7 +32,32 @@ interface FrameworkInterface {
         * @throws      NullPointerException    If the result instance is null
         */
        function getField ($fieldName);
+
+       /**
+        * Checks if given field is set
+        *
+        * @param       $fieldName      Field name to check
+        * @return      $isSet          Whether the given field name is set
+        * @throws      NullPointerException    If the result instance is null
+        */
+       function isFieldSet ($fieldName);
+
+       /**
+        * Checks whether an object equals this object. You should overwrite this
+        * method to implement own equality checks
+        *
+        * @param       $objectInstance         An instance of a FrameworkInterface object
+        * @return      $equals                         Whether both objects equals
+        */
+       function equals (FrameworkInterface $objectInstance);
+
+       /**
+        * Generates a code for hashes from this class
+        *
+        * @return      $hashCode       The hash code respresenting this class
+        */
+       function hashCode ();
 }
 
-//
+// [EOF]
 ?>