001 /** 002 * Copyright (c) 2000-2013 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 aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.bean.AutoEscape; 020 import com.liferay.portal.kernel.exception.SystemException; 021 import com.liferay.portal.service.ServiceContext; 022 023 import com.liferay.portlet.expando.model.ExpandoBridge; 024 025 import java.io.Serializable; 026 027 import java.util.Date; 028 029 /** 030 * 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. 031 * 032 * <p> 033 * 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}. 034 * </p> 035 * 036 * @author Brian Wing Shun Chan 037 * @see Address 038 * @see com.liferay.portal.model.impl.AddressImpl 039 * @see com.liferay.portal.model.impl.AddressModelImpl 040 * @generated 041 */ 042 @ProviderType 043 public interface AddressModel extends AttachedModel, BaseModel<Address>, 044 StagedAuditedModel { 045 /* 046 * NOTE FOR DEVELOPERS: 047 * 048 * Never modify or reference this interface directly. All methods that expect a address model instance should use the {@link Address} interface instead. 049 */ 050 051 /** 052 * Returns the primary key of this address. 053 * 054 * @return the primary key of this address 055 */ 056 public long getPrimaryKey(); 057 058 /** 059 * Sets the primary key of this address. 060 * 061 * @param primaryKey the primary key of this address 062 */ 063 public void setPrimaryKey(long primaryKey); 064 065 /** 066 * Returns the uuid of this address. 067 * 068 * @return the uuid of this address 069 */ 070 @AutoEscape 071 @Override 072 public String getUuid(); 073 074 /** 075 * Sets the uuid of this address. 076 * 077 * @param uuid the uuid of this address 078 */ 079 @Override 080 public void setUuid(String uuid); 081 082 /** 083 * Returns the address ID of this address. 084 * 085 * @return the address ID of this address 086 */ 087 public long getAddressId(); 088 089 /** 090 * Sets the address ID of this address. 091 * 092 * @param addressId the address ID of this address 093 */ 094 public void setAddressId(long addressId); 095 096 /** 097 * Returns the company ID of this address. 098 * 099 * @return the company ID of this address 100 */ 101 @Override 102 public long getCompanyId(); 103 104 /** 105 * Sets the company ID of this address. 106 * 107 * @param companyId the company ID of this address 108 */ 109 @Override 110 public void setCompanyId(long companyId); 111 112 /** 113 * Returns the user ID of this address. 114 * 115 * @return the user ID of this address 116 */ 117 @Override 118 public long getUserId(); 119 120 /** 121 * Sets the user ID of this address. 122 * 123 * @param userId the user ID of this address 124 */ 125 @Override 126 public void setUserId(long userId); 127 128 /** 129 * Returns the user uuid of this address. 130 * 131 * @return the user uuid of this address 132 * @throws SystemException if a system exception occurred 133 */ 134 @Override 135 public String getUserUuid() throws SystemException; 136 137 /** 138 * Sets the user uuid of this address. 139 * 140 * @param userUuid the user uuid of this address 141 */ 142 @Override 143 public void setUserUuid(String userUuid); 144 145 /** 146 * Returns the user name of this address. 147 * 148 * @return the user name of this address 149 */ 150 @AutoEscape 151 @Override 152 public String getUserName(); 153 154 /** 155 * Sets the user name of this address. 156 * 157 * @param userName the user name of this address 158 */ 159 @Override 160 public void setUserName(String userName); 161 162 /** 163 * Returns the create date of this address. 164 * 165 * @return the create date of this address 166 */ 167 @Override 168 public Date getCreateDate(); 169 170 /** 171 * Sets the create date of this address. 172 * 173 * @param createDate the create date of this address 174 */ 175 @Override 176 public void setCreateDate(Date createDate); 177 178 /** 179 * Returns the modified date of this address. 180 * 181 * @return the modified date of this address 182 */ 183 @Override 184 public Date getModifiedDate(); 185 186 /** 187 * Sets the modified date of this address. 188 * 189 * @param modifiedDate the modified date of this address 190 */ 191 @Override 192 public void setModifiedDate(Date modifiedDate); 193 194 /** 195 * Returns the fully qualified class name of this address. 196 * 197 * @return the fully qualified class name of this address 198 */ 199 @Override 200 public String getClassName(); 201 202 public void setClassName(String className); 203 204 /** 205 * Returns the class name ID of this address. 206 * 207 * @return the class name ID of this address 208 */ 209 @Override 210 public long getClassNameId(); 211 212 /** 213 * Sets the class name ID of this address. 214 * 215 * @param classNameId the class name ID of this address 216 */ 217 @Override 218 public void setClassNameId(long classNameId); 219 220 /** 221 * Returns the class p k of this address. 222 * 223 * @return the class p k of this address 224 */ 225 @Override 226 public long getClassPK(); 227 228 /** 229 * Sets the class p k of this address. 230 * 231 * @param classPK the class p k of this address 232 */ 233 @Override 234 public void setClassPK(long classPK); 235 236 /** 237 * Returns the street1 of this address. 238 * 239 * @return the street1 of this address 240 */ 241 @AutoEscape 242 public String getStreet1(); 243 244 /** 245 * Sets the street1 of this address. 246 * 247 * @param street1 the street1 of this address 248 */ 249 public void setStreet1(String street1); 250 251 /** 252 * Returns the street2 of this address. 253 * 254 * @return the street2 of this address 255 */ 256 @AutoEscape 257 public String getStreet2(); 258 259 /** 260 * Sets the street2 of this address. 261 * 262 * @param street2 the street2 of this address 263 */ 264 public void setStreet2(String street2); 265 266 /** 267 * Returns the street3 of this address. 268 * 269 * @return the street3 of this address 270 */ 271 @AutoEscape 272 public String getStreet3(); 273 274 /** 275 * Sets the street3 of this address. 276 * 277 * @param street3 the street3 of this address 278 */ 279 public void setStreet3(String street3); 280 281 /** 282 * Returns the city of this address. 283 * 284 * @return the city of this address 285 */ 286 @AutoEscape 287 public String getCity(); 288 289 /** 290 * Sets the city of this address. 291 * 292 * @param city the city of this address 293 */ 294 public void setCity(String city); 295 296 /** 297 * Returns the zip of this address. 298 * 299 * @return the zip of this address 300 */ 301 @AutoEscape 302 public String getZip(); 303 304 /** 305 * Sets the zip of this address. 306 * 307 * @param zip the zip of this address 308 */ 309 public void setZip(String zip); 310 311 /** 312 * Returns the region ID of this address. 313 * 314 * @return the region ID of this address 315 */ 316 public long getRegionId(); 317 318 /** 319 * Sets the region ID of this address. 320 * 321 * @param regionId the region ID of this address 322 */ 323 public void setRegionId(long regionId); 324 325 /** 326 * Returns the country ID of this address. 327 * 328 * @return the country ID of this address 329 */ 330 public long getCountryId(); 331 332 /** 333 * Sets the country ID of this address. 334 * 335 * @param countryId the country ID of this address 336 */ 337 public void setCountryId(long countryId); 338 339 /** 340 * Returns the type ID of this address. 341 * 342 * @return the type ID of this address 343 */ 344 public int getTypeId(); 345 346 /** 347 * Sets the type ID of this address. 348 * 349 * @param typeId the type ID of this address 350 */ 351 public void setTypeId(int typeId); 352 353 /** 354 * Returns the mailing of this address. 355 * 356 * @return the mailing of this address 357 */ 358 public boolean getMailing(); 359 360 /** 361 * Returns <code>true</code> if this address is mailing. 362 * 363 * @return <code>true</code> if this address is mailing; <code>false</code> otherwise 364 */ 365 public boolean isMailing(); 366 367 /** 368 * Sets whether this address is mailing. 369 * 370 * @param mailing the mailing of this address 371 */ 372 public void setMailing(boolean mailing); 373 374 /** 375 * Returns the primary of this address. 376 * 377 * @return the primary of this address 378 */ 379 public boolean getPrimary(); 380 381 /** 382 * Returns <code>true</code> if this address is primary. 383 * 384 * @return <code>true</code> if this address is primary; <code>false</code> otherwise 385 */ 386 public boolean isPrimary(); 387 388 /** 389 * Sets whether this address is primary. 390 * 391 * @param primary the primary of this address 392 */ 393 public void setPrimary(boolean primary); 394 395 @Override 396 public boolean isNew(); 397 398 @Override 399 public void setNew(boolean n); 400 401 @Override 402 public boolean isCachedModel(); 403 404 @Override 405 public void setCachedModel(boolean cachedModel); 406 407 @Override 408 public boolean isEscapedModel(); 409 410 @Override 411 public Serializable getPrimaryKeyObj(); 412 413 @Override 414 public void setPrimaryKeyObj(Serializable primaryKeyObj); 415 416 @Override 417 public ExpandoBridge getExpandoBridge(); 418 419 @Override 420 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 421 422 @Override 423 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 424 425 @Override 426 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 427 428 @Override 429 public Object clone(); 430 431 @Override 432 public int compareTo(Address address); 433 434 @Override 435 public int hashCode(); 436 437 @Override 438 public CacheModel<Address> toCacheModel(); 439 440 @Override 441 public Address toEscapedModel(); 442 443 @Override 444 public Address toUnescapedModel(); 445 446 @Override 447 public String toString(); 448 449 @Override 450 public String toXmlString(); 451 }