001    package biweekly.property;
002    
003    import java.util.Date;
004    
005    import biweekly.parameter.Range;
006    
007    /*
008     Copyright (c) 2013, Michael Angstadt
009     All rights reserved.
010    
011     Redistribution and use in source and binary forms, with or without
012     modification, are permitted provided that the following conditions are met: 
013    
014     1. Redistributions of source code must retain the above copyright notice, this
015     list of conditions and the following disclaimer. 
016     2. Redistributions in binary form must reproduce the above copyright notice,
017     this list of conditions and the following disclaimer in the documentation
018     and/or other materials provided with the distribution. 
019    
020     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
021     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
022     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
023     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
024     ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
025     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
026     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
027     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
028     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
029     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
030     */
031    
032    /**
033     * Records the original value of the {@link DateStart} property if a recurrence
034     * instance has been modified. Used in conjunction with the {@link Uid} and
035     * {@link Sequence} properties to uniquely identify a recurrence instance.
036     * @author Michael Angstadt
037     * @see <a href="http://tools.ietf.org/html/rfc5545#page-112">RFC 5545
038     * p.112-4</a>
039     */
040    public class RecurrenceId extends DateOrDateTimeProperty {
041            /**
042             * Creates a recurrence ID property.
043             * @param originalStartDate the original start date
044             */
045            public RecurrenceId(Date originalStartDate) {
046                    this(originalStartDate, true);
047            }
048    
049            /**
050             * Creates a recurrence ID property.
051             * @param originalStartDate the original start date
052             * @param hasTime true to include the time component of the date, false not
053             * to
054             */
055            public RecurrenceId(Date originalStartDate, boolean hasTime) {
056                    super(originalStartDate, hasTime);
057            }
058    
059            /**
060             * Gets the effective range of recurrence instances from the instance
061             * specified by this property.
062             * @return the range or null if not set
063             * @see <a href="http://tools.ietf.org/html/rfc5545#page-23">RFC 5545
064             * p.23-4</a>
065             */
066            public Range getRange() {
067                    return parameters.getRange();
068            }
069    
070            /**
071             * Sets the effective range of recurrence instances from the instance
072             * specified by this property.
073             * @param range the range or null to remove
074             * @see <a href="http://tools.ietf.org/html/rfc5545#page-23">RFC 5545
075             * p.23-4</a>
076             */
077            public void setRange(Range range) {
078                    parameters.setRange(range);
079            }
080    }