001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2004-2023 Open Geospatial Consortium, Inc.
004 *    http://www.geoapi.org
005 *
006 *    Licensed under the Apache License, Version 2.0 (the "License");
007 *    you may not use this file except in compliance with the License.
008 *    You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *    Unless required by applicable law or agreed to in writing, software
013 *    distributed under the License is distributed on an "AS IS" BASIS,
014 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 *    See the License for the specific language governing permissions and
016 *    limitations under the License.
017 */
018package org.opengis.metadata.quality;
019
020import java.time.temporal.Temporal;
021import org.opengis.annotation.UML;
022import org.opengis.annotation.Classifier;
023import org.opengis.annotation.Stereotype;
024import org.opengis.metadata.maintenance.Scope;
025
026import static org.opengis.annotation.Obligation.*;
027import static org.opengis.annotation.Specification.*;
028
029
030/**
031 * Base interface of more specific result classes.
032 * At least one data quality result shall be provided for each {@linkplain Element data quality element}.
033 * Different types of results can be provided for the same data quality elements. This could be
034 * a {@linkplain QuantitativeResult quantitative result},
035 * a {@linkplain ConformanceResult conformance result},
036 * a {@linkplain DescriptiveResult descriptive result} or
037 * a {@linkplain CoverageResult coverage result}.
038 *
039 * @author  Martin Desruisseaux (IRD)
040 * @author  Alexis Gaillard (Geomatys)
041 * @version 3.1
042 *
043 * @see Element#getResults()
044 *
045 * @since 2.0
046 *
047 * @todo Renamed in 19157:2022: {@code QualityResult}.
048 */
049@Classifier(Stereotype.ABSTRACT)
050@UML(identifier="DQ_Result", specification=ISO_19157)
051public interface Result {
052    /**
053     * Scope of the result.
054     * Quality frequently differs between various parts of the data set for which quality is evaluated.
055     * Therefore several evaluations may be applied for the same {@linkplain Element data quality element}.
056     * To avoid repeating the measure and evaluation procedure descriptions in several instances of {@link Element},
057     * several results with individual result scopes can be used.
058     *
059     * @return scope of the result, or {@code null} if unspecified.
060     *
061     * @see DataQuality#getScope()
062     *
063     * @since 3.1
064     */
065    @UML(identifier="resultScope", obligation=OPTIONAL, specification=ISO_19157)
066    default Scope getResultScope() {
067        return null;
068    }
069
070    /**
071     * Date when the result was generated.
072     * The returned value should be an instance of {@link java.time.LocalDate}, {@link java.time.LocalDateTime},
073     * {@link java.time.OffsetDateTime} or {@link java.time.ZonedDateTime}, depending whether hours are defined
074     * and how the timezone (if any) is defined. But other types are also allowed.
075     *
076     * @return date of the result, or {@code null} if none.
077     *
078     * @since 3.1
079     */
080    @UML(identifier="dateTime", obligation=OPTIONAL, specification=ISO_19157)
081    default Temporal getDateTime() {
082        return null;
083    }
084}