[jboss-svn-commits] JBL Code SVN: r17270 - labs/jbossrules/trunk/drools-solver/drools-solver-core/src/main/java/org/drools/solver/core/solution.

[jboss-svn-commits at lists.jboss.org]

Author: ge0ffrey
Date: 2007-12-16 10:16:03 -0500 (Sun, 16 Dec 2007)
New Revision: 17270

Modified:
   labs/jbossrules/trunk/drools-solver/drools-solver-core/src/main/java/org/drools/solver/core/solution/Solution.java
Log:
javadoc

Modified: labs/jbossrules/trunk/drools-solver/drools-solver-core/src/main/java/org/drools/solver/core/solution/Solution.java
===================================================================
--- labs/jbossrules/trunk/drools-solver/drools-solver-core/src/main/java/org/drools/solver/core/solution/Solution.java	2007-12-16 14:36:44 UTC (rev 17269)
+++ labs/jbossrules/trunk/drools-solver/drools-solver-core/src/main/java/org/drools/solver/core/solution/Solution.java	2007-12-16 15:16:03 UTC (rev 17270)
@@ -7,12 +7,18 @@
  */
 public interface Solution {
 
-    Solution cloneSolution();
-
     /**
      * Called when the solution needs to be asserted into an empty WorkingMemory.
+     * These facts can be used by the score rules.
      * @return all the facts of this solution
      */
     Collection<? extends Object> getFacts();
 
+    /**
+     * Called when the solution needs to be cloned during solving,
+     * for example to store a clone of the current solution as the best solution. 
+     * @return a clone of which the properties that change during solving are deep cloned
+     */
+    Solution cloneSolution();
+
 }