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.maintenance;
019
020import java.util.Collection;
021import java.util.Collections;
022import org.opengis.annotation.UML;
023import org.opengis.annotation.Classifier;
024import org.opengis.annotation.Stereotype;
025import org.opengis.metadata.extent.Extent;
026
027import static org.opengis.annotation.Obligation.*;
028import static org.opengis.annotation.Specification.*;
029
030
031/**
032 * The target resource and physical extent for which information is reported.
033 *
034 * @author  Martin Desruisseaux (IRD, Geomatys)
035 * @version 3.1
036 * @since   3.1
037 */
038@Classifier(Stereotype.DATATYPE)
039@UML(identifier="MD_Scope", specification=ISO_19115)
040public interface Scope {
041    /**
042     * Hierarchical level of the data specified by the scope.
043     *
044     * @return hierarchical level of the data.
045     */
046    @UML(identifier="level", obligation=MANDATORY, specification=ISO_19115)
047    ScopeCode getLevel();
048
049    /**
050     * Information about the spatial, vertical and temporal extents of the resource specified by the scope.
051     *
052     * @return information about the extent of the resource.
053     */
054    @UML(identifier="extent", obligation=OPTIONAL, specification=ISO_19115)
055    default Collection<? extends Extent> getExtents() {
056        return Collections.emptyList();
057    }
058
059    /**
060     * Detailed description about the level of the data specified by the scope.
061     *
062     * @return detailed description about the level of the data.
063     */
064    @UML(identifier="levelDescription", obligation=OPTIONAL, specification=ISO_19115)
065    default Collection<? extends ScopeDescription> getLevelDescription() {
066        return Collections.emptyList();
067    }
068}