Files
alfresco-community-repo/source/java/org/alfresco/repo/rule/RuntimeRuleService.java
Raluca Munteanu 6afb44e712 Merged 5.1.N (5.1.2) to 5.2.N (5.2.1)
125606 rmunteanu: Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)
      125515 slanglois: MNT-16155 Update source headers - add new Copyrights for Java and JSP source files + automatic check in the build


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@125788 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2016-04-26 13:45:01 +00:00

98 lines
3.3 KiB
Java

/*
* #%L
* Alfresco Repository
* %%
* Copyright (C) 2005 - 2016 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of
* the paid license agreement will prevail. Otherwise, the software is
* provided under the following open source license terms:
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
* #L%
*/
package org.alfresco.repo.rule;
import java.util.Set;
import org.alfresco.repo.rule.RuleServiceImpl.ExecutedRuleData;
import org.alfresco.service.cmr.repository.ChildAssociationRef;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.rule.Rule;
import org.alfresco.service.cmr.rule.RuleType;
/**
* Runtime rule service
*
* @author Roy Wetherall
*/
public interface RuntimeRuleService
{
/**
* Execute a rule
*
* @param rule rule
* @param actionedUponNodeRef actioned upon node reference
* @param executedRules already executed rules
*/
void executeRule(Rule rule, NodeRef actionedUponNodeRef, Set<ExecutedRuleData> executedRules);
/**
* Add a rule to the pending execution list
*
* @param actionableNodeRef actionable node reference
* @param actionedUponNodeRef actioned upon node reference
* @param rule rule
*/
void addRulePendingExecution(NodeRef actionableNodeRef, NodeRef actionedUponNodeRef, Rule rule);
/**
* Add a rule to the pending execution list
*
* @param actionableNodeRef actionable node reference
* @param actionedUponNodeRef actioned upon node reference
* @param rule rule
* @param executeAtEnd true if execute rule at the end of the transaction, false otherwise
*/
void addRulePendingExecution(NodeRef actionableNodeRef, NodeRef actionedUponNodeRef, Rule rule, boolean executeAtEnd);
/**
* Remove all pending rules that are actioning upon the given node reference
*
* @param actionedUponNodeRef actioned upon node reference
*/
public void removeRulePendingExecution(NodeRef actionedUponNodeRef);
/**
* Execute all pending rules
*/
void executePendingRules();
/**
* Register a rule type
*
* @param ruleType rule type
*/
void registerRuleType(RuleType ruleType);
/**
* Get the folder that the rules are saved within for a given actionable node
*
* @param nodeRef node reference
* @return ChildAssocationref child association reference to the rule folder
*/
ChildAssociationRef getSavedRuleFolderAssoc(NodeRef nodeRef);
}