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.Collection;
021import java.util.Collections;
022import org.opengis.annotation.UML;
023import org.opengis.util.GenericName;
024import org.opengis.metadata.citation.Citation;
025import org.opengis.metadata.distribution.StandardOrderProcess;
026
027import static org.opengis.annotation.Obligation.*;
028import static org.opengis.annotation.Specification.*;
029
030
031/**
032 * Identification of capabilities which a service provider makes available.
033 * The services are provided to a user through a set of interfaces that define a behaviour.
034 *
035 * @author  Rémi Maréchal (Geomatys)
036 * @version 3.1
037 * @since   2.0
038 */
039@UML(identifier="SV_ServiceIdentification", specification=ISO_19115)
040public interface ServiceIdentification extends Identification {
041    /**
042     * A service type name.
043     * <div class="note"><b>Examples:</b>
044     * "discovery", "view", "download", "transformation", or "invoke".
045     * </div>
046     *
047     * @return a service type name.
048     *
049     * @since 3.1
050     */
051    @UML(identifier="serviceType", obligation=MANDATORY, specification=ISO_19115)
052    GenericName getServiceType();
053
054    /**
055     * The version(s) of the service.
056     * Supports searching based on the version of {@linkplain #getServiceType() service type}.
057     *
058     * <div class="note"><b>Example:</b>
059     * we might only be interested in OGC Catalogue V1.1 services.
060     * If version is maintained as a separate attribute, users can easily search
061     * for all services of a type regardless of the version.
062     * </div>
063     *
064     * @return the version of the service, supports searching based on the version of serviceType.
065     *
066     * @since 3.1
067     */
068    @UML(identifier="serviceTypeVersion", obligation=OPTIONAL, specification=ISO_19115)
069    default Collection<String> getServiceTypeVersions() {
070        return Collections.emptySet();          // Use Set instead of List for hash-safe final classes.
071    }
072
073    /**
074     * Information about the availability of the service.
075     * This includes:
076     * <ul>
077     *   <li>fee</li>
078     *   <li>planned available date and time</li>
079     *   <li>ordering instructions</li>
080     *   <li>turnaround</li>
081     * </ul>
082     *
083     * @return information about the availability of the service, or {@code null} if none.
084     *
085     * @since 3.1
086     */
087    @UML(identifier="accessProperties", obligation=OPTIONAL, specification=ISO_19115)
088    default StandardOrderProcess getAccessProperties() {
089        return null;
090    }
091
092    /**
093     * Type of coupling between service and associated data (if exist).
094     *
095     * @return type of coupling between service and associated data, or {@code null} if none.
096     *
097     * @condition mandatory if {@link #getCoupledResources() coupledResources} is not provided.
098     *
099     * @since 3.1
100     */
101    @UML(identifier="couplingType", obligation=CONDITIONAL, specification=ISO_19115)
102    CouplingType getCouplingType();
103
104    /**
105     * Further description(s) of the data coupling in the case of tightly coupled services.
106     * Returns an empty collection if none.
107     *
108     * @return further description of the data coupling in the case of tightly coupled services.
109     *
110     * @condition mandatory if {@link #getCouplingType() couplingType} is not provided.
111     *
112     * @since 3.1
113     */
114    @UML(identifier="coupledResource", obligation=CONDITIONAL, specification=ISO_19115)
115    Collection<? extends CoupledResource> getCoupledResources();
116
117    /**
118     * Provides reference(s) to the resources on which the service operates.
119     * Returns an empty collection if none.
120     *
121     * @return reference(s) to the resource on which the service operates.
122     *
123     * @condition For one resource either {@code operatedDataset} or {@link #getOperatesOn() operatesOn}
124     *            may be used (not both for the same resource).
125     *
126     * @since 3.1
127     */
128    @UML(identifier="operatedDataset", obligation=OPTIONAL, specification=ISO_19115)
129    default Collection<? extends Citation> getOperatedDatasets() {
130        return Collections.emptyList();
131    }
132
133    /**
134     * Profile(s) to which the service adheres.
135     * Returns an empty collection if none.
136     *
137     * @return profile(s) to which the service adheres.
138     *
139     * @since 3.1
140     */
141    @UML(identifier="profile", obligation=OPTIONAL, specification=ISO_19115)
142    default Collection<? extends Citation> getProfiles() {
143        return Collections.emptyList();
144    }
145
146    /**
147     * Standard(s) to which the service adheres.
148     * Returns an empty collection if none.
149     *
150     * @return standard(s) to which the service adheres.
151     *
152     * @since 3.1
153     */
154    @UML(identifier="serviceStandard", obligation=OPTIONAL, specification=ISO_19115)
155    default Collection<? extends Citation> getServiceStandards() {
156        return Collections.emptyList();
157    }
158
159    /**
160     * Provides information about the operations that comprise the service.
161     * Returns an empty collection if none.
162     *
163     * @return information about the operations that comprise the service.
164     *
165     * @since 3.1
166     */
167    @UML(identifier="containsOperations", obligation=OPTIONAL, specification=ISO_19115)
168    default Collection<? extends OperationMetadata> getContainsOperations() {
169        return Collections.emptyList();
170    }
171
172    /**
173     * Provides information on the resources that the service operates on.
174     * Returns an empty collection if none.
175     *
176     * @return information on the resources that the service operates on.
177     *
178     * @condition For one resource either {@link #getOperatedDatasets() operatedDataset}
179     *            or {@code operatesOn} may be used (not both for the same resource).
180     *
181     * @since 3.1
182     */
183    @UML(identifier="operatesOn", obligation=OPTIONAL, specification=ISO_19115)
184    default Collection<? extends DataIdentification> getOperatesOn() {
185        return Collections.emptyList();
186    }
187
188    /**
189     * Provides information about the chain applied by the service.
190     * Returns an empty collection if none.
191     *
192     * @return information about the chain applied by the service.
193     *
194     * @since 3.1
195     */
196    @UML(identifier="containsChain", obligation=OPTIONAL, specification=ISO_19115)
197    default Collection<? extends OperationChainMetadata> getContainsChain() {
198        return Collections.emptyList();
199    }
200}