001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2009-2013 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.acquisition;
033    
034    import java.util.Collection;
035    
036    import org.opengis.annotation.UML;
037    import org.opengis.metadata.citation.Citation;
038    import org.opengis.metadata.identification.Progress;
039    
040    import static org.opengis.annotation.Obligation.*;
041    import static org.opengis.annotation.Specification.*;
042    
043    
044    /**
045     * Designations for the planning information related to meeting the data acquisition requirements.
046     *
047     * @author  Cédric Briançon (Geomatys)
048     * @version 3.0
049     * @since   2.3
050     *
051     * @navassoc 1 - - GeometryType
052     * @navassoc 1 - - Progress
053     * @navassoc 1 - - Citation
054     * @navassoc - - - Operations
055     * @navassoc - - - Requirement
056     */
057    @UML(identifier="MI_Plan", specification=ISO_19115_2)
058    public interface Plan {
059        /**
060         * Manner of sampling geometry that the planner expects for collection of objective data.
061         *
062         * @return Manner of sampling geometry.
063         */
064        @UML(identifier="type", obligation=OPTIONAL, specification=ISO_19115_2)
065        GeometryType getType();
066    
067        /**
068         * Current status of the plan (pending, completed, etc.)
069         *
070         * @return Current status of the plan.
071         */
072        @UML(identifier="status", obligation=MANDATORY, specification=ISO_19115_2)
073        Progress getStatus();
074    
075        /**
076         * Identification of authority requesting target collection.
077         *
078         * @return Identification of authority requesting target collection.
079         */
080        @UML(identifier="citation", obligation=MANDATORY, specification=ISO_19115_2)
081        Citation getCitation();
082    
083        /**
084         * Identification of the activity or activities that satisfy a plan.
085         *
086         * @return Identification of the activity or activities.
087         */
088        @UML(identifier="operation", obligation=OPTIONAL, specification=ISO_19115_2)
089        Collection<? extends Operation> getOperations();
090    
091        /**
092         * Requirement satisfied by the plan.
093         *
094         * @return Requirement satisfied by the plan.
095         */
096        @UML(identifier="satisfiedRequirement", obligation=OPTIONAL, specification=ISO_19115_2)
097        Collection<? extends Requirement> getSatisfiedRequirements();
098    }