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 Contact service. Represents a row in the "Contact_" 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.ContactModelImpl} 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.ContactImpl}. 034 * </p> 035 * 036 * @author Brian Wing Shun Chan 037 * @see Contact 038 * @see com.liferay.portal.model.impl.ContactImpl 039 * @see com.liferay.portal.model.impl.ContactModelImpl 040 * @generated 041 */ 042 @ProviderType 043 public interface ContactModel extends AttachedModel, AuditedModel, 044 BaseModel<Contact> { 045 /* 046 * NOTE FOR DEVELOPERS: 047 * 048 * Never modify or reference this interface directly. All methods that expect a contact model instance should use the {@link Contact} interface instead. 049 */ 050 051 /** 052 * Returns the primary key of this contact. 053 * 054 * @return the primary key of this contact 055 */ 056 public long getPrimaryKey(); 057 058 /** 059 * Sets the primary key of this contact. 060 * 061 * @param primaryKey the primary key of this contact 062 */ 063 public void setPrimaryKey(long primaryKey); 064 065 /** 066 * Returns the contact ID of this contact. 067 * 068 * @return the contact ID of this contact 069 */ 070 public long getContactId(); 071 072 /** 073 * Sets the contact ID of this contact. 074 * 075 * @param contactId the contact ID of this contact 076 */ 077 public void setContactId(long contactId); 078 079 /** 080 * Returns the company ID of this contact. 081 * 082 * @return the company ID of this contact 083 */ 084 @Override 085 public long getCompanyId(); 086 087 /** 088 * Sets the company ID of this contact. 089 * 090 * @param companyId the company ID of this contact 091 */ 092 @Override 093 public void setCompanyId(long companyId); 094 095 /** 096 * Returns the user ID of this contact. 097 * 098 * @return the user ID of this contact 099 */ 100 @Override 101 public long getUserId(); 102 103 /** 104 * Sets the user ID of this contact. 105 * 106 * @param userId the user ID of this contact 107 */ 108 @Override 109 public void setUserId(long userId); 110 111 /** 112 * Returns the user uuid of this contact. 113 * 114 * @return the user uuid of this contact 115 * @throws SystemException if a system exception occurred 116 */ 117 @Override 118 public String getUserUuid() throws SystemException; 119 120 /** 121 * Sets the user uuid of this contact. 122 * 123 * @param userUuid the user uuid of this contact 124 */ 125 @Override 126 public void setUserUuid(String userUuid); 127 128 /** 129 * Returns the user name of this contact. 130 * 131 * @return the user name of this contact 132 */ 133 @AutoEscape 134 @Override 135 public String getUserName(); 136 137 /** 138 * Sets the user name of this contact. 139 * 140 * @param userName the user name of this contact 141 */ 142 @Override 143 public void setUserName(String userName); 144 145 /** 146 * Returns the create date of this contact. 147 * 148 * @return the create date of this contact 149 */ 150 @Override 151 public Date getCreateDate(); 152 153 /** 154 * Sets the create date of this contact. 155 * 156 * @param createDate the create date of this contact 157 */ 158 @Override 159 public void setCreateDate(Date createDate); 160 161 /** 162 * Returns the modified date of this contact. 163 * 164 * @return the modified date of this contact 165 */ 166 @Override 167 public Date getModifiedDate(); 168 169 /** 170 * Sets the modified date of this contact. 171 * 172 * @param modifiedDate the modified date of this contact 173 */ 174 @Override 175 public void setModifiedDate(Date modifiedDate); 176 177 /** 178 * Returns the fully qualified class name of this contact. 179 * 180 * @return the fully qualified class name of this contact 181 */ 182 @Override 183 public String getClassName(); 184 185 public void setClassName(String className); 186 187 /** 188 * Returns the class name ID of this contact. 189 * 190 * @return the class name ID of this contact 191 */ 192 @Override 193 public long getClassNameId(); 194 195 /** 196 * Sets the class name ID of this contact. 197 * 198 * @param classNameId the class name ID of this contact 199 */ 200 @Override 201 public void setClassNameId(long classNameId); 202 203 /** 204 * Returns the class p k of this contact. 205 * 206 * @return the class p k of this contact 207 */ 208 @Override 209 public long getClassPK(); 210 211 /** 212 * Sets the class p k of this contact. 213 * 214 * @param classPK the class p k of this contact 215 */ 216 @Override 217 public void setClassPK(long classPK); 218 219 /** 220 * Returns the account ID of this contact. 221 * 222 * @return the account ID of this contact 223 */ 224 public long getAccountId(); 225 226 /** 227 * Sets the account ID of this contact. 228 * 229 * @param accountId the account ID of this contact 230 */ 231 public void setAccountId(long accountId); 232 233 /** 234 * Returns the parent contact ID of this contact. 235 * 236 * @return the parent contact ID of this contact 237 */ 238 public long getParentContactId(); 239 240 /** 241 * Sets the parent contact ID of this contact. 242 * 243 * @param parentContactId the parent contact ID of this contact 244 */ 245 public void setParentContactId(long parentContactId); 246 247 /** 248 * Returns the email address of this contact. 249 * 250 * @return the email address of this contact 251 */ 252 @AutoEscape 253 public String getEmailAddress(); 254 255 /** 256 * Sets the email address of this contact. 257 * 258 * @param emailAddress the email address of this contact 259 */ 260 public void setEmailAddress(String emailAddress); 261 262 /** 263 * Returns the first name of this contact. 264 * 265 * @return the first name of this contact 266 */ 267 @AutoEscape 268 public String getFirstName(); 269 270 /** 271 * Sets the first name of this contact. 272 * 273 * @param firstName the first name of this contact 274 */ 275 public void setFirstName(String firstName); 276 277 /** 278 * Returns the middle name of this contact. 279 * 280 * @return the middle name of this contact 281 */ 282 @AutoEscape 283 public String getMiddleName(); 284 285 /** 286 * Sets the middle name of this contact. 287 * 288 * @param middleName the middle name of this contact 289 */ 290 public void setMiddleName(String middleName); 291 292 /** 293 * Returns the last name of this contact. 294 * 295 * @return the last name of this contact 296 */ 297 @AutoEscape 298 public String getLastName(); 299 300 /** 301 * Sets the last name of this contact. 302 * 303 * @param lastName the last name of this contact 304 */ 305 public void setLastName(String lastName); 306 307 /** 308 * Returns the prefix ID of this contact. 309 * 310 * @return the prefix ID of this contact 311 */ 312 public int getPrefixId(); 313 314 /** 315 * Sets the prefix ID of this contact. 316 * 317 * @param prefixId the prefix ID of this contact 318 */ 319 public void setPrefixId(int prefixId); 320 321 /** 322 * Returns the suffix ID of this contact. 323 * 324 * @return the suffix ID of this contact 325 */ 326 public int getSuffixId(); 327 328 /** 329 * Sets the suffix ID of this contact. 330 * 331 * @param suffixId the suffix ID of this contact 332 */ 333 public void setSuffixId(int suffixId); 334 335 /** 336 * Returns the male of this contact. 337 * 338 * @return the male of this contact 339 */ 340 public boolean getMale(); 341 342 /** 343 * Returns <code>true</code> if this contact is male. 344 * 345 * @return <code>true</code> if this contact is male; <code>false</code> otherwise 346 */ 347 public boolean isMale(); 348 349 /** 350 * Sets whether this contact is male. 351 * 352 * @param male the male of this contact 353 */ 354 public void setMale(boolean male); 355 356 /** 357 * Returns the birthday of this contact. 358 * 359 * @return the birthday of this contact 360 */ 361 public Date getBirthday(); 362 363 /** 364 * Sets the birthday of this contact. 365 * 366 * @param birthday the birthday of this contact 367 */ 368 public void setBirthday(Date birthday); 369 370 /** 371 * Returns the sms sn of this contact. 372 * 373 * @return the sms sn of this contact 374 */ 375 @AutoEscape 376 public String getSmsSn(); 377 378 /** 379 * Sets the sms sn of this contact. 380 * 381 * @param smsSn the sms sn of this contact 382 */ 383 public void setSmsSn(String smsSn); 384 385 /** 386 * Returns the aim sn of this contact. 387 * 388 * @return the aim sn of this contact 389 */ 390 @AutoEscape 391 public String getAimSn(); 392 393 /** 394 * Sets the aim sn of this contact. 395 * 396 * @param aimSn the aim sn of this contact 397 */ 398 public void setAimSn(String aimSn); 399 400 /** 401 * Returns the facebook sn of this contact. 402 * 403 * @return the facebook sn of this contact 404 */ 405 @AutoEscape 406 public String getFacebookSn(); 407 408 /** 409 * Sets the facebook sn of this contact. 410 * 411 * @param facebookSn the facebook sn of this contact 412 */ 413 public void setFacebookSn(String facebookSn); 414 415 /** 416 * Returns the icq sn of this contact. 417 * 418 * @return the icq sn of this contact 419 */ 420 @AutoEscape 421 public String getIcqSn(); 422 423 /** 424 * Sets the icq sn of this contact. 425 * 426 * @param icqSn the icq sn of this contact 427 */ 428 public void setIcqSn(String icqSn); 429 430 /** 431 * Returns the jabber sn of this contact. 432 * 433 * @return the jabber sn of this contact 434 */ 435 @AutoEscape 436 public String getJabberSn(); 437 438 /** 439 * Sets the jabber sn of this contact. 440 * 441 * @param jabberSn the jabber sn of this contact 442 */ 443 public void setJabberSn(String jabberSn); 444 445 /** 446 * Returns the msn sn of this contact. 447 * 448 * @return the msn sn of this contact 449 */ 450 @AutoEscape 451 public String getMsnSn(); 452 453 /** 454 * Sets the msn sn of this contact. 455 * 456 * @param msnSn the msn sn of this contact 457 */ 458 public void setMsnSn(String msnSn); 459 460 /** 461 * Returns the my space sn of this contact. 462 * 463 * @return the my space sn of this contact 464 */ 465 @AutoEscape 466 public String getMySpaceSn(); 467 468 /** 469 * Sets the my space sn of this contact. 470 * 471 * @param mySpaceSn the my space sn of this contact 472 */ 473 public void setMySpaceSn(String mySpaceSn); 474 475 /** 476 * Returns the skype sn of this contact. 477 * 478 * @return the skype sn of this contact 479 */ 480 @AutoEscape 481 public String getSkypeSn(); 482 483 /** 484 * Sets the skype sn of this contact. 485 * 486 * @param skypeSn the skype sn of this contact 487 */ 488 public void setSkypeSn(String skypeSn); 489 490 /** 491 * Returns the twitter sn of this contact. 492 * 493 * @return the twitter sn of this contact 494 */ 495 @AutoEscape 496 public String getTwitterSn(); 497 498 /** 499 * Sets the twitter sn of this contact. 500 * 501 * @param twitterSn the twitter sn of this contact 502 */ 503 public void setTwitterSn(String twitterSn); 504 505 /** 506 * Returns the ym sn of this contact. 507 * 508 * @return the ym sn of this contact 509 */ 510 @AutoEscape 511 public String getYmSn(); 512 513 /** 514 * Sets the ym sn of this contact. 515 * 516 * @param ymSn the ym sn of this contact 517 */ 518 public void setYmSn(String ymSn); 519 520 /** 521 * Returns the employee status ID of this contact. 522 * 523 * @return the employee status ID of this contact 524 */ 525 @AutoEscape 526 public String getEmployeeStatusId(); 527 528 /** 529 * Sets the employee status ID of this contact. 530 * 531 * @param employeeStatusId the employee status ID of this contact 532 */ 533 public void setEmployeeStatusId(String employeeStatusId); 534 535 /** 536 * Returns the employee number of this contact. 537 * 538 * @return the employee number of this contact 539 */ 540 @AutoEscape 541 public String getEmployeeNumber(); 542 543 /** 544 * Sets the employee number of this contact. 545 * 546 * @param employeeNumber the employee number of this contact 547 */ 548 public void setEmployeeNumber(String employeeNumber); 549 550 /** 551 * Returns the job title of this contact. 552 * 553 * @return the job title of this contact 554 */ 555 @AutoEscape 556 public String getJobTitle(); 557 558 /** 559 * Sets the job title of this contact. 560 * 561 * @param jobTitle the job title of this contact 562 */ 563 public void setJobTitle(String jobTitle); 564 565 /** 566 * Returns the job class of this contact. 567 * 568 * @return the job class of this contact 569 */ 570 @AutoEscape 571 public String getJobClass(); 572 573 /** 574 * Sets the job class of this contact. 575 * 576 * @param jobClass the job class of this contact 577 */ 578 public void setJobClass(String jobClass); 579 580 /** 581 * Returns the hours of operation of this contact. 582 * 583 * @return the hours of operation of this contact 584 */ 585 @AutoEscape 586 public String getHoursOfOperation(); 587 588 /** 589 * Sets the hours of operation of this contact. 590 * 591 * @param hoursOfOperation the hours of operation of this contact 592 */ 593 public void setHoursOfOperation(String hoursOfOperation); 594 595 @Override 596 public boolean isNew(); 597 598 @Override 599 public void setNew(boolean n); 600 601 @Override 602 public boolean isCachedModel(); 603 604 @Override 605 public void setCachedModel(boolean cachedModel); 606 607 @Override 608 public boolean isEscapedModel(); 609 610 @Override 611 public Serializable getPrimaryKeyObj(); 612 613 @Override 614 public void setPrimaryKeyObj(Serializable primaryKeyObj); 615 616 @Override 617 public ExpandoBridge getExpandoBridge(); 618 619 @Override 620 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 621 622 @Override 623 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 624 625 @Override 626 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 627 628 @Override 629 public Object clone(); 630 631 @Override 632 public int compareTo(Contact contact); 633 634 @Override 635 public int hashCode(); 636 637 @Override 638 public CacheModel<Contact> toCacheModel(); 639 640 @Override 641 public Contact toEscapedModel(); 642 643 @Override 644 public Contact toUnescapedModel(); 645 646 @Override 647 public String toString(); 648 649 @Override 650 public String toXmlString(); 651 }