Interface Rule

    • Method Detail

      • check

        void check​(CheckingSelection components,
                   ResultFactory resultFactory)
        Called to implement the check phase. All the components selected during the pre check phase must be reported as checked through the CheckingSelection instance received as parameter, during the check phase.
        Parameters:
        components - the CheckingSelection to mark components as checked
        resultFactory - the result factory used to create results for this rule
        Since:
        9.10.2
      • postCheck

        default void postCheck()
        This is called once after the checking of components. Use cases: - post calculation for the checking - analysis of the results
        Since:
        9.10.2
      • getParametersUIDefinition

        default UIContainer getParametersUIDefinition()
        Returns the container that defines the UI for the parameters view of this rule.
        Returns:
        the container that defines the parameters view of this rule
        Since:
        9.10.2
      • getParent

        default Optional<CheckingNode> getParent()
        Description copied from interface: CheckingNode
        Returns the parent of this node, if one exists. Root nodes of a ruleset hierarchy do not have a parent, but all others do have a parent ruleset, or a parent rule.
        Specified by:
        getParent in interface CheckingNode
        Returns:
        the parent node
      • getName

        default String getName()
        Description copied from interface: CheckingNode
        Returns the name of this checking node. Note that the name might be translated into different languages and should not be used as an identifier as multiple rulesets or rules with the same name might exist.
        Specified by:
        getName in interface CheckingNode
        Returns:
        the name