Interface RuleType

  • All Known Implementing Classes:
    RuleTypeImpl

    public interface RuleType
    Rule type interface.
    Author:
    Roy Wetherall
    • Method Detail

      • getName

        String getName()
        Get the name of the rule type.

        The name is unique and is used to identify the rule type.

        Returns:
        the name of the rule type
      • getDisplayLabel

        String getDisplayLabel()
        Get the display label of the rule type.
        Returns:
        the display label
      • triggerRuleType

        void triggerRuleType​(NodeRef nodeRef,
                             NodeRef actionedUponNodeRef,
                             boolean executeRuleImmediately)
        Trigger the rules of the rule type for the node on the actioned upon node.
        Parameters:
        nodeRef - the node ref whos rule of rule type are to be triggered
        actionedUponNodeRef - the node ref that the triggered rule will action upon
        executeRuleImmediately - indicates whether the rule should be executed immediately or not