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 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 User service. Represents a row in the "User_" 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.UserModelImpl} 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.UserImpl}. 032 * </p> 033 * 034 * @author Brian Wing Shun Chan 035 * @see User 036 * @see com.liferay.portal.model.impl.UserImpl 037 * @see com.liferay.portal.model.impl.UserModelImpl 038 * @generated 039 */ 040 public interface UserModel extends BaseModel<User>, StagedModel { 041 /* 042 * NOTE FOR DEVELOPERS: 043 * 044 * Never modify or reference this interface directly. All methods that expect a user model instance should use the {@link User} interface instead. 045 */ 046 047 /** 048 * Returns the primary key of this user. 049 * 050 * @return the primary key of this user 051 */ 052 public long getPrimaryKey(); 053 054 /** 055 * Sets the primary key of this user. 056 * 057 * @param primaryKey the primary key of this user 058 */ 059 public void setPrimaryKey(long primaryKey); 060 061 /** 062 * Returns the uuid of this user. 063 * 064 * @return the uuid of this user 065 */ 066 @AutoEscape 067 @Override 068 public String getUuid(); 069 070 /** 071 * Sets the uuid of this user. 072 * 073 * @param uuid the uuid of this user 074 */ 075 @Override 076 public void setUuid(String uuid); 077 078 /** 079 * Returns the user ID of this user. 080 * 081 * @return the user ID of this user 082 */ 083 public long getUserId(); 084 085 /** 086 * Sets the user ID of this user. 087 * 088 * @param userId the user ID of this user 089 */ 090 public void setUserId(long userId); 091 092 /** 093 * Returns the user uuid of this user. 094 * 095 * @return the user uuid of this user 096 * @throws SystemException if a system exception occurred 097 */ 098 public String getUserUuid() throws SystemException; 099 100 /** 101 * Sets the user uuid of this user. 102 * 103 * @param userUuid the user uuid of this user 104 */ 105 public void setUserUuid(String userUuid); 106 107 /** 108 * Returns the company ID of this user. 109 * 110 * @return the company ID of this user 111 */ 112 @Override 113 public long getCompanyId(); 114 115 /** 116 * Sets the company ID of this user. 117 * 118 * @param companyId the company ID of this user 119 */ 120 @Override 121 public void setCompanyId(long companyId); 122 123 /** 124 * Returns the create date of this user. 125 * 126 * @return the create date of this user 127 */ 128 @Override 129 public Date getCreateDate(); 130 131 /** 132 * Sets the create date of this user. 133 * 134 * @param createDate the create date of this user 135 */ 136 @Override 137 public void setCreateDate(Date createDate); 138 139 /** 140 * Returns the modified date of this user. 141 * 142 * @return the modified date of this user 143 */ 144 @Override 145 public Date getModifiedDate(); 146 147 /** 148 * Sets the modified date of this user. 149 * 150 * @param modifiedDate the modified date of this user 151 */ 152 @Override 153 public void setModifiedDate(Date modifiedDate); 154 155 /** 156 * Returns the default user of this user. 157 * 158 * @return the default user of this user 159 */ 160 public boolean getDefaultUser(); 161 162 /** 163 * Returns <code>true</code> if this user is default user. 164 * 165 * @return <code>true</code> if this user is default user; <code>false</code> otherwise 166 */ 167 public boolean isDefaultUser(); 168 169 /** 170 * Sets whether this user is default user. 171 * 172 * @param defaultUser the default user of this user 173 */ 174 public void setDefaultUser(boolean defaultUser); 175 176 /** 177 * Returns the contact ID of this user. 178 * 179 * @return the contact ID of this user 180 */ 181 public long getContactId(); 182 183 /** 184 * Sets the contact ID of this user. 185 * 186 * @param contactId the contact ID of this user 187 */ 188 public void setContactId(long contactId); 189 190 /** 191 * Returns the password of this user. 192 * 193 * @return the password of this user 194 */ 195 @AutoEscape 196 public String getPassword(); 197 198 /** 199 * Sets the password of this user. 200 * 201 * @param password the password of this user 202 */ 203 public void setPassword(String password); 204 205 /** 206 * Returns the password encrypted of this user. 207 * 208 * @return the password encrypted of this user 209 */ 210 public boolean getPasswordEncrypted(); 211 212 /** 213 * Returns <code>true</code> if this user is password encrypted. 214 * 215 * @return <code>true</code> if this user is password encrypted; <code>false</code> otherwise 216 */ 217 public boolean isPasswordEncrypted(); 218 219 /** 220 * Sets whether this user is password encrypted. 221 * 222 * @param passwordEncrypted the password encrypted of this user 223 */ 224 public void setPasswordEncrypted(boolean passwordEncrypted); 225 226 /** 227 * Returns the password reset of this user. 228 * 229 * @return the password reset of this user 230 */ 231 public boolean getPasswordReset(); 232 233 /** 234 * Returns <code>true</code> if this user is password reset. 235 * 236 * @return <code>true</code> if this user is password reset; <code>false</code> otherwise 237 */ 238 public boolean isPasswordReset(); 239 240 /** 241 * Sets whether this user is password reset. 242 * 243 * @param passwordReset the password reset of this user 244 */ 245 public void setPasswordReset(boolean passwordReset); 246 247 /** 248 * Returns the password modified date of this user. 249 * 250 * @return the password modified date of this user 251 */ 252 public Date getPasswordModifiedDate(); 253 254 /** 255 * Sets the password modified date of this user. 256 * 257 * @param passwordModifiedDate the password modified date of this user 258 */ 259 public void setPasswordModifiedDate(Date passwordModifiedDate); 260 261 /** 262 * Returns the digest of this user. 263 * 264 * @return the digest of this user 265 */ 266 @AutoEscape 267 public String getDigest(); 268 269 /** 270 * Sets the digest of this user. 271 * 272 * @param digest the digest of this user 273 */ 274 public void setDigest(String digest); 275 276 /** 277 * Returns the reminder query question of this user. 278 * 279 * @return the reminder query question of this user 280 */ 281 @AutoEscape 282 public String getReminderQueryQuestion(); 283 284 /** 285 * Sets the reminder query question of this user. 286 * 287 * @param reminderQueryQuestion the reminder query question of this user 288 */ 289 public void setReminderQueryQuestion(String reminderQueryQuestion); 290 291 /** 292 * Returns the reminder query answer of this user. 293 * 294 * @return the reminder query answer of this user 295 */ 296 @AutoEscape 297 public String getReminderQueryAnswer(); 298 299 /** 300 * Sets the reminder query answer of this user. 301 * 302 * @param reminderQueryAnswer the reminder query answer of this user 303 */ 304 public void setReminderQueryAnswer(String reminderQueryAnswer); 305 306 /** 307 * Returns the grace login count of this user. 308 * 309 * @return the grace login count of this user 310 */ 311 public int getGraceLoginCount(); 312 313 /** 314 * Sets the grace login count of this user. 315 * 316 * @param graceLoginCount the grace login count of this user 317 */ 318 public void setGraceLoginCount(int graceLoginCount); 319 320 /** 321 * Returns the screen name of this user. 322 * 323 * @return the screen name of this user 324 */ 325 @AutoEscape 326 public String getScreenName(); 327 328 /** 329 * Sets the screen name of this user. 330 * 331 * @param screenName the screen name of this user 332 */ 333 public void setScreenName(String screenName); 334 335 /** 336 * Returns the email address of this user. 337 * 338 * @return the email address of this user 339 */ 340 @AutoEscape 341 public String getEmailAddress(); 342 343 /** 344 * Sets the email address of this user. 345 * 346 * @param emailAddress the email address of this user 347 */ 348 public void setEmailAddress(String emailAddress); 349 350 /** 351 * Returns the facebook ID of this user. 352 * 353 * @return the facebook ID of this user 354 */ 355 public long getFacebookId(); 356 357 /** 358 * Sets the facebook ID of this user. 359 * 360 * @param facebookId the facebook ID of this user 361 */ 362 public void setFacebookId(long facebookId); 363 364 /** 365 * Returns the ldap server ID of this user. 366 * 367 * @return the ldap server ID of this user 368 */ 369 public long getLdapServerId(); 370 371 /** 372 * Sets the ldap server ID of this user. 373 * 374 * @param ldapServerId the ldap server ID of this user 375 */ 376 public void setLdapServerId(long ldapServerId); 377 378 /** 379 * Returns the open ID of this user. 380 * 381 * @return the open ID of this user 382 */ 383 @AutoEscape 384 public String getOpenId(); 385 386 /** 387 * Sets the open ID of this user. 388 * 389 * @param openId the open ID of this user 390 */ 391 public void setOpenId(String openId); 392 393 /** 394 * Returns the portrait ID of this user. 395 * 396 * @return the portrait ID of this user 397 */ 398 public long getPortraitId(); 399 400 /** 401 * Sets the portrait ID of this user. 402 * 403 * @param portraitId the portrait ID of this user 404 */ 405 public void setPortraitId(long portraitId); 406 407 /** 408 * Returns the language ID of this user. 409 * 410 * @return the language ID of this user 411 */ 412 @AutoEscape 413 public String getLanguageId(); 414 415 /** 416 * Sets the language ID of this user. 417 * 418 * @param languageId the language ID of this user 419 */ 420 public void setLanguageId(String languageId); 421 422 /** 423 * Returns the time zone ID of this user. 424 * 425 * @return the time zone ID of this user 426 */ 427 @AutoEscape 428 public String getTimeZoneId(); 429 430 /** 431 * Sets the time zone ID of this user. 432 * 433 * @param timeZoneId the time zone ID of this user 434 */ 435 public void setTimeZoneId(String timeZoneId); 436 437 /** 438 * Returns the greeting of this user. 439 * 440 * @return the greeting of this user 441 */ 442 @AutoEscape 443 public String getGreeting(); 444 445 /** 446 * Sets the greeting of this user. 447 * 448 * @param greeting the greeting of this user 449 */ 450 public void setGreeting(String greeting); 451 452 /** 453 * Returns the comments of this user. 454 * 455 * @return the comments of this user 456 */ 457 @AutoEscape 458 public String getComments(); 459 460 /** 461 * Sets the comments of this user. 462 * 463 * @param comments the comments of this user 464 */ 465 public void setComments(String comments); 466 467 /** 468 * Returns the first name of this user. 469 * 470 * @return the first name of this user 471 */ 472 @AutoEscape 473 public String getFirstName(); 474 475 /** 476 * Sets the first name of this user. 477 * 478 * @param firstName the first name of this user 479 */ 480 public void setFirstName(String firstName); 481 482 /** 483 * Returns the middle name of this user. 484 * 485 * @return the middle name of this user 486 */ 487 @AutoEscape 488 public String getMiddleName(); 489 490 /** 491 * Sets the middle name of this user. 492 * 493 * @param middleName the middle name of this user 494 */ 495 public void setMiddleName(String middleName); 496 497 /** 498 * Returns the last name of this user. 499 * 500 * @return the last name of this user 501 */ 502 @AutoEscape 503 public String getLastName(); 504 505 /** 506 * Sets the last name of this user. 507 * 508 * @param lastName the last name of this user 509 */ 510 public void setLastName(String lastName); 511 512 /** 513 * Returns the job title of this user. 514 * 515 * @return the job title of this user 516 */ 517 @AutoEscape 518 public String getJobTitle(); 519 520 /** 521 * Sets the job title of this user. 522 * 523 * @param jobTitle the job title of this user 524 */ 525 public void setJobTitle(String jobTitle); 526 527 /** 528 * Returns the login date of this user. 529 * 530 * @return the login date of this user 531 */ 532 public Date getLoginDate(); 533 534 /** 535 * Sets the login date of this user. 536 * 537 * @param loginDate the login date of this user 538 */ 539 public void setLoginDate(Date loginDate); 540 541 /** 542 * Returns the login i p of this user. 543 * 544 * @return the login i p of this user 545 */ 546 @AutoEscape 547 public String getLoginIP(); 548 549 /** 550 * Sets the login i p of this user. 551 * 552 * @param loginIP the login i p of this user 553 */ 554 public void setLoginIP(String loginIP); 555 556 /** 557 * Returns the last login date of this user. 558 * 559 * @return the last login date of this user 560 */ 561 public Date getLastLoginDate(); 562 563 /** 564 * Sets the last login date of this user. 565 * 566 * @param lastLoginDate the last login date of this user 567 */ 568 public void setLastLoginDate(Date lastLoginDate); 569 570 /** 571 * Returns the last login i p of this user. 572 * 573 * @return the last login i p of this user 574 */ 575 @AutoEscape 576 public String getLastLoginIP(); 577 578 /** 579 * Sets the last login i p of this user. 580 * 581 * @param lastLoginIP the last login i p of this user 582 */ 583 public void setLastLoginIP(String lastLoginIP); 584 585 /** 586 * Returns the last failed login date of this user. 587 * 588 * @return the last failed login date of this user 589 */ 590 public Date getLastFailedLoginDate(); 591 592 /** 593 * Sets the last failed login date of this user. 594 * 595 * @param lastFailedLoginDate the last failed login date of this user 596 */ 597 public void setLastFailedLoginDate(Date lastFailedLoginDate); 598 599 /** 600 * Returns the failed login attempts of this user. 601 * 602 * @return the failed login attempts of this user 603 */ 604 public int getFailedLoginAttempts(); 605 606 /** 607 * Sets the failed login attempts of this user. 608 * 609 * @param failedLoginAttempts the failed login attempts of this user 610 */ 611 public void setFailedLoginAttempts(int failedLoginAttempts); 612 613 /** 614 * Returns the lockout of this user. 615 * 616 * @return the lockout of this user 617 */ 618 public boolean getLockout(); 619 620 /** 621 * Returns <code>true</code> if this user is lockout. 622 * 623 * @return <code>true</code> if this user is lockout; <code>false</code> otherwise 624 */ 625 public boolean isLockout(); 626 627 /** 628 * Sets whether this user is lockout. 629 * 630 * @param lockout the lockout of this user 631 */ 632 public void setLockout(boolean lockout); 633 634 /** 635 * Returns the lockout date of this user. 636 * 637 * @return the lockout date of this user 638 */ 639 public Date getLockoutDate(); 640 641 /** 642 * Sets the lockout date of this user. 643 * 644 * @param lockoutDate the lockout date of this user 645 */ 646 public void setLockoutDate(Date lockoutDate); 647 648 /** 649 * Returns the agreed to terms of use of this user. 650 * 651 * @return the agreed to terms of use of this user 652 */ 653 public boolean getAgreedToTermsOfUse(); 654 655 /** 656 * Returns <code>true</code> if this user is agreed to terms of use. 657 * 658 * @return <code>true</code> if this user is agreed to terms of use; <code>false</code> otherwise 659 */ 660 public boolean isAgreedToTermsOfUse(); 661 662 /** 663 * Sets whether this user is agreed to terms of use. 664 * 665 * @param agreedToTermsOfUse the agreed to terms of use of this user 666 */ 667 public void setAgreedToTermsOfUse(boolean agreedToTermsOfUse); 668 669 /** 670 * Returns the email address verified of this user. 671 * 672 * @return the email address verified of this user 673 */ 674 public boolean getEmailAddressVerified(); 675 676 /** 677 * Returns <code>true</code> if this user is email address verified. 678 * 679 * @return <code>true</code> if this user is email address verified; <code>false</code> otherwise 680 */ 681 public boolean isEmailAddressVerified(); 682 683 /** 684 * Sets whether this user is email address verified. 685 * 686 * @param emailAddressVerified the email address verified of this user 687 */ 688 public void setEmailAddressVerified(boolean emailAddressVerified); 689 690 /** 691 * Returns the status of this user. 692 * 693 * @return the status of this user 694 */ 695 public int getStatus(); 696 697 /** 698 * Sets the status of this user. 699 * 700 * @param status the status of this user 701 */ 702 public void setStatus(int status); 703 704 @Override 705 public boolean isNew(); 706 707 @Override 708 public void setNew(boolean n); 709 710 @Override 711 public boolean isCachedModel(); 712 713 @Override 714 public void setCachedModel(boolean cachedModel); 715 716 @Override 717 public boolean isEscapedModel(); 718 719 @Override 720 public Serializable getPrimaryKeyObj(); 721 722 @Override 723 public void setPrimaryKeyObj(Serializable primaryKeyObj); 724 725 @Override 726 public ExpandoBridge getExpandoBridge(); 727 728 @Override 729 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 730 731 @Override 732 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 733 734 @Override 735 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 736 737 @Override 738 public Object clone(); 739 740 @Override 741 public int compareTo(User user); 742 743 @Override 744 public int hashCode(); 745 746 @Override 747 public CacheModel<User> toCacheModel(); 748 749 @Override 750 public User toEscapedModel(); 751 752 @Override 753 public User toUnescapedModel(); 754 755 @Override 756 public String toString(); 757 758 @Override 759 public String toXmlString(); 760 }