com.wci.umls.server.ValidationResult Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2015 West Coast Informatics, LLC
 */
package com.wci.umls.server;

import java.util.Set;

/**
 * Generically represents a validation result, either an error or a warning.
 */
public interface ValidationResult {

  /**
   * Checks if is valid.
   * 
   * @return true, if is valid
   */
  public boolean isValid();

  /**
   * Gets the errors.
   * 
   * @return the errors
   */
  public Set getErrors();

  /**
   * Sets the errors.
   * 
   * @param errors the new errors
   */
  public void setErrors(Set errors);

  /**
   * Gets the warnings.
   * 
   * @return the warnings
   */
  public Set getWarnings();

  /**
   * Returns the comments.
   *
   * @return the comments
   */
  public Set getComments();

  /**
   * Sets the warnings.
   * 
   * @param warnings the new warnings
   */
  public void setWarnings(Set warnings);

  /**
   * Sets the comments.
   *
   * @param comments the comments
   */
  public void setComments(Set comments);

  /**
   * Removewarning.
   * 
   * @param warning the warning
   */
  public void removeWarning(String warning);

  /**
   * Removes the comment.
   *
   * @param comment the comment
   */
  public void removeComment(String comment);

  /**
   * Addwarning.
   * 
   * @param warning the warning
   */
  public void addWarning(String warning);

  /**
   * Adds the comment.
   *
   * @param comment the comment
   */
  public void addComment(String comment);

  /**
   * Removes the error.
   * 
   * @param error the error
   */
  public void removeError(String error);

  /**
   * Adds the error.
   * 
   * @param error the error
   */
  public void addError(String error);

  /**
   * Adds the warnings.
   * 
   * @param warnings the warnings
   */
  public void addWarnings(Set warnings);

  /**
   * Adds the comment.
   *
   * @param comment the comment
   */
  public void addComment(Set comment);

  /**
   * Adds the errors.
   * 
   * @param errors the errors
   */
  public void addErrors(Set errors);

  /**
   * Merge a second validation result into this validation result
   * 
   * @param validationResult the validation result
   */
  public void merge(ValidationResult validationResult);

}