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.identification;
019
020import java.util.Date;
021import java.util.Collection;
022import java.util.Collections;
023import org.opengis.util.InternationalString;
024import org.opengis.temporal.TemporalPrimitive;
025import org.opengis.metadata.citation.Citation;
026import org.opengis.metadata.citation.Responsibility;
027import org.opengis.metadata.citation.ResponsibleParty;
028import org.opengis.geoapi.internal.Legacy;
029import org.opengis.annotation.UML;
030
031import static org.opengis.annotation.Obligation.*;
032import static org.opengis.annotation.Specification.*;
033
034
035/**
036 * Brief description of ways in which the resource(s) is/are currently or has been used.
037 *
038 * @author  Martin Desruisseaux (IRD)
039 * @author  Rémi Maréchal (Geomatys)
040 * @version 3.1
041 * @since   2.0
042 */
043@UML(identifier="MD_Usage", specification=ISO_19115)
044public interface Usage {
045    /**
046     * Brief description of the resource and/or resource series usage.
047     *
048     * @return description of the resource usage.
049     */
050    @UML(identifier="specificUsage", obligation=MANDATORY, specification=ISO_19115)
051    InternationalString getSpecificUsage();
052
053    /**
054     * Date and time of the first use or range of uses of the resource and/or resource series.
055     *
056     * @return date of the first use of the resource, or {@code null}.
057     *
058     * @deprecated Replaced by {@link #getUsageDates()} as of ISO 19115:2014.
059     */
060    @Deprecated(since="3.1")
061    default Date getUsageDate() {
062        for (TemporalPrimitive t : getUsageDates()) {
063            Date p = Legacy.toDate(t);
064            if (p != null) {
065                return p;
066            }
067        }
068        return null;
069    }
070
071    /**
072     * Date and time of the first use or range of uses of the resource and/or resource series.
073     *
074     * @return date of the first use of the resource.
075     *
076     * @since 3.1
077     */
078    @UML(identifier="usageDateTime", obligation=OPTIONAL, specification=ISO_19115)
079    default Collection<? extends TemporalPrimitive> getUsageDates() {
080        return Collections.emptySet();
081    }
082
083    /**
084     * Applications, determined by the user for which the resource and/or resource series is not suitable.
085     *
086     * @return applications for which the resource and/or resource series is not suitable, or {@code null}.
087     */
088    @UML(identifier="userDeterminedLimitations", obligation=OPTIONAL, specification=ISO_19115)
089    default InternationalString getUserDeterminedLimitations() {
090        return null;
091    }
092
093    /**
094     * Identification of and means of communicating with person(s) and organization(s) using the resource(s).
095     * Returns an empty collection if none.
096     *
097     * <div class="warning"><b>Upcoming API change — generalization</b><br>
098     * As of ISO 19115:2014, {@code ResponsibleParty} is replaced by the {@link Responsibility} parent interface.
099     * This change may be applied in GeoAPI 4.0.
100     * </div>
101     *
102     * @return means of communicating with person(s) and organization(s) using the resource(s).
103     */
104    @UML(identifier="userContactInfo", obligation=OPTIONAL, specification=ISO_19115)
105    default Collection<? extends ResponsibleParty> getUserContactInfo() {
106        return Collections.emptyList();
107    }
108
109    /**
110     * Responses to the user-determined limitations.
111     *
112     * <div class="note"><b>Example:</b>
113     * this has been fixed in version <var>x</var>.
114     * </div>
115     *
116     * @return responses to the user-determined limitations.
117     *
118     * @since 3.1
119     */
120    @UML(identifier="response", obligation=OPTIONAL, specification=ISO_19115)
121    default Collection<? extends InternationalString> getResponses() {
122        return Collections.emptyList();
123    }
124
125    /**
126     * Publications that describe usage of data.
127     *
128     * @return publications that describe usage of data.
129     *
130     * @since 3.1
131     */
132    @UML(identifier="additionalDocumentation", obligation=OPTIONAL, specification=ISO_19115)
133    default Collection<? extends Citation> getAdditionalDocumentation() {
134        return Collections.emptyList();
135    }
136
137    /**
138     * Citations of a description of known issues associated with the resource
139     * along with proposed solutions if available.
140     *
141     * @return citations of a description of known issues associated with the resource.
142     *
143     * @since 3.1
144     */
145    @UML(identifier="identifiedIssues", obligation=OPTIONAL, specification=ISO_19115)
146    default Collection<? extends Citation> getIdentifiedIssues() {
147        return Collections.emptyList();
148    }
149}