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