00001 /* 00002 * Funambol is a mobile platform developed by Funambol, Inc. 00003 * Copyright (C) 2003 - 2007 Funambol, Inc. 00004 * 00005 * This program is free software; you can redistribute it and/or modify it under 00006 * the terms of the GNU Affero General Public License version 3 as published by 00007 * the Free Software Foundation with the addition of the following permission 00008 * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED 00009 * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE 00010 * WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS. 00011 * 00012 * This program is distributed in the hope that it will be useful, but WITHOUT 00013 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 00014 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 00015 * details. 00016 * 00017 * You should have received a copy of the GNU Affero General Public License 00018 * along with this program; if not, see http://www.gnu.org/licenses or write to 00019 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 00020 * MA 02110-1301 USA. 00021 * 00022 * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite 00023 * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com. 00024 * 00025 * The interactive user interfaces in modified source and object code versions 00026 * of this program must display Appropriate Legal Notices, as required under 00027 * Section 5 of the GNU Affero General Public License version 3. 00028 * 00029 * In accordance with Section 7(b) of the GNU Affero General Public License 00030 * version 3, these Appropriate Legal Notices must retain the display of the 00031 * "Powered by Funambol" logo. If the display of the logo is not reasonably 00032 * feasible for technical reasons, the Appropriate Legal Notices must display 00033 * the words "Powered by Funambol". 00034 */ 00035 00036 00037 // 00038 // @author Stefano Fornari @ Funambol 00039 // @version $Id: Name.h,v 1.7 2008-04-11 08:17:13 marco_garatti Exp $ 00040 // 00041 00042 #ifndef INCL_PIM_NAME 00043 #define INCL_PIM_NAME 00044 /** @cond DEV */ 00045 00046 #include "vocl/vCard/vCardProperty.h" 00047 #include "base/globalsdef.h" 00048 00049 BEGIN_NAMESPACE 00050 00051 class Name { 00052 00053 // ------------------------------------------------------------ Private data 00054 00055 private: 00056 vCardProperty* salutation ; 00057 vCardProperty* firstName ; 00058 vCardProperty* middleName ; 00059 vCardProperty* lastName ; 00060 vCardProperty* suffix ; 00061 vCardProperty* displayName; 00062 vCardProperty* nickname ; 00063 00064 /** 00065 * Sets the given property address to a clone of the given property. If 00066 * oldProperty is not null the pointed object is deleted. 00067 * 00068 * @param oldProperty Property** to the address of the property to set 00069 * @param newProperty the new property to set 00070 */ 00071 void set(vCardProperty** oldProperty, vCardProperty& newProperty); 00072 00073 // -------------------------------------------- Constructors and Destructors 00074 00075 public: 00076 Name(); 00077 ~Name(); 00078 00079 // ---------------------------------------------------------- Public methods 00080 00081 /** 00082 * Returns the salutation for this name 00083 * 00084 * @return the salutation for this name or NULL if not specified 00085 */ 00086 vCardProperty* getSalutation (); 00087 00088 /** 00089 * Sets the salutation. The given property is cloned, so that the 00090 * caller can independently release it as needed. 00091 */ 00092 void setSalutation(vCardProperty& p); 00093 00094 /** 00095 * Returns the first name for this name 00096 * 00097 * @return the first name for this name or NULL if not specified 00098 */ 00099 vCardProperty* getFirstName (); 00100 00101 /** 00102 * Sets the first name. The given property is cloned, so that the 00103 * caller can independently release it as needed. 00104 */ 00105 void setFirstName(vCardProperty& p); 00106 00107 /** 00108 * Returns the middle name for this name 00109 * 00110 * @return the middle name for this name or NULL if not specified 00111 */ 00112 vCardProperty* getMiddleName (); 00113 00114 /** 00115 * Sets the middle name. The given property is cloned, so that the 00116 * caller can independently release it as needed. 00117 */ 00118 void setMiddleName(vCardProperty& p); 00119 00120 /** 00121 * Returns the last name for this name 00122 * 00123 * @return the last name for this name or NULL if not specified 00124 */ 00125 vCardProperty* getLastName (); 00126 00127 /** 00128 * Sets the last name. The given property is cloned, so that the 00129 * caller can independently release it as needed. 00130 */ 00131 void setLastName(vCardProperty& p); 00132 00133 /** 00134 * Returns the suffix for this name 00135 * 00136 * @return the suffix for this name or NULL if not specified 00137 */ 00138 vCardProperty* getSuffix (); 00139 00140 /** 00141 * Sets the suffix. The given property is cloned, so that the 00142 * caller can independently release it as needed. 00143 */ 00144 void setSuffix(vCardProperty& p); 00145 00146 /** 00147 * Returns the display name for this name 00148 * 00149 * @return the display name for this name or NULL if not specified 00150 */ 00151 vCardProperty* getDisplayName (); 00152 00153 /** 00154 * Sets the display name. The given property is cloned, so that the 00155 * caller can independently release it as needed. 00156 */ 00157 void setDisplayName(vCardProperty& p); 00158 00159 /** 00160 * Returns the nickname for this name 00161 * 00162 * @return the nickname for this name or NULL if not specified 00163 */ 00164 vCardProperty* getNickname (); 00165 00166 /** 00167 * Sets the nickname. The given property is cloned, so that the 00168 * caller can independently release it as needed. 00169 */ 00170 void setNickname(vCardProperty& p); 00171 00172 /** 00173 * Creates and returns a new Name object. The object is created with 00174 * the C++ new operator and must be deallocated with the delete C++ 00175 * operator 00176 */ 00177 Name* clone(); 00178 }; 00179 00180 00181 END_NAMESPACE 00182 00183 /** @endcond */ 00184 #endif