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