001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2004-2012 Open Geospatial Consortium, Inc.
006     *    All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007     *
008     *    Permission to use, copy, and modify this software and its documentation, with
009     *    or without modification, for any purpose and without fee or royalty is hereby
010     *    granted, provided that you include the following on ALL copies of the software
011     *    and documentation or portions thereof, including modifications, that you make:
012     *
013     *    1. The full text of this NOTICE in a location viewable to users of the
014     *       redistributed or derivative work.
015     *    2. Notice of any changes or modifications to the OGC files, including the
016     *       date changes were made.
017     *
018     *    THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019     *    NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020     *    TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021     *    THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022     *    PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023     *
024     *    COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025     *    CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026     *
027     *    The name and trademarks of copyright holders may NOT be used in advertising or
028     *    publicity pertaining to the software without specific, written prior permission.
029     *    Title to copyright in this software and any associated documentation will at all
030     *    times remain with copyright holders.
031     */
032    package org.opengis.metadata.maintenance;
033    
034    import java.util.Collection;
035    import java.util.Date;
036    import org.opengis.metadata.citation.ResponsibleParty;
037    import org.opengis.temporal.PeriodDuration;
038    import org.opengis.util.InternationalString;
039    import org.opengis.annotation.UML;
040    
041    import static org.opengis.annotation.Obligation.*;
042    import static org.opengis.annotation.Specification.*;
043    
044    
045    /**
046     * Information about the scope and frequency of updating.
047     *
048     * @author  Martin Desruisseaux (IRD)
049     * @author  Cory Horner (Refractions Research)
050     * @version 3.0
051     * @since   2.0
052     *
053     * @navassoc 1 - - MaintenanceFrequency
054     * @navassoc 1 - - PeriodDuration
055     * @navassoc - - - ScopeCode
056     * @navassoc - - - ScopeDescription
057     * @navassoc - - - ResponsibleParty
058     */
059    @UML(identifier="MD_MaintenanceInformation", specification=ISO_19115)
060    public interface MaintenanceInformation {
061        /**
062         * Frequency with which changes and additions are made to the resource after the
063         * initial resource is completed.
064         *
065         * @return Frequency with which changes and additions are made to the resource.
066         */
067        @UML(identifier="maintenanceAndUpdateFrequency", obligation=MANDATORY, specification=ISO_19115)
068        MaintenanceFrequency getMaintenanceAndUpdateFrequency();
069    
070        /**
071         * Scheduled revision date for resource.
072         * <p>
073         * <TABLE WIDTH="80%" ALIGN="center" CELLPADDING="18" BORDER="4" BGCOLOR="#FFE0B0">
074         *   <TR><TD>
075         *     <P align="justify"><B>Warning:</B> The return type of this method may change
076         *     in GeoAPI 3.1 release. It may be replaced by a type matching more closely
077         *     either ISO 19108 (<cite>Temporal Schema</cite>) or ISO 19103.</P>
078         *   </TD></TR>
079         * </TABLE>
080         *
081         * @return Scheduled revision date, or {@code null}.
082         */
083        @UML(identifier="dateOfNextUpdate", obligation=OPTIONAL, specification=ISO_19115)
084        Date getDateOfNextUpdate();
085    
086        /**
087         * Maintenance period other than those defined.
088         *
089         * @return The Maintenance period, or {@code null}.
090         */
091        @UML(identifier="userDefinedMaintenanceFrequency", obligation=OPTIONAL, specification=ISO_19115)
092        PeriodDuration getUserDefinedMaintenanceFrequency();
093    
094        /**
095         * Scope of data to which maintenance is applied.
096         *
097         * @return Scope of data to which maintenance is applied.
098         */
099        @UML(identifier="updateScope", obligation=OPTIONAL, specification=ISO_19115)
100        Collection<ScopeCode> getUpdateScopes();
101    
102        /**
103         * Additional information about the range or extent of the resource.
104         *
105         * @return Additional information about the range or extent of the resource.
106         */
107        @UML(identifier="updateScopeDescription", obligation=OPTIONAL, specification=ISO_19115)
108        Collection<? extends ScopeDescription> getUpdateScopeDescriptions();
109    
110        /**
111         * Information regarding specific requirements for maintaining the resource.
112         *
113         * @return Information regarding specific requirements for maintaining the resource.
114         *
115         * @since 2.1
116         */
117        @UML(identifier="maintenanceNote", obligation=OPTIONAL, specification=ISO_19115)
118        Collection<? extends InternationalString> getMaintenanceNotes();
119    
120        /**
121         * Identification of, and means of communicating with,
122         * person(s) and organization(s) with responsibility for maintaining the metadata.
123         *
124         * @return Means of communicating with person(s) and organization(s) with responsibility
125         *         for maintaining the metadata.
126         *
127         * @since 2.1
128         */
129        @UML(identifier="contact", obligation=OPTIONAL, specification=ISO_19115)
130        Collection<? extends ResponsibleParty> getContacts();
131    }