Interface Activation

  • All Superinterfaces:
    org.kie.api.runtime.rule.Match, Serializable
    All Known Subinterfaces:
    AgendaItem
    All Known Implementing Classes:
    AgendaItemImpl, RuleAgendaItem, RuleTerminalNodeLeftTuple, VisitedAgendaGroup

    public interface Activation
    extends Serializable, org.kie.api.runtime.rule.Match
    When a Tuple fully matches a rule it is added to the Agenda As an Activation. Each Activation is assigned a number, this number is determined by the WorkingMemory all Activations created from a single insert, update, retract are assgigned the same Activation number.
    • Method Detail

      • getRule

        RuleImpl getRule()
        Specified by:
        getRule in interface org.kie.api.runtime.rule.Match
        Returns:
        The rule that was activated.
      • getSalience

        int getSalience()
      • getSubRule

        GroupElement getSubRule()
        Retrieve the subrule that was activated.
        Returns:
      • getActivationNumber

        long getActivationNumber()
        Each PropgationContext is assigned an id from a counter for the WorkingMemory action it represents. All Activations return this id as the ActivationNumber, thus all Activations created from the same PropgationContext will return the same long for this method.
        Returns:
        The activation number
      • getTuple

        Tuple getTuple()
        Retrieve the Tuple that was activated.
        Returns:
        The tuple.
      • getPropagationContext

        PropagationContext getPropagationContext()
        Retrieve the PropagationContext for the Activation
        Returns:
        The propagation context
      • remove

        void remove()
        Cancel the Activation by removing it from the Agenda.
      • setQueued

        void setQueued​(boolean activated)
      • isQueued

        boolean isQueued()
      • setActivationGroupNode

        void setActivationGroupNode​(ActivationGroupNode activationGroupNode)
      • setActivationNode

        void setActivationNode​(ActivationNode ruleFlowGroupNode)
      • isMatched

        boolean isMatched()
      • setMatched

        void setMatched​(boolean matched)
      • isActive

        boolean isActive()
      • setActive

        void setActive​(boolean active)
      • isRuleAgendaItem

        boolean isRuleAgendaItem()
      • setQueueIndex

        void setQueueIndex​(int index)
      • getQueueIndex

        int getQueueIndex()
      • dequeue

        void dequeue()
      • getObjectsDeep

        default List<Object> getObjectsDeep()