Module dev.metaschema.core
Package dev.metaschema.core.model.validation

Interface IValidationResult

All Known Implementing Classes:
AggregateValidationResult, FindingCollectingConstraintValidationHandler
public interface IValidationResult
Provides data that is the result of a completed content validation.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final IValidationResult
    PASSING_RESULT
    A validation result indicating no validation errors were found.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<? extends IValidationFinding>
    getFindings()
    Get the list of validation findings, which may be empty.
    IConstraint.Level
    getHighestSeverity()
    Get the highest finding severity level for the validation.
    default boolean
    isPassing()
    Determines if the result of validation was valid or not.

  • Field Details

    • PASSING_RESULT

      @NonNull static final IValidationResult PASSING_RESULT
      A validation result indicating no validation errors were found.

  • Method Details

    • isPassing

      default boolean isPassing()
      Determines if the result of validation was valid or not.
      Returns:
      true if the result was determined to be valid or false otherwise

    • getHighestSeverity

      @NonNull IConstraint.Level getHighestSeverity()
      Get the highest finding severity level for the validation. The level IConstraint.Level.INFORMATIONAL will be returned if no validation findings were identified.
      Returns:
      the highest finding severity level

    • getFindings

      @NonNull List<? extends IValidationFinding> getFindings()
      Get the list of validation findings, which may be empty.
      Returns:
      the list