001    package biweekly.property;
002    
003    import biweekly.parameter.RelationshipType;
004    
005    /*
006     Copyright (c) 2013, Michael Angstadt
007     All rights reserved.
008    
009     Redistribution and use in source and binary forms, with or without
010     modification, are permitted provided that the following conditions are met: 
011    
012     1. Redistributions of source code must retain the above copyright notice, this
013     list of conditions and the following disclaimer. 
014     2. Redistributions in binary form must reproduce the above copyright notice,
015     this list of conditions and the following disclaimer in the documentation
016     and/or other materials provided with the distribution. 
017    
018     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
019     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
020     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
021     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
022     ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
023     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
024     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
025     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
026     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
027     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
028     */
029    
030    /**
031     * <p>
032     * Defines a relationship between the component that this property belongs to
033     * and another component.
034     * </p>
035     * <p>
036     * <b>Examples:</b>
037     * 
038     * <pre class="brush:java">
039     * RelatedTo relatedTo = new RelatedTo(&quot;uid-value&quot;);
040     * </pre>
041     * 
042     * </p>
043     * @author Michael Angstadt
044     * @rfc 5545 p.115-6
045     */
046    public class RelatedTo extends TextProperty {
047            /**
048             * Creates a related-to property.
049             * @param uid the value of the {@link Uid} property of the component that
050             * this property is referencing
051             */
052            public RelatedTo(String uid) {
053                    super(uid);
054            }
055    
056            /**
057             * Gets the relationship type.
058             * @return the relationship type (e.g. "child") or null if not set
059             * @rfc 5545 p.25
060             */
061            public RelationshipType getRelationshipType() {
062                    return parameters.getRelationshipType();
063            }
064    
065            /**
066             * Sets the relationship type.
067             * @param relationshipType the relationship type (e.g. "child") or null to
068             * remove
069             * @rfc 5545 p.25
070             */
071            public void setRelationshipType(RelationshipType relationshipType) {
072                    parameters.setRelationshipType(relationshipType);
073            }
074    }