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