Derek Hulley 8e0a637886 Merged 1.4 to HEAD
svn merge svn://svn.alfresco.com:3691/alfresco/BRANCHES/V1.4@4229 svn://svn.alfresco.com:3691/alfresco/BRANCHES/V1.4@4230 .
   svn merge svn://svn.alfresco.com:3691/alfresco/BRANCHES/V1.4@4232 svn://svn.alfresco.com:3691/alfresco/BRANCHES/V1.4@4233 .
   svn merge svn://svn.alfresco.com:3691/alfresco/BRANCHES/V1.4@4234 svn://svn.alfresco.com:3691/alfresco/BRANCHES/V1.4@4235 .
   svn merge svn://svn.alfresco.com:3691/alfresco/BRANCHES/V1.4@4239 svn://svn.alfresco.com:3691/alfresco/BRANCHES/V1.4@4240 .
   svn resolved root\projects\web-client\source\java\org\alfresco\web\app\AlfrescoNavigationHandler.java
   svn resolved root\projects\web-client\source\web\WEB-INF\faces-config-beans.xml
   svn merge svn://svn.alfresco.com:3691/alfresco/BRANCHES/V1.4@4241 svn://svn.alfresco.com:3691/alfresco/BRANCHES/V1.4@4242 .
   svn merge svn://svn.alfresco.com:3691/alfresco/BRANCHES/V1.4@4243 svn://svn.alfresco.com:3691/alfresco/BRANCHES/V1.4@4244 .
   svn merge svn://svn.alfresco.com:3691/alfresco/BRANCHES/V1.4@4244 svn://svn.alfresco.com:3691/alfresco/BRANCHES/V1.4@4245 .
   svn merge svn://svn.alfresco.com:3691/alfresco/BRANCHES/V1.4@4245 svn://svn.alfresco.com:3691/alfresco/BRANCHES/V1.4@4246 .
   svn merge svn://svn.alfresco.com:3691/alfresco/BRANCHES/V1.4@4247 svn://svn.alfresco.com:3691/alfresco/BRANCHES/V1.4@4248 .
   svn merge svn://svn.alfresco.com:3691/alfresco/BRANCHES/V1.4@4248 svn://svn.alfresco.com:3691/alfresco/BRANCHES/V1.4@4249 .
   svn merge svn://svn.alfresco.com:3691/alfresco/BRANCHES/V1.4@4250 svn://svn.alfresco.com:3691/alfresco/BRANCHES/V1.4@4251 .
   svn merge svn://svn.alfresco.com:3691/alfresco/BRANCHES/V1.4@4251 svn://svn.alfresco.com:3691/alfresco/BRANCHES/V1.4@4252 .


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@4633 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2006-12-18 13:18:44 +00:00

233 lines
7.8 KiB
Java

