Who says 'hashCode()' says also 'equals()' ... Shame on me

[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 61d098243a5a4c5b9d7d78ad61051e35ae9e1236..2018153d409cf0bbefea48d8c054d6cad60bac4e 100644 (file)
--- a/inc/classes/interfaces/class_FrameworkInterface.php
+++ b/inc/classes/interfaces/class_FrameworkInterface.php
@@ -5,7 +5,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  * @todo               Find a better name for this interface
@@ -33,6 +33,15 @@ interface FrameworkInterface {
         */
        function getField ($fieldName);
 
+       /**
+        * Checks wether 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                         Wether both objects equals
+        */
+       function equals (FrameworkInterface $objectInstance);
+
        /**
         * Generates a code for hashes from this class
         *