Package org.verapdf.pdfa.results

Interface ValidationResult

public interface ValidationResult
Created as the result of validating a PDF/A document against a ValidationProfile. The class encapsulates the following information:
  • a boolean flag indicating whether the PDF/A document validated complied with ValidationProfile.
  • the PDFAFlavour of the profile used to validate the PDF/A document.
  • a Set of TestAssertions representing the results of performing individual tests.
A particular ValidationResult instance is not guaranteed to carry all of the information generated during validation. While the isCompliant() value MUST reflect the result of validation, individual validator implementations are not obliged to record all, or any individual TestAssertions. Such implementations may choose to only record failed tests, or may be configured to abort validation after a so many failed tests.
Author:
Carl Wilson

  • Method Details

    • isCompliant

      boolean isCompliant()
      Returns:
      true if the PDF/A document complies with the PDF/A specification / flavour it was validated against.

    • getPDFAFlavour

      PDFAFlavour getPDFAFlavour()
      Returns:
      the PDFAFlavour that identifies the PDF/A specification part and conformance level enforced by the Validator that produced this result.

    • getProfileDetails

      ProfileDetails getProfileDetails()
      Returns:
      the ProfileDetails identifying the validation profile used

    • getTotalAssertions

      int getTotalAssertions()
      Returns:
      the total number of valdiation checks performed

    • getTestAssertions

      List<TestAssertion> getTestAssertions()
      Returns:
      the list of TestAssertions made during PDF/A validation

    • getValidationProfile

      ValidationProfile getValidationProfile()
      Returns:
      validation profile which has been used for generating validation result

    • getJobEndStatus

      JobEndStatus getJobEndStatus()

    • getFailedChecks

      HashMap<RuleId,Integer> getFailedChecks()