001 /** 002 * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved. 003 * 004 * This library is free software; you can redistribute it and/or modify it under 005 * the terms of the GNU Lesser General Public License as published by the Free 006 * Software Foundation; either version 2.1 of the License, or (at your option) 007 * any later version. 008 * 009 * This library is distributed in the hope that it will be useful, but WITHOUT 010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 011 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 012 * details. 013 */ 014 015 package com.liferay.portal.model; 016 017 import com.liferay.portal.kernel.bean.AutoEscape; 018 import com.liferay.portal.kernel.exception.SystemException; 019 import com.liferay.portal.service.ServiceContext; 020 021 import com.liferay.portlet.expando.model.ExpandoBridge; 022 023 import java.io.Serializable; 024 025 import java.util.Date; 026 027 /** 028 * The base model interface for the Address service. Represents a row in the "Address" database table, with each column mapped to a property of this class. 029 * 030 * <p> 031 * This interface and its corresponding implementation {@link com.liferay.portal.model.impl.AddressModelImpl} exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in {@link com.liferay.portal.model.impl.AddressImpl}. 032 * </p> 033 * 034 * @author Brian Wing Shun Chan 035 * @see Address 036 * @see com.liferay.portal.model.impl.AddressImpl 037 * @see com.liferay.portal.model.impl.AddressModelImpl 038 * @generated 039 */ 040 public interface AddressModel extends AttachedModel, AuditedModel, 041 BaseModel<Address> { 042 /* 043 * NOTE FOR DEVELOPERS: 044 * 045 * Never modify or reference this interface directly. All methods that expect a address model instance should use the {@link Address} interface instead. 046 */ 047 048 /** 049 * Returns the primary key of this address. 050 * 051 * @return the primary key of this address 052 */ 053 public long getPrimaryKey(); 054 055 /** 056 * Sets the primary key of this address. 057 * 058 * @param primaryKey the primary key of this address 059 */ 060 public void setPrimaryKey(long primaryKey); 061 062 /** 063 * Returns the address ID of this address. 064 * 065 * @return the address ID of this address 066 */ 067 public long getAddressId(); 068 069 /** 070 * Sets the address ID of this address. 071 * 072 * @param addressId the address ID of this address 073 */ 074 public void setAddressId(long addressId); 075 076 /** 077 * Returns the company ID of this address. 078 * 079 * @return the company ID of this address 080 */ 081 public long getCompanyId(); 082 083 /** 084 * Sets the company ID of this address. 085 * 086 * @param companyId the company ID of this address 087 */ 088 public void setCompanyId(long companyId); 089 090 /** 091 * Returns the user ID of this address. 092 * 093 * @return the user ID of this address 094 */ 095 public long getUserId(); 096 097 /** 098 * Sets the user ID of this address. 099 * 100 * @param userId the user ID of this address 101 */ 102 public void setUserId(long userId); 103 104 /** 105 * Returns the user uuid of this address. 106 * 107 * @return the user uuid of this address 108 * @throws SystemException if a system exception occurred 109 */ 110 public String getUserUuid() throws SystemException; 111 112 /** 113 * Sets the user uuid of this address. 114 * 115 * @param userUuid the user uuid of this address 116 */ 117 public void setUserUuid(String userUuid); 118 119 /** 120 * Returns the user name of this address. 121 * 122 * @return the user name of this address 123 */ 124 @AutoEscape 125 public String getUserName(); 126 127 /** 128 * Sets the user name of this address. 129 * 130 * @param userName the user name of this address 131 */ 132 public void setUserName(String userName); 133 134 /** 135 * Returns the create date of this address. 136 * 137 * @return the create date of this address 138 */ 139 public Date getCreateDate(); 140 141 /** 142 * Sets the create date of this address. 143 * 144 * @param createDate the create date of this address 145 */ 146 public void setCreateDate(Date createDate); 147 148 /** 149 * Returns the modified date of this address. 150 * 151 * @return the modified date of this address 152 */ 153 public Date getModifiedDate(); 154 155 /** 156 * Sets the modified date of this address. 157 * 158 * @param modifiedDate the modified date of this address 159 */ 160 public void setModifiedDate(Date modifiedDate); 161 162 /** 163 * Returns the fully qualified class name of this address. 164 * 165 * @return the fully qualified class name of this address 166 */ 167 public String getClassName(); 168 169 public void setClassName(String className); 170 171 /** 172 * Returns the class name ID of this address. 173 * 174 * @return the class name ID of this address 175 */ 176 public long getClassNameId(); 177 178 /** 179 * Sets the class name ID of this address. 180 * 181 * @param classNameId the class name ID of this address 182 */ 183 public void setClassNameId(long classNameId); 184 185 /** 186 * Returns the class p k of this address. 187 * 188 * @return the class p k of this address 189 */ 190 public long getClassPK(); 191 192 /** 193 * Sets the class p k of this address. 194 * 195 * @param classPK the class p k of this address 196 */ 197 public void setClassPK(long classPK); 198 199 /** 200 * Returns the street1 of this address. 201 * 202 * @return the street1 of this address 203 */ 204 @AutoEscape 205 public String getStreet1(); 206 207 /** 208 * Sets the street1 of this address. 209 * 210 * @param street1 the street1 of this address 211 */ 212 public void setStreet1(String street1); 213 214 /** 215 * Returns the street2 of this address. 216 * 217 * @return the street2 of this address 218 */ 219 @AutoEscape 220 public String getStreet2(); 221 222 /** 223 * Sets the street2 of this address. 224 * 225 * @param street2 the street2 of this address 226 */ 227 public void setStreet2(String street2); 228 229 /** 230 * Returns the street3 of this address. 231 * 232 * @return the street3 of this address 233 */ 234 @AutoEscape 235 public String getStreet3(); 236 237 /** 238 * Sets the street3 of this address. 239 * 240 * @param street3 the street3 of this address 241 */ 242 public void setStreet3(String street3); 243 244 /** 245 * Returns the city of this address. 246 * 247 * @return the city of this address 248 */ 249 @AutoEscape 250 public String getCity(); 251 252 /** 253 * Sets the city of this address. 254 * 255 * @param city the city of this address 256 */ 257 public void setCity(String city); 258 259 /** 260 * Returns the zip of this address. 261 * 262 * @return the zip of this address 263 */ 264 @AutoEscape 265 public String getZip(); 266 267 /** 268 * Sets the zip of this address. 269 * 270 * @param zip the zip of this address 271 */ 272 public void setZip(String zip); 273 274 /** 275 * Returns the region ID of this address. 276 * 277 * @return the region ID of this address 278 */ 279 public long getRegionId(); 280 281 /** 282 * Sets the region ID of this address. 283 * 284 * @param regionId the region ID of this address 285 */ 286 public void setRegionId(long regionId); 287 288 /** 289 * Returns the country ID of this address. 290 * 291 * @return the country ID of this address 292 */ 293 public long getCountryId(); 294 295 /** 296 * Sets the country ID of this address. 297 * 298 * @param countryId the country ID of this address 299 */ 300 public void setCountryId(long countryId); 301 302 /** 303 * Returns the type ID of this address. 304 * 305 * @return the type ID of this address 306 */ 307 public int getTypeId(); 308 309 /** 310 * Sets the type ID of this address. 311 * 312 * @param typeId the type ID of this address 313 */ 314 public void setTypeId(int typeId); 315 316 /** 317 * Returns the mailing of this address. 318 * 319 * @return the mailing of this address 320 */ 321 public boolean getMailing(); 322 323 /** 324 * Returns <code>true</code> if this address is mailing. 325 * 326 * @return <code>true</code> if this address is mailing; <code>false</code> otherwise 327 */ 328 public boolean isMailing(); 329 330 /** 331 * Sets whether this address is mailing. 332 * 333 * @param mailing the mailing of this address 334 */ 335 public void setMailing(boolean mailing); 336 337 /** 338 * Returns the primary of this address. 339 * 340 * @return the primary of this address 341 */ 342 public boolean getPrimary(); 343 344 /** 345 * Returns <code>true</code> if this address is primary. 346 * 347 * @return <code>true</code> if this address is primary; <code>false</code> otherwise 348 */ 349 public boolean isPrimary(); 350 351 /** 352 * Sets whether this address is primary. 353 * 354 * @param primary the primary of this address 355 */ 356 public void setPrimary(boolean primary); 357 358 public boolean isNew(); 359 360 public void setNew(boolean n); 361 362 public boolean isCachedModel(); 363 364 public void setCachedModel(boolean cachedModel); 365 366 public boolean isEscapedModel(); 367 368 public Serializable getPrimaryKeyObj(); 369 370 public void setPrimaryKeyObj(Serializable primaryKeyObj); 371 372 public ExpandoBridge getExpandoBridge(); 373 374 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 375 376 public Object clone(); 377 378 public int compareTo(Address address); 379 380 public int hashCode(); 381 382 public CacheModel<Address> toCacheModel(); 383 384 public Address toEscapedModel(); 385 386 public Address toUnescapedModel(); 387 388 public String toString(); 389 390 public String toXmlString(); 391 }