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 User service. Represents a row in the "User_" 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.UserModelImpl} 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.UserImpl}.
033     * </p>
034     *
035     * @author Brian Wing Shun Chan
036     * @see User
037     * @see com.liferay.portal.model.impl.UserImpl
038     * @see com.liferay.portal.model.impl.UserModelImpl
039     * @generated
040     */
041    @ProviderType
042    public interface UserModel extends BaseModel<User>, MVCCModel, StagedModel {
043            /*
044             * NOTE FOR DEVELOPERS:
045             *
046             * Never modify or reference this interface directly. All methods that expect a user model instance should use the {@link User} interface instead.
047             */
048    
049            /**
050             * Returns the primary key of this user.
051             *
052             * @return the primary key of this user
053             */
054            public long getPrimaryKey();
055    
056            /**
057             * Sets the primary key of this user.
058             *
059             * @param primaryKey the primary key of this user
060             */
061            public void setPrimaryKey(long primaryKey);
062    
063            /**
064             * Returns the mvcc version of this user.
065             *
066             * @return the mvcc version of this user
067             */
068            @Override
069            public long getMvccVersion();
070    
071            /**
072             * Sets the mvcc version of this user.
073             *
074             * @param mvccVersion the mvcc version of this user
075             */
076            @Override
077            public void setMvccVersion(long mvccVersion);
078    
079            /**
080             * Returns the uuid of this user.
081             *
082             * @return the uuid of this user
083             */
084            @AutoEscape
085            @Override
086            public String getUuid();
087    
088            /**
089             * Sets the uuid of this user.
090             *
091             * @param uuid the uuid of this user
092             */
093            @Override
094            public void setUuid(String uuid);
095    
096            /**
097             * Returns the user ID of this user.
098             *
099             * @return the user ID of this user
100             */
101            public long getUserId();
102    
103            /**
104             * Sets the user ID of this user.
105             *
106             * @param userId the user ID of this user
107             */
108            public void setUserId(long userId);
109    
110            /**
111             * Returns the user uuid of this user.
112             *
113             * @return the user uuid of this user
114             */
115            public String getUserUuid();
116    
117            /**
118             * Sets the user uuid of this user.
119             *
120             * @param userUuid the user uuid of this user
121             */
122            public void setUserUuid(String userUuid);
123    
124            /**
125             * Returns the company ID of this user.
126             *
127             * @return the company ID of this user
128             */
129            @Override
130            public long getCompanyId();
131    
132            /**
133             * Sets the company ID of this user.
134             *
135             * @param companyId the company ID of this user
136             */
137            @Override
138            public void setCompanyId(long companyId);
139    
140            /**
141             * Returns the create date of this user.
142             *
143             * @return the create date of this user
144             */
145            @Override
146            public Date getCreateDate();
147    
148            /**
149             * Sets the create date of this user.
150             *
151             * @param createDate the create date of this user
152             */
153            @Override
154            public void setCreateDate(Date createDate);
155    
156            /**
157             * Returns the modified date of this user.
158             *
159             * @return the modified date of this user
160             */
161            @Override
162            public Date getModifiedDate();
163    
164            /**
165             * Sets the modified date of this user.
166             *
167             * @param modifiedDate the modified date of this user
168             */
169            @Override
170            public void setModifiedDate(Date modifiedDate);
171    
172            /**
173             * Returns the default user of this user.
174             *
175             * @return the default user of this user
176             */
177            public boolean getDefaultUser();
178    
179            /**
180             * Returns <code>true</code> if this user is default user.
181             *
182             * @return <code>true</code> if this user is default user; <code>false</code> otherwise
183             */
184            public boolean isDefaultUser();
185    
186            /**
187             * Sets whether this user is default user.
188             *
189             * @param defaultUser the default user of this user
190             */
191            public void setDefaultUser(boolean defaultUser);
192    
193            /**
194             * Returns the contact ID of this user.
195             *
196             * @return the contact ID of this user
197             */
198            public long getContactId();
199    
200            /**
201             * Sets the contact ID of this user.
202             *
203             * @param contactId the contact ID of this user
204             */
205            public void setContactId(long contactId);
206    
207            /**
208             * Returns the password of this user.
209             *
210             * @return the password of this user
211             */
212            @AutoEscape
213            public String getPassword();
214    
215            /**
216             * Sets the password of this user.
217             *
218             * @param password the password of this user
219             */
220            public void setPassword(String password);
221    
222            /**
223             * Returns the password encrypted of this user.
224             *
225             * @return the password encrypted of this user
226             */
227            public boolean getPasswordEncrypted();
228    
229            /**
230             * Returns <code>true</code> if this user is password encrypted.
231             *
232             * @return <code>true</code> if this user is password encrypted; <code>false</code> otherwise
233             */
234            public boolean isPasswordEncrypted();
235    
236            /**
237             * Sets whether this user is password encrypted.
238             *
239             * @param passwordEncrypted the password encrypted of this user
240             */
241            public void setPasswordEncrypted(boolean passwordEncrypted);
242    
243            /**
244             * Returns the password reset of this user.
245             *
246             * @return the password reset of this user
247             */
248            public boolean getPasswordReset();
249    
250            /**
251             * Returns <code>true</code> if this user is password reset.
252             *
253             * @return <code>true</code> if this user is password reset; <code>false</code> otherwise
254             */
255            public boolean isPasswordReset();
256    
257            /**
258             * Sets whether this user is password reset.
259             *
260             * @param passwordReset the password reset of this user
261             */
262            public void setPasswordReset(boolean passwordReset);
263    
264            /**
265             * Returns the password modified date of this user.
266             *
267             * @return the password modified date of this user
268             */
269            public Date getPasswordModifiedDate();
270    
271            /**
272             * Sets the password modified date of this user.
273             *
274             * @param passwordModifiedDate the password modified date of this user
275             */
276            public void setPasswordModifiedDate(Date passwordModifiedDate);
277    
278            /**
279             * Returns the digest of this user.
280             *
281             * @return the digest of this user
282             */
283            @AutoEscape
284            public String getDigest();
285    
286            /**
287             * Sets the digest of this user.
288             *
289             * @param digest the digest of this user
290             */
291            public void setDigest(String digest);
292    
293            /**
294             * Returns the reminder query question of this user.
295             *
296             * @return the reminder query question of this user
297             */
298            @AutoEscape
299            public String getReminderQueryQuestion();
300    
301            /**
302             * Sets the reminder query question of this user.
303             *
304             * @param reminderQueryQuestion the reminder query question of this user
305             */
306            public void setReminderQueryQuestion(String reminderQueryQuestion);
307    
308            /**
309             * Returns the reminder query answer of this user.
310             *
311             * @return the reminder query answer of this user
312             */
313            @AutoEscape
314            public String getReminderQueryAnswer();
315    
316            /**
317             * Sets the reminder query answer of this user.
318             *
319             * @param reminderQueryAnswer the reminder query answer of this user
320             */
321            public void setReminderQueryAnswer(String reminderQueryAnswer);
322    
323            /**
324             * Returns the grace login count of this user.
325             *
326             * @return the grace login count of this user
327             */
328            public int getGraceLoginCount();
329    
330            /**
331             * Sets the grace login count of this user.
332             *
333             * @param graceLoginCount the grace login count of this user
334             */
335            public void setGraceLoginCount(int graceLoginCount);
336    
337            /**
338             * Returns the screen name of this user.
339             *
340             * @return the screen name of this user
341             */
342            @AutoEscape
343            public String getScreenName();
344    
345            /**
346             * Sets the screen name of this user.
347             *
348             * @param screenName the screen name of this user
349             */
350            public void setScreenName(String screenName);
351    
352            /**
353             * Returns the email address of this user.
354             *
355             * @return the email address of this user
356             */
357            @AutoEscape
358            public String getEmailAddress();
359    
360            /**
361             * Sets the email address of this user.
362             *
363             * @param emailAddress the email address of this user
364             */
365            public void setEmailAddress(String emailAddress);
366    
367            /**
368             * Returns the facebook ID of this user.
369             *
370             * @return the facebook ID of this user
371             */
372            public long getFacebookId();
373    
374            /**
375             * Sets the facebook ID of this user.
376             *
377             * @param facebookId the facebook ID of this user
378             */
379            public void setFacebookId(long facebookId);
380    
381            /**
382             * Returns the ldap server ID of this user.
383             *
384             * @return the ldap server ID of this user
385             */
386            public long getLdapServerId();
387    
388            /**
389             * Sets the ldap server ID of this user.
390             *
391             * @param ldapServerId the ldap server ID of this user
392             */
393            public void setLdapServerId(long ldapServerId);
394    
395            /**
396             * Returns the open ID of this user.
397             *
398             * @return the open ID of this user
399             */
400            @AutoEscape
401            public String getOpenId();
402    
403            /**
404             * Sets the open ID of this user.
405             *
406             * @param openId the open ID of this user
407             */
408            public void setOpenId(String openId);
409    
410            /**
411             * Returns the portrait ID of this user.
412             *
413             * @return the portrait ID of this user
414             */
415            public long getPortraitId();
416    
417            /**
418             * Sets the portrait ID of this user.
419             *
420             * @param portraitId the portrait ID of this user
421             */
422            public void setPortraitId(long portraitId);
423    
424            /**
425             * Returns the language ID of this user.
426             *
427             * @return the language ID of this user
428             */
429            @AutoEscape
430            public String getLanguageId();
431    
432            /**
433             * Sets the language ID of this user.
434             *
435             * @param languageId the language ID of this user
436             */
437            public void setLanguageId(String languageId);
438    
439            /**
440             * Returns the time zone ID of this user.
441             *
442             * @return the time zone ID of this user
443             */
444            @AutoEscape
445            public String getTimeZoneId();
446    
447            /**
448             * Sets the time zone ID of this user.
449             *
450             * @param timeZoneId the time zone ID of this user
451             */
452            public void setTimeZoneId(String timeZoneId);
453    
454            /**
455             * Returns the greeting of this user.
456             *
457             * @return the greeting of this user
458             */
459            @AutoEscape
460            public String getGreeting();
461    
462            /**
463             * Sets the greeting of this user.
464             *
465             * @param greeting the greeting of this user
466             */
467            public void setGreeting(String greeting);
468    
469            /**
470             * Returns the comments of this user.
471             *
472             * @return the comments of this user
473             */
474            @AutoEscape
475            public String getComments();
476    
477            /**
478             * Sets the comments of this user.
479             *
480             * @param comments the comments of this user
481             */
482            public void setComments(String comments);
483    
484            /**
485             * Returns the first name of this user.
486             *
487             * @return the first name of this user
488             */
489            @AutoEscape
490            public String getFirstName();
491    
492            /**
493             * Sets the first name of this user.
494             *
495             * @param firstName the first name of this user
496             */
497            public void setFirstName(String firstName);
498    
499            /**
500             * Returns the middle name of this user.
501             *
502             * @return the middle name of this user
503             */
504            @AutoEscape
505            public String getMiddleName();
506    
507            /**
508             * Sets the middle name of this user.
509             *
510             * @param middleName the middle name of this user
511             */
512            public void setMiddleName(String middleName);
513    
514            /**
515             * Returns the last name of this user.
516             *
517             * @return the last name of this user
518             */
519            @AutoEscape
520            public String getLastName();
521    
522            /**
523             * Sets the last name of this user.
524             *
525             * @param lastName the last name of this user
526             */
527            public void setLastName(String lastName);
528    
529            /**
530             * Returns the job title of this user.
531             *
532             * @return the job title of this user
533             */
534            @AutoEscape
535            public String getJobTitle();
536    
537            /**
538             * Sets the job title of this user.
539             *
540             * @param jobTitle the job title of this user
541             */
542            public void setJobTitle(String jobTitle);
543    
544            /**
545             * Returns the login date of this user.
546             *
547             * @return the login date of this user
548             */
549            public Date getLoginDate();
550    
551            /**
552             * Sets the login date of this user.
553             *
554             * @param loginDate the login date of this user
555             */
556            public void setLoginDate(Date loginDate);
557    
558            /**
559             * Returns the login i p of this user.
560             *
561             * @return the login i p of this user
562             */
563            @AutoEscape
564            public String getLoginIP();
565    
566            /**
567             * Sets the login i p of this user.
568             *
569             * @param loginIP the login i p of this user
570             */
571            public void setLoginIP(String loginIP);
572    
573            /**
574             * Returns the last login date of this user.
575             *
576             * @return the last login date of this user
577             */
578            public Date getLastLoginDate();
579    
580            /**
581             * Sets the last login date of this user.
582             *
583             * @param lastLoginDate the last login date of this user
584             */
585            public void setLastLoginDate(Date lastLoginDate);
586    
587            /**
588             * Returns the last login i p of this user.
589             *
590             * @return the last login i p of this user
591             */
592            @AutoEscape
593            public String getLastLoginIP();
594    
595            /**
596             * Sets the last login i p of this user.
597             *
598             * @param lastLoginIP the last login i p of this user
599             */
600            public void setLastLoginIP(String lastLoginIP);
601    
602            /**
603             * Returns the last failed login date of this user.
604             *
605             * @return the last failed login date of this user
606             */
607            public Date getLastFailedLoginDate();
608    
609            /**
610             * Sets the last failed login date of this user.
611             *
612             * @param lastFailedLoginDate the last failed login date of this user
613             */
614            public void setLastFailedLoginDate(Date lastFailedLoginDate);
615    
616            /**
617             * Returns the failed login attempts of this user.
618             *
619             * @return the failed login attempts of this user
620             */
621            public int getFailedLoginAttempts();
622    
623            /**
624             * Sets the failed login attempts of this user.
625             *
626             * @param failedLoginAttempts the failed login attempts of this user
627             */
628            public void setFailedLoginAttempts(int failedLoginAttempts);
629    
630            /**
631             * Returns the lockout of this user.
632             *
633             * @return the lockout of this user
634             */
635            public boolean getLockout();
636    
637            /**
638             * Returns <code>true</code> if this user is lockout.
639             *
640             * @return <code>true</code> if this user is lockout; <code>false</code> otherwise
641             */
642            public boolean isLockout();
643    
644            /**
645             * Sets whether this user is lockout.
646             *
647             * @param lockout the lockout of this user
648             */
649            public void setLockout(boolean lockout);
650    
651            /**
652             * Returns the lockout date of this user.
653             *
654             * @return the lockout date of this user
655             */
656            public Date getLockoutDate();
657    
658            /**
659             * Sets the lockout date of this user.
660             *
661             * @param lockoutDate the lockout date of this user
662             */
663            public void setLockoutDate(Date lockoutDate);
664    
665            /**
666             * Returns the agreed to terms of use of this user.
667             *
668             * @return the agreed to terms of use of this user
669             */
670            public boolean getAgreedToTermsOfUse();
671    
672            /**
673             * Returns <code>true</code> if this user is agreed to terms of use.
674             *
675             * @return <code>true</code> if this user is agreed to terms of use; <code>false</code> otherwise
676             */
677            public boolean isAgreedToTermsOfUse();
678    
679            /**
680             * Sets whether this user is agreed to terms of use.
681             *
682             * @param agreedToTermsOfUse the agreed to terms of use of this user
683             */
684            public void setAgreedToTermsOfUse(boolean agreedToTermsOfUse);
685    
686            /**
687             * Returns the email address verified of this user.
688             *
689             * @return the email address verified of this user
690             */
691            public boolean getEmailAddressVerified();
692    
693            /**
694             * Returns <code>true</code> if this user is email address verified.
695             *
696             * @return <code>true</code> if this user is email address verified; <code>false</code> otherwise
697             */
698            public boolean isEmailAddressVerified();
699    
700            /**
701             * Sets whether this user is email address verified.
702             *
703             * @param emailAddressVerified the email address verified of this user
704             */
705            public void setEmailAddressVerified(boolean emailAddressVerified);
706    
707            /**
708             * Returns the status of this user.
709             *
710             * @return the status of this user
711             */
712            public int getStatus();
713    
714            /**
715             * Sets the status of this user.
716             *
717             * @param status the status of this user
718             */
719            public void setStatus(int status);
720    
721            @Override
722            public boolean isNew();
723    
724            @Override
725            public void setNew(boolean n);
726    
727            @Override
728            public boolean isCachedModel();
729    
730            @Override
731            public void setCachedModel(boolean cachedModel);
732    
733            @Override
734            public boolean isEscapedModel();
735    
736            @Override
737            public Serializable getPrimaryKeyObj();
738    
739            @Override
740            public void setPrimaryKeyObj(Serializable primaryKeyObj);
741    
742            @Override
743            public ExpandoBridge getExpandoBridge();
744    
745            @Override
746            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
747    
748            @Override
749            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
750    
751            @Override
752            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
753    
754            @Override
755            public Object clone();
756    
757            @Override
758            public int compareTo(com.liferay.portal.model.User user);
759    
760            @Override
761            public int hashCode();
762    
763            @Override
764            public CacheModel<com.liferay.portal.model.User> toCacheModel();
765    
766            @Override
767            public com.liferay.portal.model.User toEscapedModel();
768    
769            @Override
770            public com.liferay.portal.model.User toUnescapedModel();
771    
772            @Override
773            public String toString();
774    
775            @Override
776            public String toXmlString();
777    }