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