- Rule and action tasks for 1.4

- Updated W/S include paths

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@3526 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/service/cmr/rule/Rule.java

@@ -68,63 +68,117 @@ public class Rule implements Serializable
      */
     private boolean executeAsynchronously = false;
     
+    /** Indicates wehther the rule is marked as disabled or not */
+    private boolean ruleDisabled = false;
+    
     /**
      * Indicates whether the rule is applied to all the children of the associated node
      * rather than just the node itself.
      */
     private boolean isAppliedToChildren = false;
     
+    /**
+     * Constructor
+     */
     public Rule()
     {
     }
     
+    /**
+     * Constructor.
+     * 
+     * @param nodeRef  the rule node reference
+     */
     public Rule(NodeRef nodeRef)
     {
         this.nodeRef = nodeRef;
     }
     
+    /**
+     * Set the action
+     * 
+     * @param action    the action
+     */
     public void setAction(Action action)
     {
         this.action = action;
     }
     
+    /**
+     * Gets the action associatied with the rule
+     * 
+     * @return  the action
+     */
     public Action getAction()
     {
         return action;
     }
     
+    /**
+     * Set the node reference of the rule
+     * 
+     * @param nodeRef   the rule node reference
+     */
     public void setNodeRef(NodeRef nodeRef)
     {
         this.nodeRef = nodeRef;
     }
     
+    /**
+     * Get the node reference of the rule
+     * 
+     * @return  the rule node reference
+     */
     public NodeRef getNodeRef()
     {
         return nodeRef;
     }
     
+    /**
+     * Set the title of the rule
+     * 
+     * @param title the title 
+     */
     public void setTitle(String title)
     {
         this.title = title;
     }
     
+    /**
+     * Get the title of the rule
+     * 
+     * @return  the title
+     */
     public String getTitle()
     {
         return title;
     }
     
+    /**
+     * Set the description of the rule 
+     * 
+     * @param description   the description
+     */
     public void setDescription(String description)
     {
         this.description = description;
     }
     
+    /**
+     * Get the description of the rule
+     * 
+     * @return  the description
+     */
     public String getDescription()
     {
         return description;
     }
     
     /**
-     * @see org.alfresco.service.cmr.rule.Rule#isAppliedToChildren()
+     *  Indicates wehther this rule should be applied to the children of 
+     *  the owning space.
+     * 
+     * @return  true if the rule is to be applied to children, false otherwise   
      */
     public boolean isAppliedToChildren()
     {
@@ -132,13 +186,22 @@ public class Rule implements Serializable
     }
     
     /**
-     *@see org.alfresco.service.cmr.rule.Rule#applyToChildren(boolean)
+     * Sets the values that indicates whether this rule should be applied to the children
+     * of the owning space.
+     * 
+     * @param isAppliedToChildren   true if the rule is to be applied to children, false otherwise
      */
+    
     public void applyToChildren(boolean isAppliedToChildren)
     {
         this.isAppliedToChildren = isAppliedToChildren;
     }
     
+    /**
+     * Helper method to set one rule type on the rule.
+     * 
+     * @param ruleType  the rule type
+     */
     public void setRuleType(String ruleType)
     {
         List<String> ruleTypes = new ArrayList<String>(1);
@@ -146,26 +209,67 @@ public class Rule implements Serializable
         this.ruleTypes = ruleTypes;
     }
     
+    /**
+     * Set the rules rule types.
+     * 
+     * @param ruleTypes list of rule types
+     */
     public void setRuleTypes(List<String> ruleTypes)
     {
         this.ruleTypes = ruleTypes;
     }
     
+    /**
+     * Get the rules rule types.
+     * 
+     * @return  a list of rule types
+     */
     public List<String> getRuleTypes()
     {
         return ruleTypes;
     }
     
+    /**
+     * Sets the value that indicates whether this associated action should be executed
+     * asynchrously or not
+     * 
+     * @param executeAsynchronously true to execute action async, false otherwise
+     */
     public void setExecuteAsynchronously(boolean executeAsynchronously)
     {
         this.executeAsynchronously = executeAsynchronously;
     }
     
+    /**
+     * Indicates whether the associated action should be executed async or not
+     * 
+     * @return  true to execute async, false otherwise
+     */
     public boolean getExecuteAsynchronously()
     {
         return this.executeAsynchronously;
     }
     
+    /**
+     * Indicates wehther this rule has been disabled or not
+     * 
+     * @return  true if the rule has been disabled, false otherwise
+     */
+    public boolean getRuleDisabled()
+    {
+        return this.ruleDisabled;
+    }
+    
+    /**
+     * Set the value that indicates wehther this rule has been disabled or not
+     * 
+     * @param ruleDisabled  true id the rule has been disabled, false otherwise
+     */
+    public void setRuleDisabled(boolean ruleDisabled)
+    {
+        this.ruleDisabled = ruleDisabled;
+    }
+    
     /**
      * Hash code implementation
      */