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