001/*
002 * Portions of this software was developed by employees of the National Institute
003 * of Standards and Technology (NIST), an agency of the Federal Government and is
004 * being made available as a public service. Pursuant to title 17 United States
005 * Code Section 105, works of NIST employees are not subject to copyright
006 * protection in the United States. This software may be subject to foreign
007 * copyright. Permission in the United States and in foreign countries, to the
008 * extent that NIST may hold copyright, to use, copy, modify, create derivative
009 * works, and distribute this software and its documentation without fee is hereby
010 * granted on a non-exclusive basis, provided that this notice and disclaimer
011 * of warranty appears in all copies.
012 *
013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
025 */
026
027package gov.nist.secauto.metaschema.core.model.validation;
028
029import gov.nist.secauto.metaschema.core.model.constraint.IConstraint.Level;
030
031import java.util.Collections;
032import java.util.List;
033
034import edu.umd.cs.findbugs.annotations.NonNull;
035
036/**
037 * Provides data that is the result of a completed content validation.
038 */
039public interface IValidationResult {
040  @NonNull
041  IValidationResult PASSING_RESULT = new IValidationResult() {
042
043    @Override
044    public boolean isPassing() {
045      return true;
046    }
047
048    @Override
049    public Level getHighestSeverity() {
050      return Level.INFORMATIONAL;
051    }
052
053    @SuppressWarnings("null")
054    @Override
055    public List<? extends IValidationFinding> getFindings() {
056      return Collections.emptyList();
057    }
058  };
059
060  /**
061   * Determines if the result of validation was valid or not.
062   *
063   * @return {@code true} if the result was determined to be valid or
064   *         {@code false} otherwise
065   */
066  default boolean isPassing() {
067    return getHighestSeverity().ordinal() < Level.ERROR.ordinal();
068  }
069
070  /**
071   * Get the highest finding severity level for the validation. The level
072   * {@link Level#INFORMATIONAL} will be returned if no validation findings were
073   * identified.
074   *
075   * @return the highest finding severity level
076   */
077  @NonNull
078  Level getHighestSeverity();
079
080  /**
081   * Get the list of validation findings, which may be empty.
082   *
083   * @return the list
084   */
085  @NonNull
086  List<? extends IValidationFinding> getFindings();
087}