Interface RuntimeRuleService

  • All Known Implementing Classes:
    RuleServiceImpl

    public interface RuntimeRuleService
    Runtime rule service
    Author:
    Roy Wetherall
    • Method Detail

      • executeRule

        void executeRule​(Rule rule,
                         NodeRef actionedUponNodeRef,
                         Set<RuleServiceImpl.ExecutedRuleData> executedRules)
        Execute a rule
        Parameters:
        rule - rule
        actionedUponNodeRef - actioned upon node reference
        executedRules - already executed rules
      • addRulePendingExecution

        void addRulePendingExecution​(NodeRef actionableNodeRef,
                                     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​(NodeRef actionableNodeRef,
                                     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​(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

        ChildAssociationRef getSavedRuleFolderAssoc​(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