001 /** 002 * Copyright (c) 2000-present 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.service.ServiceContext; 021 022 import com.liferay.portlet.expando.model.ExpandoBridge; 023 024 import java.io.Serializable; 025 026 import java.util.Date; 027 028 /** 029 * The base model interface for the PasswordPolicy service. Represents a row in the "PasswordPolicy" database table, with each column mapped to a property of this class. 030 * 031 * <p> 032 * This interface and its corresponding implementation {@link com.liferay.portal.model.impl.PasswordPolicyModelImpl} 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.PasswordPolicyImpl}. 033 * </p> 034 * 035 * @author Brian Wing Shun Chan 036 * @see PasswordPolicy 037 * @see com.liferay.portal.model.impl.PasswordPolicyImpl 038 * @see com.liferay.portal.model.impl.PasswordPolicyModelImpl 039 * @generated 040 */ 041 @ProviderType 042 public interface PasswordPolicyModel extends BaseModel<PasswordPolicy>, MVCCModel, 043 ShardedModel, StagedAuditedModel { 044 /* 045 * NOTE FOR DEVELOPERS: 046 * 047 * Never modify or reference this interface directly. All methods that expect a password policy model instance should use the {@link PasswordPolicy} interface instead. 048 */ 049 050 /** 051 * Returns the primary key of this password policy. 052 * 053 * @return the primary key of this password policy 054 */ 055 public long getPrimaryKey(); 056 057 /** 058 * Sets the primary key of this password policy. 059 * 060 * @param primaryKey the primary key of this password policy 061 */ 062 public void setPrimaryKey(long primaryKey); 063 064 /** 065 * Returns the mvcc version of this password policy. 066 * 067 * @return the mvcc version of this password policy 068 */ 069 @Override 070 public long getMvccVersion(); 071 072 /** 073 * Sets the mvcc version of this password policy. 074 * 075 * @param mvccVersion the mvcc version of this password policy 076 */ 077 @Override 078 public void setMvccVersion(long mvccVersion); 079 080 /** 081 * Returns the uuid of this password policy. 082 * 083 * @return the uuid of this password policy 084 */ 085 @AutoEscape 086 @Override 087 public String getUuid(); 088 089 /** 090 * Sets the uuid of this password policy. 091 * 092 * @param uuid the uuid of this password policy 093 */ 094 @Override 095 public void setUuid(String uuid); 096 097 /** 098 * Returns the password policy ID of this password policy. 099 * 100 * @return the password policy ID of this password policy 101 */ 102 public long getPasswordPolicyId(); 103 104 /** 105 * Sets the password policy ID of this password policy. 106 * 107 * @param passwordPolicyId the password policy ID of this password policy 108 */ 109 public void setPasswordPolicyId(long passwordPolicyId); 110 111 /** 112 * Returns the company ID of this password policy. 113 * 114 * @return the company ID of this password policy 115 */ 116 @Override 117 public long getCompanyId(); 118 119 /** 120 * Sets the company ID of this password policy. 121 * 122 * @param companyId the company ID of this password policy 123 */ 124 @Override 125 public void setCompanyId(long companyId); 126 127 /** 128 * Returns the user ID of this password policy. 129 * 130 * @return the user ID of this password policy 131 */ 132 @Override 133 public long getUserId(); 134 135 /** 136 * Sets the user ID of this password policy. 137 * 138 * @param userId the user ID of this password policy 139 */ 140 @Override 141 public void setUserId(long userId); 142 143 /** 144 * Returns the user uuid of this password policy. 145 * 146 * @return the user uuid of this password policy 147 */ 148 @Override 149 public String getUserUuid(); 150 151 /** 152 * Sets the user uuid of this password policy. 153 * 154 * @param userUuid the user uuid of this password policy 155 */ 156 @Override 157 public void setUserUuid(String userUuid); 158 159 /** 160 * Returns the user name of this password policy. 161 * 162 * @return the user name of this password policy 163 */ 164 @AutoEscape 165 @Override 166 public String getUserName(); 167 168 /** 169 * Sets the user name of this password policy. 170 * 171 * @param userName the user name of this password policy 172 */ 173 @Override 174 public void setUserName(String userName); 175 176 /** 177 * Returns the create date of this password policy. 178 * 179 * @return the create date of this password policy 180 */ 181 @Override 182 public Date getCreateDate(); 183 184 /** 185 * Sets the create date of this password policy. 186 * 187 * @param createDate the create date of this password policy 188 */ 189 @Override 190 public void setCreateDate(Date createDate); 191 192 /** 193 * Returns the modified date of this password policy. 194 * 195 * @return the modified date of this password policy 196 */ 197 @Override 198 public Date getModifiedDate(); 199 200 /** 201 * Sets the modified date of this password policy. 202 * 203 * @param modifiedDate the modified date of this password policy 204 */ 205 @Override 206 public void setModifiedDate(Date modifiedDate); 207 208 /** 209 * Returns the default policy of this password policy. 210 * 211 * @return the default policy of this password policy 212 */ 213 public boolean getDefaultPolicy(); 214 215 /** 216 * Returns <code>true</code> if this password policy is default policy. 217 * 218 * @return <code>true</code> if this password policy is default policy; <code>false</code> otherwise 219 */ 220 public boolean isDefaultPolicy(); 221 222 /** 223 * Sets whether this password policy is default policy. 224 * 225 * @param defaultPolicy the default policy of this password policy 226 */ 227 public void setDefaultPolicy(boolean defaultPolicy); 228 229 /** 230 * Returns the name of this password policy. 231 * 232 * @return the name of this password policy 233 */ 234 @AutoEscape 235 public String getName(); 236 237 /** 238 * Sets the name of this password policy. 239 * 240 * @param name the name of this password policy 241 */ 242 public void setName(String name); 243 244 /** 245 * Returns the description of this password policy. 246 * 247 * @return the description of this password policy 248 */ 249 @AutoEscape 250 public String getDescription(); 251 252 /** 253 * Sets the description of this password policy. 254 * 255 * @param description the description of this password policy 256 */ 257 public void setDescription(String description); 258 259 /** 260 * Returns the changeable of this password policy. 261 * 262 * @return the changeable of this password policy 263 */ 264 public boolean getChangeable(); 265 266 /** 267 * Returns <code>true</code> if this password policy is changeable. 268 * 269 * @return <code>true</code> if this password policy is changeable; <code>false</code> otherwise 270 */ 271 public boolean isChangeable(); 272 273 /** 274 * Sets whether this password policy is changeable. 275 * 276 * @param changeable the changeable of this password policy 277 */ 278 public void setChangeable(boolean changeable); 279 280 /** 281 * Returns the change required of this password policy. 282 * 283 * @return the change required of this password policy 284 */ 285 public boolean getChangeRequired(); 286 287 /** 288 * Returns <code>true</code> if this password policy is change required. 289 * 290 * @return <code>true</code> if this password policy is change required; <code>false</code> otherwise 291 */ 292 public boolean isChangeRequired(); 293 294 /** 295 * Sets whether this password policy is change required. 296 * 297 * @param changeRequired the change required of this password policy 298 */ 299 public void setChangeRequired(boolean changeRequired); 300 301 /** 302 * Returns the min age of this password policy. 303 * 304 * @return the min age of this password policy 305 */ 306 public long getMinAge(); 307 308 /** 309 * Sets the min age of this password policy. 310 * 311 * @param minAge the min age of this password policy 312 */ 313 public void setMinAge(long minAge); 314 315 /** 316 * Returns the check syntax of this password policy. 317 * 318 * @return the check syntax of this password policy 319 */ 320 public boolean getCheckSyntax(); 321 322 /** 323 * Returns <code>true</code> if this password policy is check syntax. 324 * 325 * @return <code>true</code> if this password policy is check syntax; <code>false</code> otherwise 326 */ 327 public boolean isCheckSyntax(); 328 329 /** 330 * Sets whether this password policy is check syntax. 331 * 332 * @param checkSyntax the check syntax of this password policy 333 */ 334 public void setCheckSyntax(boolean checkSyntax); 335 336 /** 337 * Returns the allow dictionary words of this password policy. 338 * 339 * @return the allow dictionary words of this password policy 340 */ 341 public boolean getAllowDictionaryWords(); 342 343 /** 344 * Returns <code>true</code> if this password policy is allow dictionary words. 345 * 346 * @return <code>true</code> if this password policy is allow dictionary words; <code>false</code> otherwise 347 */ 348 public boolean isAllowDictionaryWords(); 349 350 /** 351 * Sets whether this password policy is allow dictionary words. 352 * 353 * @param allowDictionaryWords the allow dictionary words of this password policy 354 */ 355 public void setAllowDictionaryWords(boolean allowDictionaryWords); 356 357 /** 358 * Returns the min alphanumeric of this password policy. 359 * 360 * @return the min alphanumeric of this password policy 361 */ 362 public int getMinAlphanumeric(); 363 364 /** 365 * Sets the min alphanumeric of this password policy. 366 * 367 * @param minAlphanumeric the min alphanumeric of this password policy 368 */ 369 public void setMinAlphanumeric(int minAlphanumeric); 370 371 /** 372 * Returns the min length of this password policy. 373 * 374 * @return the min length of this password policy 375 */ 376 public int getMinLength(); 377 378 /** 379 * Sets the min length of this password policy. 380 * 381 * @param minLength the min length of this password policy 382 */ 383 public void setMinLength(int minLength); 384 385 /** 386 * Returns the min lower case of this password policy. 387 * 388 * @return the min lower case of this password policy 389 */ 390 public int getMinLowerCase(); 391 392 /** 393 * Sets the min lower case of this password policy. 394 * 395 * @param minLowerCase the min lower case of this password policy 396 */ 397 public void setMinLowerCase(int minLowerCase); 398 399 /** 400 * Returns the min numbers of this password policy. 401 * 402 * @return the min numbers of this password policy 403 */ 404 public int getMinNumbers(); 405 406 /** 407 * Sets the min numbers of this password policy. 408 * 409 * @param minNumbers the min numbers of this password policy 410 */ 411 public void setMinNumbers(int minNumbers); 412 413 /** 414 * Returns the min symbols of this password policy. 415 * 416 * @return the min symbols of this password policy 417 */ 418 public int getMinSymbols(); 419 420 /** 421 * Sets the min symbols of this password policy. 422 * 423 * @param minSymbols the min symbols of this password policy 424 */ 425 public void setMinSymbols(int minSymbols); 426 427 /** 428 * Returns the min upper case of this password policy. 429 * 430 * @return the min upper case of this password policy 431 */ 432 public int getMinUpperCase(); 433 434 /** 435 * Sets the min upper case of this password policy. 436 * 437 * @param minUpperCase the min upper case of this password policy 438 */ 439 public void setMinUpperCase(int minUpperCase); 440 441 /** 442 * Returns the regex of this password policy. 443 * 444 * @return the regex of this password policy 445 */ 446 @AutoEscape 447 public String getRegex(); 448 449 /** 450 * Sets the regex of this password policy. 451 * 452 * @param regex the regex of this password policy 453 */ 454 public void setRegex(String regex); 455 456 /** 457 * Returns the history of this password policy. 458 * 459 * @return the history of this password policy 460 */ 461 public boolean getHistory(); 462 463 /** 464 * Returns <code>true</code> if this password policy is history. 465 * 466 * @return <code>true</code> if this password policy is history; <code>false</code> otherwise 467 */ 468 public boolean isHistory(); 469 470 /** 471 * Sets whether this password policy is history. 472 * 473 * @param history the history of this password policy 474 */ 475 public void setHistory(boolean history); 476 477 /** 478 * Returns the history count of this password policy. 479 * 480 * @return the history count of this password policy 481 */ 482 public int getHistoryCount(); 483 484 /** 485 * Sets the history count of this password policy. 486 * 487 * @param historyCount the history count of this password policy 488 */ 489 public void setHistoryCount(int historyCount); 490 491 /** 492 * Returns the expireable of this password policy. 493 * 494 * @return the expireable of this password policy 495 */ 496 public boolean getExpireable(); 497 498 /** 499 * Returns <code>true</code> if this password policy is expireable. 500 * 501 * @return <code>true</code> if this password policy is expireable; <code>false</code> otherwise 502 */ 503 public boolean isExpireable(); 504 505 /** 506 * Sets whether this password policy is expireable. 507 * 508 * @param expireable the expireable of this password policy 509 */ 510 public void setExpireable(boolean expireable); 511 512 /** 513 * Returns the max age of this password policy. 514 * 515 * @return the max age of this password policy 516 */ 517 public long getMaxAge(); 518 519 /** 520 * Sets the max age of this password policy. 521 * 522 * @param maxAge the max age of this password policy 523 */ 524 public void setMaxAge(long maxAge); 525 526 /** 527 * Returns the warning time of this password policy. 528 * 529 * @return the warning time of this password policy 530 */ 531 public long getWarningTime(); 532 533 /** 534 * Sets the warning time of this password policy. 535 * 536 * @param warningTime the warning time of this password policy 537 */ 538 public void setWarningTime(long warningTime); 539 540 /** 541 * Returns the grace limit of this password policy. 542 * 543 * @return the grace limit of this password policy 544 */ 545 public int getGraceLimit(); 546 547 /** 548 * Sets the grace limit of this password policy. 549 * 550 * @param graceLimit the grace limit of this password policy 551 */ 552 public void setGraceLimit(int graceLimit); 553 554 /** 555 * Returns the lockout of this password policy. 556 * 557 * @return the lockout of this password policy 558 */ 559 public boolean getLockout(); 560 561 /** 562 * Returns <code>true</code> if this password policy is lockout. 563 * 564 * @return <code>true</code> if this password policy is lockout; <code>false</code> otherwise 565 */ 566 public boolean isLockout(); 567 568 /** 569 * Sets whether this password policy is lockout. 570 * 571 * @param lockout the lockout of this password policy 572 */ 573 public void setLockout(boolean lockout); 574 575 /** 576 * Returns the max failure of this password policy. 577 * 578 * @return the max failure of this password policy 579 */ 580 public int getMaxFailure(); 581 582 /** 583 * Sets the max failure of this password policy. 584 * 585 * @param maxFailure the max failure of this password policy 586 */ 587 public void setMaxFailure(int maxFailure); 588 589 /** 590 * Returns the lockout duration of this password policy. 591 * 592 * @return the lockout duration of this password policy 593 */ 594 public long getLockoutDuration(); 595 596 /** 597 * Sets the lockout duration of this password policy. 598 * 599 * @param lockoutDuration the lockout duration of this password policy 600 */ 601 public void setLockoutDuration(long lockoutDuration); 602 603 /** 604 * Returns the require unlock of this password policy. 605 * 606 * @return the require unlock of this password policy 607 */ 608 public boolean getRequireUnlock(); 609 610 /** 611 * Returns <code>true</code> if this password policy is require unlock. 612 * 613 * @return <code>true</code> if this password policy is require unlock; <code>false</code> otherwise 614 */ 615 public boolean isRequireUnlock(); 616 617 /** 618 * Sets whether this password policy is require unlock. 619 * 620 * @param requireUnlock the require unlock of this password policy 621 */ 622 public void setRequireUnlock(boolean requireUnlock); 623 624 /** 625 * Returns the reset failure count of this password policy. 626 * 627 * @return the reset failure count of this password policy 628 */ 629 public long getResetFailureCount(); 630 631 /** 632 * Sets the reset failure count of this password policy. 633 * 634 * @param resetFailureCount the reset failure count of this password policy 635 */ 636 public void setResetFailureCount(long resetFailureCount); 637 638 /** 639 * Returns the reset ticket max age of this password policy. 640 * 641 * @return the reset ticket max age of this password policy 642 */ 643 public long getResetTicketMaxAge(); 644 645 /** 646 * Sets the reset ticket max age of this password policy. 647 * 648 * @param resetTicketMaxAge the reset ticket max age of this password policy 649 */ 650 public void setResetTicketMaxAge(long resetTicketMaxAge); 651 652 @Override 653 public boolean isNew(); 654 655 @Override 656 public void setNew(boolean n); 657 658 @Override 659 public boolean isCachedModel(); 660 661 @Override 662 public void setCachedModel(boolean cachedModel); 663 664 @Override 665 public boolean isEscapedModel(); 666 667 @Override 668 public Serializable getPrimaryKeyObj(); 669 670 @Override 671 public void setPrimaryKeyObj(Serializable primaryKeyObj); 672 673 @Override 674 public ExpandoBridge getExpandoBridge(); 675 676 @Override 677 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 678 679 @Override 680 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 681 682 @Override 683 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 684 685 @Override 686 public Object clone(); 687 688 @Override 689 public int compareTo(com.liferay.portal.model.PasswordPolicy passwordPolicy); 690 691 @Override 692 public int hashCode(); 693 694 @Override 695 public CacheModel<com.liferay.portal.model.PasswordPolicy> toCacheModel(); 696 697 @Override 698 public com.liferay.portal.model.PasswordPolicy toEscapedModel(); 699 700 @Override 701 public com.liferay.portal.model.PasswordPolicy toUnescapedModel(); 702 703 @Override 704 public String toString(); 705 706 @Override 707 public String toXmlString(); 708 }