[jboss-svn-commits] JBL Code SVN: r15632 - labs/jbossrules/trunk/documentation/manual/en/Chapter-Rule_Language.

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

Author: mark.proctor at jboss.com
Date: 2007-10-07 21:54:40 -0400 (Sun, 07 Oct 2007)
New Revision: 15632

Modified:
   labs/jbossrules/trunk/documentation/manual/en/Chapter-Rule_Language/Section-Rule.xml
Log:
-document lock-on-active

Modified: labs/jbossrules/trunk/documentation/manual/en/Chapter-Rule_Language/Section-Rule.xml
===================================================================
--- labs/jbossrules/trunk/documentation/manual/en/Chapter-Rule_Language/Section-Rule.xml	2007-10-07 14:15:37 UTC (rev 15631)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-Rule_Language/Section-Rule.xml	2007-10-08 01:54:40 UTC (rev 15632)
@@ -105,6 +105,27 @@
     </section>
 
     <section>
+      <title>lock-on-active</title>
+
+      <para>default value : false</para>
+
+      <para>type : Boolean</para>
+
+      <para>when a ruleflow-group becomes active or an agenda-group receives
+      the focus any rules that ahve lock-on-active set to try cannot place
+      activations onto the agenda, the rules are matched and the resulting
+      activations discarded. This is a stronger version of no-loop. It's
+      idealy for calculation rules where you have a number of rules that will
+      modify a fact and you don't want any rule re-matching and firing. In
+      summary fire these currently active rules and only these rules, no
+      matter how the data changes, do not allow any more activations for the
+      rules with the attribute set to true. When the ruleflow-group is no
+      longer active or agenda-group loses the focus those rules with
+      lock-on-active set to true can once again add activations onto the
+      agenda.</para>
+    </section>
+
+    <section>
       <title>salience</title>
 
       <para>default value : 0</para>