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