001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2014-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;
019
020import org.opengis.annotation.UML;
021import org.opengis.metadata.maintenance.ScopeCode;
022import org.opengis.util.InternationalString;
023
024import static org.opengis.annotation.Obligation.*;
025import static org.opengis.annotation.Specification.ISO_19115;
026
027
028/**
029 * Class of information to which the referencing entity applies.
030 *
031 * @author  Rémi Maréchal (Geomatys)
032 * @version 3.1
033 * @since   3.1
034 */
035@UML(identifier="MD_MetadataScope", specification=ISO_19115)
036public interface MetadataScope {
037    /**
038     * Code for the scope.
039     *
040     * @return code for the scope.
041     */
042    @UML(identifier="resourceScope", obligation=MANDATORY, specification=ISO_19115)
043    ScopeCode getResourceScope();
044
045    /**
046     * Description of the scope.
047     * May be {@code null} if unspecified.
048     *
049     * @return the description of the scope, or {@code null} if none.
050     */
051    @UML(identifier="name", obligation=OPTIONAL, specification=ISO_19115)
052    default InternationalString getName() {
053        return null;
054    }
055}