001package ezvcard.property;
002
003import java.util.List;
004
005import ezvcard.SupportedVersions;
006import ezvcard.VCardVersion;
007import ezvcard.parameter.Pid;
008
009/*
010 Copyright (c) 2012-2023, Michael Angstadt
011 All rights reserved.
012
013 Redistribution and use in source and binary forms, with or without
014 modification, are permitted provided that the following conditions are met: 
015
016 1. Redistributions of source code must retain the above copyright notice, this
017 list of conditions and the following disclaimer. 
018 2. Redistributions in binary form must reproduce the above copyright notice,
019 this list of conditions and the following disclaimer in the documentation
020 and/or other materials provided with the distribution. 
021
022 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
023 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
024 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
025 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
026 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
027 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
028 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
029 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
030 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
031 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
032
033 The views and conclusions contained in the software and documentation are those
034 of the authors and should not be interpreted as representing official policies, 
035 either expressed or implied, of the FreeBSD Project.
036 */
037
038/**
039 * <p>
040 * Defines a URL to use for sending a scheduling request to the person's
041 * calendar.
042 * </p>
043 * 
044 * <p>
045 * <b>Code sample</b>
046 * </p>
047 * 
048 * <pre class="brush:java">
049 * VCard vcard = new VCard();
050 * 
051 * CalendarRequestUri caladruri = new CalendarRequestUri("mailto:janedoe@ibm.com");
052 * vcard.addCalendarRequestUri(caladruri);
053 * </pre>
054 * 
055 * <p>
056 * <b>Property name:</b> {@code CALADRURI}
057 * </p>
058 * <p>
059 * <b>Supported versions:</b> {@code 4.0}
060 * </p>
061 * @author Michael Angstadt
062 * @see <a href="http://tools.ietf.org/html/rfc6350#page-50">RFC 6350 p.50</a>
063 */
064@SupportedVersions(VCardVersion.V4_0)
065public class CalendarRequestUri extends UriProperty implements HasAltId {
066        /**
067         * Creates a calendar request URI property.
068         * @param uri the calendar request URI
069         */
070        public CalendarRequestUri(String uri) {
071                super(uri);
072        }
073
074        /**
075         * Copy constructor.
076         * @param original the property to make a copy of
077         */
078        public CalendarRequestUri(CalendarRequestUri original) {
079                super(original);
080        }
081
082        /**
083         * Gets the MEDIATYPE parameter.
084         * <p>
085         * <b>Supported versions:</b> {@code 4.0}
086         * </p>
087         * @return the media type or null if not set
088         */
089        public String getMediaType() {
090                return parameters.getMediaType();
091        }
092
093        /**
094         * Sets the MEDIATYPE parameter.
095         * <p>
096         * <b>Supported versions:</b> {@code 4.0}
097         * </p>
098         * @param mediaType the media type or null to remove
099         */
100        public void setMediaType(String mediaType) {
101                parameters.setMediaType(mediaType);
102        }
103
104        @Override
105        public List<Pid> getPids() {
106                return super.getPids();
107        }
108
109        @Override
110        public Integer getPref() {
111                return super.getPref();
112        }
113
114        @Override
115        public void setPref(Integer pref) {
116                super.setPref(pref);
117        }
118
119        //@Override
120        public String getAltId() {
121                return parameters.getAltId();
122        }
123
124        //@Override
125        public void setAltId(String altId) {
126                parameters.setAltId(altId);
127        }
128
129        /**
130         * Gets the TYPE parameter.
131         * <p>
132         * <b>Supported versions:</b> {@code 4.0}
133         * </p>
134         * @return the TYPE value (typically, this will be either "work" or "home")
135         * or null if it doesn't exist
136         */
137        public String getType() {
138                return parameters.getType();
139        }
140
141        /**
142         * Sets the TYPE parameter.
143         * <p>
144         * <b>Supported versions:</b> {@code 4.0}
145         * </p>
146         * @param type the TYPE value (this should be either "work" or "home") or
147         * null to remove
148         */
149        public void setType(String type) {
150                parameters.setType(type);
151        }
152
153        @Override
154        public CalendarRequestUri copy() {
155                return new CalendarRequestUri(this);
156        }
157}