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