Package com.solibri.smc.api.checking

Interface PreCheckResult

public interface PreCheckResult
PreCheckResult provides information about the pre-check before the actual checking of the rule. Tells the caller if the rule is relevant in the current model or not i.e. whether or not checking should proceed beyond pre-check.
Since:
9.10.2

  • Method Details

    • createRelevant

      static PreCheckResult createRelevant()
      Static creation method for this interface. Returns a result where the result is not irrelevant.
      Returns:
      the created relevant-result with empty-string comment
      Since:
      9.10.2

    • createIrrelevant

      static PreCheckResult createIrrelevant()
      Static creation method for this interface. Returns a result where the result is irrelevant.
      Returns:
      the created irrelevant-result with empty-string comment
      Since:
      9.10.2

    • createRelevant

      static PreCheckResult createRelevant​(String comment)
      Static creation method for this interface. This method creates an relevant-result i.e. a pre-check result saying proceeding further with the checking process is relevant to the state of the model and the rule.
      Parameters:
      comment - a comment that relates to the content of the relevant-result
      Returns:
      the created relevant-result with comment
      Since:
      9.10.2

    • createIrrelevant

      static PreCheckResult createIrrelevant​(String comment)
      Static creation method for this interface. This method creates an irrelevant-result i.e. a pre-check result saying proceeding further with the checking is irrelevant.
      Parameters:
      comment - the comment informing the reason for the rule being irrelevant
      Returns:
      the created irrelevant result
      Since:
      9.10.2

    • isRelevant

      boolean isRelevant()
      Returns whether the rule is relevant for the current state of the model and rule.
      Returns:
      true if the rule is relevant; false otherwise
      Since:
      9.10.2

    • isIrrelevant

      boolean isIrrelevant()
      Returns whether the rule is irrelevant for the current state of the model and rule.
      Returns:
      true if the rule is irrelevant; false otherwise
      Since:
      9.10.2

    • getComment

      String getComment()
      Returns the comment or explanation on the result.
      Returns:
      the comment or explanation for the result
      Since:
      9.10.2