MetacardValidationReport.java

/**
 * Copyright (c) Codice Foundation
 * <p>
 * This is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser
 * General Public License as published by the Free Software Foundation, either version 3 of the
 * License, or any later version.
 * <p>
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details. A copy of the GNU Lesser General Public License
 * is distributed along with this program and can be found at
 * <http://www.gnu.org/licenses/lgpl.html>.
 */
package ddf.catalog.validation.report;

import java.util.Set;

import ddf.catalog.validation.violation.ValidationViolation;

/**
 * Describes the outcome of validating a single {@link ddf.catalog.data.Metacard}.
 * <p>
 * <b> This code is experimental. While this interface is functional and tested, it may change or be
 * removed in a future version of the library. </b>
 * </p>
 */
public interface MetacardValidationReport {
    /**
     * Returns the set of {@link ValidationViolation}s representing the attribute-level
     * violations on the validated {@link ddf.catalog.data.Metacard}.
     * <p>
     * If there are no attribute-level violations, this method just returns an empty set.
     *
     * @return the set of attribute-level violations or an empty set if there are none
     */
    Set<ValidationViolation> getAttributeValidationViolations();

    /**
     * Returns the set of {@link ValidationViolation}s representing the metacard-level
     * violations on the validated {@link ddf.catalog.data.Metacard}.
     * <p>
     * If there are no metacard-level violations, this method just returns an empty set.
     *
     * @return the set of metacard-level violations or an empty set if there are none
     */
    Set<ValidationViolation> getMetacardValidationViolations();
}