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

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

Author: mark.proctor at jboss.com
Date: 2007-10-06 08:45:31 -0400 (Sat, 06 Oct 2007)
New Revision: 15617

Modified:
   labs/jbossrules/trunk/drools-core/src/main/java/org/drools/RuleBase.java
Log:
-updated the javadocs for RuleBase

Modified: labs/jbossrules/trunk/drools-core/src/main/java/org/drools/RuleBase.java
===================================================================
--- labs/jbossrules/trunk/drools-core/src/main/java/org/drools/RuleBase.java	2007-10-06 05:19:45 UTC (rev 15616)
+++ labs/jbossrules/trunk/drools-core/src/main/java/org/drools/RuleBase.java	2007-10-06 12:45:31 UTC (rev 15617)
@@ -121,23 +121,63 @@
 
     void addPackage(Package pkg) throws Exception;
     
+    /**
+     * This locks the current RuleBase and all there referenced StatefulSessions. This should be 
+     * used when there is a number of dynamic RuleBase changes you wish to make, but cannot have any normal
+     * WorkingMemory operations occuring inbetween.
+     *
+     */
     void lock();
     
+    /**
+     * Unlocks the RuleBase and all of the referenced StatefulSessions.
+     *
+     */
     void unlock();
-    
+
+    /**
+     * Returns the number of additive operations applied since the last lock() was obtained 
+     * @return
+     */
     int getAdditionsSinceLock();
 
+    /**
+     * Returns the number of removal operations applied since the last lock() was obtained 
+     * @return
+     */
     int getRemovalsSinceLock();
 
+    /**
+     * Remove the package and all it's rules, functions etc
+     * @param packageName
+     */
     void removePackage(String packageName);
 
+    /**
+     * Remove a specific Rule in a Package
+     * @param packageName
+     * @param ruleName
+     */
     void removeRule(String packageName,
                     String ruleName);
 
+    /**
+     * Removes a specific function in a specific package.
+     * @param packageName
+     * @param functionName
+     */
     void removeFunction(String packageName,
                         String functionName);
 
+    /**
+     * Removes a process by the process' id
+     * @param id
+     */
     void removeProcess(String id);
 
+    /**
+     * Returns an array of all the referenced StatefulSessions
+     * @return
+     */
     public StatefulSession[] getStatefulSessions();
 }