Package org.alfresco.repo.rule

Interface RuntimeRuleService

  • All Known Implementing Classes:
    RuleServiceImpl
    public interface RuntimeRuleService
    Runtime rule service
    Author:
    Roy Wetherall

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addRulePendingExecution​(org.alfresco.service.cmr.repository.NodeRef actionableNodeRef, org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef, Rule rule)
      Add a rule to the pending execution list
      void addRulePendingExecution​(org.alfresco.service.cmr.repository.NodeRef actionableNodeRef, org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef, Rule rule, boolean executeAtEnd)
      Add a rule to the pending execution list
      void executePendingRules()
      Execute all pending rules
      void executeRule​(Rule rule, org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef, java.util.Set<RuleServiceImpl.ExecutedRuleData> executedRules)
      Execute a rule
      org.alfresco.service.cmr.repository.ChildAssociationRef getSavedRuleFolderAssoc​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
      Get the folder that the rules are saved within for a given actionable node
      void registerRuleType​(RuleType ruleType)
      Register a rule type
      void removeRulePendingExecution​(org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)
      Remove all pending rules that are actioning upon the given node reference

    • Method Detail

      • executeRule

        void executeRule​(Rule rule,
                 org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef,
                 java.util.Set<RuleServiceImpl.ExecutedRuleData> executedRules)
        Execute a rule
        Parameters:
        rule - rule
        actionedUponNodeRef - actioned upon node reference
        executedRules - already executed rules

      • addRulePendingExecution

        void addRulePendingExecution​(org.alfresco.service.cmr.repository.NodeRef actionableNodeRef,
                             org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef,
                             Rule rule)
        Add a rule to the pending execution list
        Parameters:
        actionableNodeRef - actionable node reference
        actionedUponNodeRef - actioned upon node reference
        rule - rule

      • addRulePendingExecution

        void addRulePendingExecution​(org.alfresco.service.cmr.repository.NodeRef actionableNodeRef,
                             org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef,
                             Rule rule,
                             boolean executeAtEnd)
        Add a rule to the pending execution list
        Parameters:
        actionableNodeRef - actionable node reference
        actionedUponNodeRef - actioned upon node reference
        rule - rule
        executeAtEnd - true if execute rule at the end of the transaction, false otherwise

      • removeRulePendingExecution

        void removeRulePendingExecution​(org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)
        Remove all pending rules that are actioning upon the given node reference
        Parameters:
        actionedUponNodeRef - actioned upon node reference

      • executePendingRules

        void executePendingRules()
        Execute all pending rules

      • registerRuleType

        void registerRuleType​(RuleType ruleType)
        Register a rule type
        Parameters:
        ruleType - rule type

      • getSavedRuleFolderAssoc

        org.alfresco.service.cmr.repository.ChildAssociationRef getSavedRuleFolderAssoc​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
        Get the folder that the rules are saved within for a given actionable node
        Parameters:
        nodeRef - node reference
        Returns:
        ChildAssocationref child association reference to the rule folder