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.citation;
019
020import org.opengis.util.InternationalString;
021import org.opengis.annotation.UML;
022import org.opengis.annotation.Classifier;
023import org.opengis.annotation.Stereotype;
024
025import static org.opengis.annotation.Obligation.*;
026import static org.opengis.annotation.Specification.*;
027
028
029/**
030 * Information about the series, or aggregate dataset, to which a dataset belongs.
031 *
032 * @author  Martin Desruisseaux (IRD)
033 * @version 3.1
034 * @since   1.0
035 */
036@Classifier(Stereotype.DATATYPE)
037@UML(identifier="CI_Series", specification=ISO_19115)
038public interface Series {
039    /**
040     * Name of the series, or aggregate dataset, of which the dataset is a part.
041     * Returns {@code null} if none.
042     *
043     * @return the name of the series or aggregate dataset, or {@code null}.
044     */
045    @UML(identifier="name", obligation=OPTIONAL, specification=ISO_19115)
046    default InternationalString getName() {
047        return null;
048    }
049
050    /**
051     * Information identifying the issue of the series.
052     *
053     * @return information identifying the issue of the series, or {@code null}.
054     */
055    @UML(identifier="issueIdentification", obligation=OPTIONAL, specification=ISO_19115)
056    default String getIssueIdentification() {
057        return null;
058    }
059
060    /**
061     * Details on which pages of the publication the article was published.
062     *
063     * @return details on which pages of the publication the article was published, or {@code null}.
064     */
065    @UML(identifier="page", obligation=OPTIONAL, specification=ISO_19115)
066    default String getPage() {
067        return null;
068    }
069}