001package ezvcard.property;
002
003import java.util.List;
004
005import ezvcard.parameter.Pid;
006
007/*
008 Copyright (c) 2012-2023, 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 The views and conclusions contained in the software and documentation are those
032 of the authors and should not be interpreted as representing official policies, 
033 either expressed or implied, of the FreeBSD Project.
034 */
035
036/**
037 * <p>
038 * Defines a list of organizations the person belongs to. The list is ordered.
039 * It begins with the broadest organization and ends with the most specific.
040 * </p>
041 * 
042 * <p>
043 * <b>Code sample</b>
044 * </p>
045 * 
046 * <pre class="brush:java">
047 * VCard vcard = new VCard();
048 * 
049 * Organization org = new Organization();
050 * org.getValues().add("Google");
051 * org.getValues().add("GMail Team");
052 * org.getValues().add("Spam Detection Team");
053 * vcard.setOrganization(org);
054 * </pre>
055 * 
056 * <p>
057 * <b>Property name:</b> {@code ORG}
058 * </p>
059 * <p>
060 * <b>Supported versions:</b> {@code 2.1, 3.0, 4.0}
061 * </p>
062 * @author Michael Angstadt
063 * @see <a href="http://tools.ietf.org/html/rfc6350#page-40">RFC 6350 p.40</a>
064 * @see <a href="http://tools.ietf.org/html/rfc2426#page-20">RFC 2426 p.20</a>
065 * @see <a href="http://www.imc.org/pdi/vcard-21.doc">vCard 2.1 p.19</a>
066 */
067public class Organization extends TextListProperty implements HasAltId {
068        public Organization() {
069                //empty
070        }
071
072        /**
073         * Copy constructor.
074         * @param original the property to make a copy of
075         */
076        public Organization(Organization original) {
077                super(original);
078        }
079
080        @Override
081        public String getLanguage() {
082                return super.getLanguage();
083        }
084
085        @Override
086        public void setLanguage(String language) {
087                super.setLanguage(language);
088        }
089
090        /**
091         * Gets the TYPE parameter.
092         * <p>
093         * <b>Supported versions:</b> {@code 4.0}
094         * </p>
095         * @return the TYPE value (typically, this will be either "work" or "home")
096         * or null if it doesn't exist
097         */
098        public String getType() {
099                return parameters.getType();
100        }
101
102        /**
103         * Sets the TYPE parameter.
104         * <p>
105         * <b>Supported versions:</b> {@code 4.0}
106         * </p>
107         * @param type the TYPE value (this should be either "work" or "home") or
108         * null to remove
109         */
110        public void setType(String type) {
111                parameters.setType(type);
112        }
113
114        @Override
115        public List<Pid> getPids() {
116                return super.getPids();
117        }
118
119        @Override
120        public Integer getPref() {
121                return super.getPref();
122        }
123
124        @Override
125        public void setPref(Integer pref) {
126                super.setPref(pref);
127        }
128
129        //@Override
130        public String getAltId() {
131                return parameters.getAltId();
132        }
133
134        //@Override
135        public void setAltId(String altId) {
136                parameters.setAltId(altId);
137        }
138
139        /**
140         * <p>
141         * Gets the list that holds string(s) which define how to sort the vCard.
142         * </p>
143         * <p>
144         * 2.1 and 3.0 vCards should use the {@link SortString} property instead.
145         * </p>
146         * <p>
147         * <b>Supported versions:</b> {@code 4.0}
148         * </p>
149         * @return the sort string(s) (this list is mutable)
150         */
151        public List<String> getSortAs() {
152                return parameters.getSortAs();
153        }
154
155        /**
156         * <p>
157         * Sets the sort string for this property.
158         * </p>
159         * <p>
160         * 2.1 and 3.0 vCards should use the {@link SortString} property instead.
161         * </p>
162         * <p>
163         * <b>Supported versions:</b> {@code 4.0}
164         * </p>
165         * @param sortString the sort string or null to remove
166         */
167        public void setSortAs(String sortString) {
168                parameters.setSortAs(sortString);
169        }
170
171        @Override
172        public Organization copy() {
173                return new Organization(this);
174        }
175}