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