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