001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2009-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.lineage;
019
020import org.opengis.annotation.UML;
021import org.opengis.util.InternationalString;
022
023import static org.opengis.annotation.Obligation.*;
024import static org.opengis.annotation.Specification.*;
025
026
027/**
028 * Report of what occurred during the process step.
029 *
030 * @author  Cédric Briançon (Geomatys)
031 * @version 3.1
032 * @since   2.3
033 */
034@UML(identifier="LE_ProcessStepReport", specification=ISO_19115_2)
035public interface ProcessStepReport {
036    /**
037     * Name of the processing report.
038     *
039     * @return name of the processing report.
040     */
041    @UML(identifier="name", obligation=MANDATORY, specification=ISO_19115_2)
042    InternationalString getName();
043
044    /**
045     * Textual description of what occurred during the process step.
046     *
047     * @return what occurred during the process step, or {@code null}.
048     */
049    @UML(identifier="description", obligation=OPTIONAL, specification=ISO_19115_2)
050    default InternationalString getDescription() {
051        return null;
052    }
053
054    /**
055     * Type of file that contains the processing report.
056     *
057     * @return type of file that contains the processing report, or {@code null}.
058     */
059    @UML(identifier="fileType", obligation=OPTIONAL, specification=ISO_19115_2)
060    default InternationalString getFileType() {
061        return null;
062    }
063}