/*
* Copyright (C) 2005 Alfresco, Inc.
*
* Licensed under the Mozilla Public License version 1.1
* with a permitted attribution clause. You may obtain a
* copy of the License at
*
* http://www.alfresco.org/legal/license.txt
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the
* License.
*/
package org.alfresco.service.cmr.rule;
import java.util.List;
import org.alfresco.service.Auditable;
import org.alfresco.service.PublicService;
import org.alfresco.service.cmr.action.Action;
import org.alfresco.service.cmr.repository.NodeRef;
/**
* Rule service interface.
*
* @author Roy Wetherall
*/
@PublicService
public interface RuleService
{
/**
* Get the rule types currently defined in the repository.
*
* @return a list of rule types
*/
@Auditable
public List<RuleType> getRuleTypes();
/**
* Gets a rule type by name.
*
* @param name the name of the rule type
* @return the rule type, null if not found
*/
@Auditable(parameters = {"name"})
public RuleType getRuleType(String name);
/**
* Enable rules for the current thread
*/
@Auditable
public void enableRules();
/**
* Diable rules for the current thread
*/
@Auditable
public void disableRules();
/**
* Indicates whether rules are currently enabled or not
*
* @return true if rules are enabled, false otherwise
*/
@Auditable
public boolean isEnabled();
/**
* Indicates wether the rules for a given node are enabled or not. If the
* rules are not enabled then they will not be executed.
*
* @param nodeRef the node reference
* @return true if the rules are enabled, false otherwise
*/
@Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef"})
public boolean rulesEnabled(NodeRef nodeRef);
/**
* Disables the rules for a given node reference. When the rules are disabled they
* will not execute.
*
* @param nodeRef the node reference
*/
@Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef"})
public void disableRules(NodeRef nodeRef);
/**
* Enables the rules for a given node reference. When the rules are enabled they
* will execute as usual. By default all rules are enabled.
*
* @param nodeRef the node reference
*/
@Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef"})
public void enableRules(NodeRef nodeRef);
/**
* Disables a rule, preventing it from being fired.
*
* @param rule the rule to disable
*/
@Auditable(parameters = {"rule"})
public void disableRule(Rule rule);
/**
* Enables a rule previously disabled.
*
* @param rule the rule to enable
*/
@Auditable(parameters = {"rule"})
public void enableRule(Rule rule);
/**
* Indicates whether the node in question has any rules associated with it.
*
* @param nodeRef the node reference
* @return true if the node has rules associated, false otherwise
*/
@Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef"})
public boolean hasRules(NodeRef nodeRef);
/**
* Get all the rules associated with an actionable node, including those
* inherited from parents.
* <p>
* An exception is raised if the actionable aspect is not present on the
* passed node.
*
* @param nodeRef the node reference
* @return a list of the rules associated with the node
*/
@Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef"})
public List<Rule> getRules(NodeRef nodeRef);
/**
* Get the rules associated with an actionable node.
* <p>
* Optionally this list includes rules inherited from its parents.
* <p>
* An exception is raised if the actionable aspect is not present on the
* passed node.
*
* @param nodeRef the node reference
* @param includeInhertied indicates whether the inherited rules should be included in
* the result list or not
* @return a list of the rules associated with the node
*/
@Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef", "includeInhertied"})
public List<Rule> getRules(NodeRef nodeRef, boolean includeInhertied);
/**
* Get the rules associated with an actionable node that are of a specific rule type.
*
* @param nodeRef the node reference
* @param includeInhertiedRuleType indicates whether the inherited rules should be included in
* the result list or not
* @param ruleTypeName the name of the rule type, if null is passed all rule types
* are returned
* @return a list of the rules associated with the node
*/
@Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef", "includeInhertiedRuleType", "ruleTypeName"})
public List<Rule> getRules(NodeRef nodeRef, boolean includeInhertiedRuleType, String ruleTypeName);
/**
* Count the number of rules associated with an actionable node.
*
* @param nodeRef the node reference
* @return a list of the rules associated with the node
*/
@Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef"})
public int countRules(NodeRef nodeRef);
/**
* Get the rule given its node reference
*
* @param nodeRef the node reference
* @return the rule corresponding to the node reference
*/
@Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef"})
public Rule getRule(NodeRef nodeRef);
/**
* Saves the details of the rule to the specified node reference.
* <p>
* If the rule is already associated with the node, the details are updated
* with those specified.
*
* @param nodeRef
* @param rule
*/
@Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef", "rule"})
public void saveRule(NodeRef nodeRef, Rule rule);
/**
* Removes a rule from the given rule actionable node
*
* @param nodeRef the actionable node reference
*/
@Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef", "rule"})
public void removeRule(NodeRef nodeRef, Rule rule);
/**
* Removes all the rules associated with an actionable node
*
* @param nodeRef the actionable node reference
*/
@Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef"})
public void removeAllRules(NodeRef nodeRef);
/**
* Returns the owning node reference for a rule.
*
* @param rule the rule
* @return the owning node reference
*/
@Auditable(key = Auditable.Key.RETURN, parameters = {"rule"})
public NodeRef getOwningNodeRef(Rule rule);
/**
* Returns the owning node reference for an action. Returns null for an unsaved action or one that is not
* parented by a rule.
*
* NOTE: this method is temporary and will be removed in future versions. It should only be used with good reason.
*
* @param action the action
* @return the owning node reference
*/
@Auditable(key = Auditable.Key.RETURN, parameters = {"action"})
public NodeRef getOwningNodeRef(Action action);
}