001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2022-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 org.opengis.util.InternationalString;
021import org.opengis.annotation.UML;
022
023import static org.opengis.annotation.Obligation.*;
024import static org.opengis.annotation.Specification.*;
025
026
027/**
028 * Data quality descriptive result.
029 * In some cases, it is not possible to produce a {@linkplain QuantitativeResult quantitative result}
030 * for a {@linkplain Element data quality element}. A subjective evaluation of an element can then be
031 * expressed with a textual statement as a data quality descriptive result.
032 * This descriptive result can also be used to provide a short synthetic description of the result
033 * of the data quality evaluation, to accompany the complete quantitative result.
034 *
035 * @author  Alexis Gaillard (Geomatys)
036 * @author  Martin Desruisseaux (Geomatys)
037 * @version 3.1
038 * @since   3.1
039 */
040@UML(identifier="DQ_DescriptiveResult", specification=ISO_19157)
041public interface DescriptiveResult extends Result {
042    /**
043     * Textual expression of the descriptive result.
044     *
045     * @return textual expression of the result.
046     */
047    @UML(identifier="statement", obligation=MANDATORY, specification=ISO_19157)
048    InternationalString getStatement();
049}