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.constraint;
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 * Handling restrictions imposed on the resource or metadata for national security or similar security concerns.
029 *
030 * @author  Martin Desruisseaux (IRD)
031 * @version 3.1
032 * @since   2.0
033 */
034@UML(identifier="MD_SecurityConstraints", specification=ISO_19115)
035public interface SecurityConstraints extends Constraints {
036    /**
037     * Name of the handling restrictions on the resource.
038     *
039     * @return name of the handling restrictions on the resource.
040     */
041    @UML(identifier="classification", obligation=MANDATORY, specification=ISO_19115)
042    Classification getClassification();
043
044    /**
045     * Explanation of the application of the legal constraints or other restrictions and legal
046     * prerequisites for obtaining and using the resource.
047     *
048     * @return explanation of the application of the legal constraints, or {@code null}.
049     */
050    @UML(identifier="userNote", obligation=OPTIONAL, specification=ISO_19115)
051    default InternationalString getUserNote() {
052        return null;
053    }
054
055    /**
056     * Name of the classification system.
057     *
058     * @return name of the classification system, or {@code null}.
059     */
060    @UML(identifier="classificationSystem", obligation=OPTIONAL, specification=ISO_19115)
061    default InternationalString getClassificationSystem() {
062        return null;
063    }
064
065    /**
066     * Additional information about the restrictions on handling the resource.
067     *
068     * @return additional information about the restrictions, or {@code null}.
069     */
070    @UML(identifier="handlingDescription", obligation=OPTIONAL, specification=ISO_19115)
071    default InternationalString getHandlingDescription() {
072        return null;
073    }
074}