001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2004-2024 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.citation;
019
020import java.util.Collection;
021import java.util.Collections;
022import java.util.Iterator;
023import org.opengis.util.InternationalString;
024import org.opengis.annotation.UML;
025import org.opengis.annotation.Classifier;
026import org.opengis.annotation.Stereotype;
027
028import static org.opengis.annotation.Obligation.*;
029import static org.opengis.annotation.Specification.*;
030
031
032/**
033 * Information required to enable contact with the responsible person and/or organization.
034 *
035 * @author  Martin Desruisseaux (IRD)
036 * @author  Rémi Maréchal (Geomatys)
037 * @version 3.1
038 * @since   1.0
039 */
040@Classifier(Stereotype.DATATYPE)
041@UML(identifier="CI_Contact", specification=ISO_19115)
042public interface Contact {
043    /**
044     * Telephone numbers at which the organization or individual may be contacted.
045     * Returns an empty collection if none.
046     *
047     * @return telephone numbers at which the organization or individual may be contacted.
048     *
049     * @since 3.1
050     */
051    @UML(identifier="phone", obligation=OPTIONAL, specification=ISO_19115)
052    default Collection<? extends Telephone> getPhones() {
053        return Collections.emptyList();
054    }
055
056    /**
057     * Telephone numbers at which the organization or individual may be contacted.
058     * Returns {@code null} if none.
059     *
060     * @return telephone numbers at which the organization or individual may be contacted,
061     *         or {@code null}.
062     *
063     * @deprecated As of ISO 19115:2014, replaced by {@link #getPhones()}.
064     */
065    @Deprecated(since="3.1")
066    default Telephone getPhone() {
067        Iterator<? extends Telephone> it = getPhones().iterator();
068        return it.hasNext() ? it.next() : null;
069    }
070
071    /**
072     * Physical and email addresses at which the organization or individual may be contacted.
073     * Returns an empty collection if none.
074     *
075     * @return physical and email addresses at which the organization or individual may be contacted.
076     *
077     * @since 3.1
078     */
079    @UML(identifier="address", obligation=OPTIONAL, specification=ISO_19115)
080    default Collection<? extends Address> getAddresses() {
081        return Collections.emptyList();
082    }
083
084    /**
085     * Physical and email address at which the organization or individual may be contacted.
086     * Returns {@code null} if none.
087     *
088     * @return physical and email address at which the organization or individual may be contacted,
089     *         or {@code null}.
090     *
091     * @deprecated As of ISO 19115:2014, replaced by {@link #getAddresses()}.
092     */
093    @Deprecated(since="3.1")
094    default Address getAddress() {
095        Iterator<? extends Address> it = getAddresses().iterator();
096        return it.hasNext() ? it.next() : null;
097    }
098
099    /**
100     * On-line information that can be used to contact the individual or organization.
101     * Returns an empty collection if none.
102     *
103     * @return on-line information that can be used to contact the individual or organization.
104     *
105     * @since 3.1
106     */
107    @UML(identifier="onlineResource", obligation=OPTIONAL, specification=ISO_19115)
108    default Collection<? extends OnlineResource> getOnlineResources() {
109        return Collections.emptyList();
110    }
111
112    /**
113     * On-line information that can be used to contact the individual or organization.
114     * Returns {@code null} if none.
115     *
116     * @return on-line information that can be used to contact the individual or organization,
117     *         or {@code null}.
118     *
119     * @deprecated As of ISO 19115:2014, replaced by {@link #getOnlineResources()}.
120     */
121    @Deprecated(since="3.1")
122    default OnlineResource getOnlineResource() {
123        Iterator<? extends OnlineResource> it = getOnlineResources().iterator();
124        return it.hasNext() ? it.next() : null;
125    }
126
127    /**
128     * Time period (including time zone) when individuals can contact the organization or individual.
129     * Returns {@code null} if none.
130     *
131     * <div class="warning"><b>Upcoming API change — multiplicity</b><br>
132     * As of ISO 19115:2014, this singleton has been replaced by a collection.
133     * This change may be applied in GeoAPI 4.0.
134     * </div>
135     *
136     * @return time period when individuals can contact the organization or individual.
137     */
138    @UML(identifier="hoursOfService", obligation=OPTIONAL, specification=ISO_19115)
139    default InternationalString getHoursOfService() {
140        return null;
141    }
142
143    /**
144     * Supplemental instructions on how or when to contact the individual or organization.
145     * Returns {@code null} if none.
146     *
147     * @return supplemental instructions on how or when to contact the individual or organization,
148     *         or {@code null} if none.
149     */
150    @UML(identifier="contactInstructions", obligation=OPTIONAL, specification=ISO_19115)
151    default InternationalString getContactInstructions() {
152        return null;
153    }
154
155    /**
156     * Type of the contact.
157     * Returns {@code null} if none.
158     *
159     * @return type of the contact, or {@code null} if none.
160     *
161     * @since 3.1
162     */
163    @UML(identifier="contactType", obligation=OPTIONAL, specification=ISO_19115)
164    default InternationalString getContactType() {
165        return null;
166    }
167}