001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2006-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.temporal;
033    
034    import java.util.Date;
035    import java.sql.Time;
036    import org.opengis.util.InternationalString;
037    import org.opengis.annotation.UML;
038    
039    import static org.opengis.annotation.Obligation.*;
040    import static org.opengis.annotation.Specification.*;
041    
042    
043    /**
044     * A union class that consists of one of the data types listed as its attributes.
045     * Date, Time, and DateTime are basic data types defined in ISO/TS 19103,
046     * and may be used for describing temporal positions referenced to the
047     * Gregorian calendar and UTC.
048     *
049     * @author Alexander Petkov
050     * @author Martin Desruisseaux (IRD)
051     *
052     */
053    @UML(identifier="TM_Position", specification=ISO_19108)
054    public interface Position {
055        /**
056         * {@linkplain TemporalPosition} and its subtypes shall be used
057         * for describing temporal positions referenced to other reference systems, and may be used for
058         * temporal positions referenced to any calendar or clock, including the Gregorian calendar and UTC.
059         * @return TemporalPosition
060         */
061        @UML(identifier="anyOther", obligation=OPTIONAL, specification=ISO_19108)
062        TemporalPosition anyOther();
063    
064        /**
065         * May be used for describing temporal positions in ISO8601 format referenced to the
066         * Gregorian calendar and UTC.
067         * @return {@linkplain InternationalString}
068         */
069        @UML(identifier="date8601", obligation=OPTIONAL, specification=ISO_19108)
070        Date getDate();
071    
072        /**
073         * May be used for describing temporal positions in ISO8601 format referenced to the
074         * Gregorian calendar and UTC.
075         * @return {@linkplain InternationalString}
076         */
077        @UML(identifier="time8601", obligation=OPTIONAL, specification=ISO_19108)
078        Time getTime();
079    
080        /**
081         * May be used for describing temporal positions in ISO8601 format referenced to the
082         * Gregorian calendar and UTC.
083         * @return {@linkplain InternationalString}
084         */
085        @UML(identifier="dateTime8601", obligation=OPTIONAL, specification=ISO_19108)
086        InternationalString getDateTime();
087    
088    }