001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 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.referencing;
019
020import org.opengis.metadata.extent.Extent;
021import org.opengis.util.InternationalString;
022import org.opengis.annotation.UML;
023
024import static org.opengis.annotation.Obligation.*;
025import static org.opengis.annotation.Specification.*;
026
027
028/**
029 * Scope and domain of validity of a CRS-related object.
030 * The scope is a description of the primary purpose to which a coordinate reference system,
031 * datum or coordinate system is applied. The domain of validity describes the spatial and
032 * temporal extent in which the object can be used.
033 *
034 * @author  OGC Topic 2 (for abstract model and documentation)
035 * @author  Martin Desruisseaux (Geomatys)
036 * @version 3.1
037 * @since   3.1
038 */
039@UML(identifier="ObjectDomain", specification=ISO_19111)
040public interface ObjectDomain {
041    /**
042     * Key for the <code>{@value}</code> property to be given to the
043     * {@linkplain org.opengis.referencing.ObjectFactory CRS factory} {@code createFoo(Map, ...)} methods.
044     * It can be used as an alternative to {@link org.opengis.referencing.IdentifiedObject#DOMAINS_KEY}
045     * for setting the value to be returned by {@link #getScope()}.
046     *
047     * @see ObjectFactory
048     * @see #getScope()
049     */
050    String SCOPE_KEY = "scope";
051
052    /**
053     * Key for the <code>{@value}</code> property to be given to the
054     * {@linkplain org.opengis.referencing.ObjectFactory CRS factory} {@code createFoo(Map, ...)} methods.
055     * It can be used as an alternative to {@link org.opengis.referencing.IdentifiedObject#DOMAINS_KEY}
056     * for setting the value to be returned by {@link #getDomainOfValidity()}.
057     *
058     * @see ObjectFactory
059     * @see #getDomainOfValidity()
060     */
061    String DOMAIN_OF_VALIDITY_KEY = "domainOfValidity";
062
063    /**
064     * Description of usage, or limitations of usage, for which this object is valid.
065     * If unknown, the text should be "not known".
066     *
067     * @return the domain of usage.
068     */
069    @UML(identifier="scope", obligation=MANDATORY, specification=ISO_19111)
070    InternationalString getScope();
071
072    /**
073     * Spatial and temporal extent in which this object is valid.
074     *
075     * @return the area or time frame of usage.
076     */
077    @UML(identifier="domainOfValidity", obligation=MANDATORY, specification=ISO_19111)
078    Extent getDomainOfValidity();
079}