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;
030
031import java.net.URI;
032
033import edu.umd.cs.findbugs.annotations.NonNull;
034
035/**
036 * Provides information about an individual finding that is the result of a
037 * completed content validation.
038 */
039public interface IValidationFinding {
040  /**
041   * Get the finding's severity.
042   *
043   * @return the severity
044   */
045  @NonNull
046  IConstraint.Level getSeverity();
047
048  /**
049   * Get the document's URI.
050   *
051   * @return the document's URI
052   */
053  @NonNull
054  URI getDocumentUri();
055  //
056  // /**
057  // * Get the line on which the finding occurred.
058  // *
059  // * @return the line number or {@code null} if unknown
060  // */
061  // Integer getLineNumber();
062  //
063  // /**
064  // * Get the line column on which the finding occurred.
065  // *
066  // * @return the column umber or {@code null} if unknown
067  // */
068  // Integer getColumnNumber();
069
070  /**
071   * Get the finding message.
072   *
073   * @return the message
074   */
075  @NonNull
076  CharSequence getMessage();
077
078  /**
079   * Get the exception associated with the finding.
080   *
081   * @return the {@link Throwable} or {@code null} if no thowable is associated
082   *         with the finding
083   */
084  Throwable getCause();
085}