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: Address.h,v 1.7 2008-04-11 08:17:13 marco_garatti Exp $ 00040 // 00041 00042 #ifndef INCL_PIM_ADDRESS 00043 #define INCL_PIM_ADDRESS 00044 /** @cond DEV */ 00045 00046 #include "vocl/vCard/vCardProperty.h" 00047 #include "base/globalsdef.h" 00048 00049 BEGIN_NAMESPACE 00050 00051 /** 00052 * An object representing an address 00053 */ 00054 class Address { 00055 00056 // ------------------------------------------------------------ Private data 00057 00058 private: 00059 vCardProperty* postOfficeAddress; 00060 vCardProperty* roomNumber; 00061 vCardProperty* street; 00062 vCardProperty* city; 00063 vCardProperty* state; 00064 vCardProperty* postalCode; 00065 vCardProperty* country; 00066 vCardProperty* label; 00067 00068 /** 00069 * Sets the given property address to a clone of the given property. If 00070 * oldProperty is not null the pointed object is deleted. 00071 * 00072 * @param oldProperty Property** to the address of the property to set 00073 * @param newProperty the new property to set 00074 */ 00075 void set(vCardProperty** oldProperty, vCardProperty& newProperty); 00076 00077 // -------------------------------------------- Constructors and Destructors 00078 public: 00079 /** 00080 * Creates an empty address 00081 */ 00082 Address(); 00083 ~Address(); 00084 00085 // ---------------------------------------------------------- Public methods 00086 00087 /** 00088 * Returns the post office of this address 00089 * 00090 * @return the post office of this address or NULL if not defined 00091 */ 00092 vCardProperty* getPostOfficeAddress (); 00093 00094 /** 00095 * Sets the address post office. The given property is cloned, so that the 00096 * caller can independently release it as needed. 00097 */ 00098 void setPostOfficeAddress(vCardProperty& p); 00099 00100 /** 00101 * Returns the address room number of this address 00102 * 00103 * @return the room number of this address or NULL if not defined 00104 */ 00105 vCardProperty* getRoomNumber () ; 00106 00107 /** 00108 * Sets the address room number. The given property is cloned, so that the 00109 * caller can independently release it as needed. 00110 */ 00111 void setRoomNumber(vCardProperty& p); 00112 00113 /** 00114 * Returns the street of this address 00115 * 00116 * @return the street of this address or NULL if not defined 00117 */ 00118 vCardProperty* getStreet () ; 00119 00120 /** 00121 * Sets the address street. The given property is cloned, so that the 00122 * caller can independently release it as needed. 00123 */ 00124 void setStreet(vCardProperty& p); 00125 00126 /** 00127 * Returns the city of this address 00128 * 00129 * @return the city of this address or NULL if not defined 00130 */ 00131 vCardProperty* getCity () ; 00132 00133 /** 00134 * Sets the address city. The given property is cloned, so that the 00135 * caller can independently release it as needed. 00136 */ 00137 void setCity(vCardProperty& p); 00138 00139 /** 00140 * Returns the state of this address 00141 * 00142 * @return the state of this address or NULL if not defined 00143 */ 00144 vCardProperty* getState () ; 00145 00146 /** 00147 * Sets the address state. The given property is cloned, so that the 00148 * caller can independently release it as needed. 00149 */ 00150 void setState(vCardProperty& p); 00151 00152 /** 00153 * Returns the postal code of this address 00154 * 00155 * @return the postal code of this address or NULL if not defined 00156 */ 00157 vCardProperty* getPostalCode () ; 00158 00159 /** 00160 * Sets the address post office. The given property is cloned, so that the 00161 * caller can independently release it as needed. 00162 */ 00163 void setPostalCode(vCardProperty& p); 00164 00165 /** 00166 * Returns the country of this address 00167 * 00168 * @return the country of this address or NULL if not defined 00169 */ 00170 vCardProperty* getCountry () ; 00171 00172 /** 00173 * Sets the address country. The given property is cloned, so that the 00174 * caller can independently release it as needed. 00175 */ 00176 void setCountry(vCardProperty& p); 00177 00178 /** 00179 * Returns the label of this address 00180 * 00181 * @return the label of this address or NULL if not defined 00182 */ 00183 vCardProperty* getLabel () ; 00184 00185 /** 00186 * Sets the address label. The given property is cloned, so that the 00187 * caller can independently release it as needed. 00188 */ 00189 void setLabel(vCardProperty& p); 00190 00191 /** 00192 * Creates and returns a new Address object. The object is created with 00193 * the C++ new operator and must be deallocated with the delete C++ 00194 * operator 00195 */ 00196 Address* clone(); 00197 00198 }; 00199 00200 00201 END_NAMESPACE 00202 00203 /** @endcond */ 00204 #endif