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    /**
020     * The extended model interface for the User service. Represents a row in the "User_" database table, with each column mapped to a property of this class.
021     *
022     * @author Brian Wing Shun Chan
023     * @see UserModel
024     * @see com.liferay.portal.model.impl.UserImpl
025     * @see com.liferay.portal.model.impl.UserModelImpl
026     * @generated
027     */
028    @ProviderType
029    public interface User extends UserModel, PersistedModel {
030            /*
031             * NOTE FOR DEVELOPERS:
032             *
033             * Never modify this interface directly. Add methods to {@link com.liferay.portal.model.impl.UserImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
034             */
035            public void addRemotePreference(
036                    com.liferay.portal.kernel.util.RemotePreference remotePreference);
037    
038            public java.util.List<com.liferay.portal.model.Address> getAddresses()
039                    throws com.liferay.portal.kernel.exception.SystemException;
040    
041            public java.util.Date getBirthday()
042                    throws com.liferay.portal.kernel.exception.PortalException,
043                            com.liferay.portal.kernel.exception.SystemException;
044    
045            public java.lang.String getCompanyMx()
046                    throws com.liferay.portal.kernel.exception.PortalException,
047                            com.liferay.portal.kernel.exception.SystemException;
048    
049            public com.liferay.portal.model.Contact getContact()
050                    throws com.liferay.portal.kernel.exception.PortalException,
051                            com.liferay.portal.kernel.exception.SystemException;
052    
053            public java.lang.String getDigest(java.lang.String password);
054    
055            public java.lang.String getDisplayEmailAddress();
056    
057            /**
058            * Returns the user's display URL, discounting the URL of the user's default
059            * intranet site home page.
060            *
061            * <p>
062            * The logic for the display URL to return is as follows:
063            * </p>
064            *
065            * <ol>
066            * <li>
067            * If the user is the guest user, return an empty string.
068            * </li>
069            * <li>
070            * Else, if a friendly URL is available for the user's profile, return that
071            * friendly URL.
072            * </li>
073            * <li>
074            * Otherwise, return the URL of the user's default extranet site home page.
075            * </li>
076            * </ol>
077            *
078            * @param portalURL the portal's URL
079            * @param mainPath the main path
080            * @return the user's display URL
081            * @throws PortalException if a portal exception occurred
082            * @throws SystemException if a system exception occurred
083            * @deprecated As of 7.0.0, replaced by {@link #getDisplayURL(ThemeDisplay)}
084            */
085            @java.lang.Deprecated()
086            public java.lang.String getDisplayURL(java.lang.String portalURL,
087                    java.lang.String mainPath)
088                    throws com.liferay.portal.kernel.exception.PortalException,
089                            com.liferay.portal.kernel.exception.SystemException;
090    
091            /**
092            * Returns the user's display URL.
093            *
094            * <p>
095            * The logic for the display URL to return is as follows:
096            * </p>
097            *
098            * <ol>
099            * <li>
100            * If the user is the guest user, return an empty string.
101            * </li>
102            * <li>
103            * Else, if a friendly URL is available for the user's profile, return that
104            * friendly URL.
105            * </li>
106            * <li>
107            * Else, if <code>privateLayout</code> is <code>true</code>, return the URL
108            * of the user's default intranet site home page.
109            * </li>
110            * <li>
111            * Otherwise, return the URL of the user's default extranet site home page.
112            * </li>
113            * </ol>
114            *
115            * @param portalURL the portal's URL
116            * @param mainPath the main path
117            * @param privateLayout whether to use the URL of the user's default
118            intranet(versus extranet)  site home page, if no friendly URL
119            is available for the user's profile
120            * @return the user's display URL
121            * @throws PortalException if a portal exception occurred
122            * @throws SystemException if a system exception occurred
123            * @deprecated As of 7.0.0, replaced by {@link #getDisplayURL(ThemeDisplay)}
124            */
125            @java.lang.Deprecated()
126            public java.lang.String getDisplayURL(java.lang.String portalURL,
127                    java.lang.String mainPath, boolean privateLayout)
128                    throws com.liferay.portal.kernel.exception.PortalException,
129                            com.liferay.portal.kernel.exception.SystemException;
130    
131            /**
132            * Returns the user's display URL based on the theme display, discounting
133            * the URL of the user's default intranet site home page.
134            *
135            * <p>
136            * The logic for the display URL to return is as follows:
137            * </p>
138            *
139            * <ol>
140            * <li>
141            * If the user is the guest user, return an empty string.
142            * </li>
143            * <li>
144            * Else, if a friendly URL is available for the user's profile, return that
145            * friendly URL.
146            * </li>
147            * <li>
148            * Otherwise, return the URL of the user's default extranet site home page.
149            * </li>
150            * </ol>
151            *
152            * @param themeDisplay the theme display
153            * @return the user's display URL
154            * @throws PortalException if a portal exception occurred
155            * @throws SystemException if a system exception occurred
156            */
157            public java.lang.String getDisplayURL(
158                    com.liferay.portal.theme.ThemeDisplay themeDisplay)
159                    throws com.liferay.portal.kernel.exception.PortalException,
160                            com.liferay.portal.kernel.exception.SystemException;
161    
162            /**
163            * Returns the user's display URL based on the theme display.
164            *
165            * <p>
166            * The logic for the display URL to return is as follows:
167            * </p>
168            *
169            * <ol>
170            * <li>
171            * If the user is the guest user, return an empty string.
172            * </li>
173            * <li>
174            * Else, if a friendly URL is available for the user's profile, return that
175            * friendly URL.
176            * </li>
177            * <li>
178            * Else, if <code>privateLayout</code> is <code>true</code>, return the URL
179            * of the user's default intranet site home page.
180            * </li>
181            * <li>
182            * Otherwise, return the URL of the user's default extranet site home page.
183            * </li>
184            * </ol>
185            *
186            * @param themeDisplay the theme display
187            * @param privateLayout whether to use the URL of the user's default
188            intranet (versus extranet) site home page, if no friendly URL is
189            available for the user's profile
190            * @return the user's display URL
191            * @throws PortalException if a portal exception occurred
192            * @throws SystemException if a system exception occurred
193            */
194            public java.lang.String getDisplayURL(
195                    com.liferay.portal.theme.ThemeDisplay themeDisplay,
196                    boolean privateLayout)
197                    throws com.liferay.portal.kernel.exception.PortalException,
198                            com.liferay.portal.kernel.exception.SystemException;
199    
200            /**
201            * Returns the user's email addresses.
202            *
203            * @return the user's email addresses
204            * @throws SystemException if a system exception occurred
205            */
206            public java.util.List<com.liferay.portal.model.EmailAddress> getEmailAddresses()
207                    throws com.liferay.portal.kernel.exception.SystemException;
208    
209            /**
210            * Returns <code>true</code> if the user is female.
211            *
212            * @return <code>true</code> if the user is female; <code>false</code>
213            otherwise
214            * @throws PortalException if a portal exception occurred
215            * @throws SystemException if a system exception occurred
216            */
217            public boolean getFemale()
218                    throws com.liferay.portal.kernel.exception.PortalException,
219                            com.liferay.portal.kernel.exception.SystemException;
220    
221            /**
222            * Returns the user's full name.
223            *
224            * @return the user's full name
225            */
226            @com.liferay.portal.kernel.bean.AutoEscape()
227            public java.lang.String getFullName();
228    
229            public com.liferay.portal.model.Group getGroup()
230                    throws com.liferay.portal.kernel.exception.PortalException,
231                            com.liferay.portal.kernel.exception.SystemException;
232    
233            public long getGroupId()
234                    throws com.liferay.portal.kernel.exception.PortalException,
235                            com.liferay.portal.kernel.exception.SystemException;
236    
237            public long[] getGroupIds()
238                    throws com.liferay.portal.kernel.exception.SystemException;
239    
240            public java.util.List<com.liferay.portal.model.Group> getGroups()
241                    throws com.liferay.portal.kernel.exception.SystemException;
242    
243            public java.util.Locale getLocale();
244    
245            public java.lang.String getLogin()
246                    throws com.liferay.portal.kernel.exception.PortalException,
247                            com.liferay.portal.kernel.exception.SystemException;
248    
249            /**
250            * Returns <code>true</code> if the user is male.
251            *
252            * @return <code>true</code> if the user is male; <code>false</code>
253            otherwise
254            * @throws PortalException if a portal exception occurred
255            * @throws SystemException if a system exception occurred
256            */
257            public boolean getMale()
258                    throws com.liferay.portal.kernel.exception.PortalException,
259                            com.liferay.portal.kernel.exception.SystemException;
260    
261            public java.util.List<com.liferay.portal.model.Group> getMySiteGroups()
262                    throws com.liferay.portal.kernel.exception.PortalException,
263                            com.liferay.portal.kernel.exception.SystemException;
264    
265            public java.util.List<com.liferay.portal.model.Group> getMySiteGroups(
266                    boolean includeControlPanel, int max)
267                    throws com.liferay.portal.kernel.exception.PortalException,
268                            com.liferay.portal.kernel.exception.SystemException;
269    
270            public java.util.List<com.liferay.portal.model.Group> getMySiteGroups(
271                    int max)
272                    throws com.liferay.portal.kernel.exception.PortalException,
273                            com.liferay.portal.kernel.exception.SystemException;
274    
275            public java.util.List<com.liferay.portal.model.Group> getMySiteGroups(
276                    java.lang.String[] classNames, boolean includeControlPanel, int max)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException;
279    
280            public java.util.List<com.liferay.portal.model.Group> getMySiteGroups(
281                    java.lang.String[] classNames, int max)
282                    throws com.liferay.portal.kernel.exception.PortalException,
283                            com.liferay.portal.kernel.exception.SystemException;
284    
285            /**
286            * @deprecated As of 6.2.0, replaced by {@link #getMySiteGroups}
287            */
288            public java.util.List<com.liferay.portal.model.Group> getMySites()
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException;
291    
292            /**
293            * @deprecated As of 6.2.0, replaced by {@link #getMySiteGroups(boolean,
294            int)}
295            */
296            public java.util.List<com.liferay.portal.model.Group> getMySites(
297                    boolean includeControlPanel, int max)
298                    throws com.liferay.portal.kernel.exception.PortalException,
299                            com.liferay.portal.kernel.exception.SystemException;
300    
301            /**
302            * @deprecated As of 6.2.0, replaced by {@link #getMySiteGroups(int)}
303            */
304            public java.util.List<com.liferay.portal.model.Group> getMySites(int max)
305                    throws com.liferay.portal.kernel.exception.PortalException,
306                            com.liferay.portal.kernel.exception.SystemException;
307    
308            /**
309            * @deprecated As of 6.2.0, replaced by {@link #getMySiteGroups(String[],
310            boolean, int)}
311            */
312            public java.util.List<com.liferay.portal.model.Group> getMySites(
313                    java.lang.String[] classNames, boolean includeControlPanel, int max)
314                    throws com.liferay.portal.kernel.exception.PortalException,
315                            com.liferay.portal.kernel.exception.SystemException;
316    
317            /**
318            * @deprecated As of 6.2.0, replaced by {@link #getMySiteGroups(String[],
319            int)}
320            */
321            public java.util.List<com.liferay.portal.model.Group> getMySites(
322                    java.lang.String[] classNames, int max)
323                    throws com.liferay.portal.kernel.exception.PortalException,
324                            com.liferay.portal.kernel.exception.SystemException;
325    
326            public long[] getOrganizationIds()
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException;
329    
330            public long[] getOrganizationIds(boolean includeAdministrative)
331                    throws com.liferay.portal.kernel.exception.PortalException,
332                            com.liferay.portal.kernel.exception.SystemException;
333    
334            public java.util.List<com.liferay.portal.model.Organization> getOrganizations()
335                    throws com.liferay.portal.kernel.exception.PortalException,
336                            com.liferay.portal.kernel.exception.SystemException;
337    
338            public java.util.List<com.liferay.portal.model.Organization> getOrganizations(
339                    boolean includeAdministrative)
340                    throws com.liferay.portal.kernel.exception.PortalException,
341                            com.liferay.portal.kernel.exception.SystemException;
342    
343            public boolean getPasswordModified();
344    
345            public com.liferay.portal.model.PasswordPolicy getPasswordPolicy()
346                    throws com.liferay.portal.kernel.exception.PortalException,
347                            com.liferay.portal.kernel.exception.SystemException;
348    
349            public java.lang.String getPasswordUnencrypted();
350    
351            public java.util.List<com.liferay.portal.model.Phone> getPhones()
352                    throws com.liferay.portal.kernel.exception.SystemException;
353    
354            public java.lang.String getPortraitURL(
355                    com.liferay.portal.theme.ThemeDisplay themeDisplay)
356                    throws com.liferay.portal.kernel.exception.PortalException,
357                            com.liferay.portal.kernel.exception.SystemException;
358    
359            public int getPrivateLayoutsPageCount()
360                    throws com.liferay.portal.kernel.exception.PortalException,
361                            com.liferay.portal.kernel.exception.SystemException;
362    
363            public int getPublicLayoutsPageCount()
364                    throws com.liferay.portal.kernel.exception.PortalException,
365                            com.liferay.portal.kernel.exception.SystemException;
366    
367            public java.util.Set<java.lang.String> getReminderQueryQuestions()
368                    throws com.liferay.portal.kernel.exception.PortalException,
369                            com.liferay.portal.kernel.exception.SystemException;
370    
371            public com.liferay.portal.kernel.util.RemotePreference getRemotePreference(
372                    java.lang.String name);
373    
374            public java.lang.Iterable<com.liferay.portal.kernel.util.RemotePreference> getRemotePreferences();
375    
376            public long[] getRoleIds()
377                    throws com.liferay.portal.kernel.exception.SystemException;
378    
379            public java.util.List<com.liferay.portal.model.Role> getRoles()
380                    throws com.liferay.portal.kernel.exception.SystemException;
381    
382            public java.util.List<com.liferay.portal.model.Group> getSiteGroups()
383                    throws com.liferay.portal.kernel.exception.PortalException,
384                            com.liferay.portal.kernel.exception.SystemException;
385    
386            public java.util.List<com.liferay.portal.model.Group> getSiteGroups(
387                    boolean includeAdministrative)
388                    throws com.liferay.portal.kernel.exception.PortalException,
389                            com.liferay.portal.kernel.exception.SystemException;
390    
391            public long[] getTeamIds()
392                    throws com.liferay.portal.kernel.exception.SystemException;
393    
394            public java.util.List<com.liferay.portal.model.Team> getTeams()
395                    throws com.liferay.portal.kernel.exception.SystemException;
396    
397            public java.util.TimeZone getTimeZone();
398    
399            public long[] getUserGroupIds()
400                    throws com.liferay.portal.kernel.exception.SystemException;
401    
402            public java.util.List<com.liferay.portal.model.UserGroup> getUserGroups()
403                    throws com.liferay.portal.kernel.exception.SystemException;
404    
405            public java.util.List<com.liferay.portal.model.Website> getWebsites()
406                    throws com.liferay.portal.kernel.exception.SystemException;
407    
408            public boolean hasCompanyMx()
409                    throws com.liferay.portal.kernel.exception.PortalException,
410                            com.liferay.portal.kernel.exception.SystemException;
411    
412            public boolean hasCompanyMx(java.lang.String emailAddress)
413                    throws com.liferay.portal.kernel.exception.PortalException,
414                            com.liferay.portal.kernel.exception.SystemException;
415    
416            public boolean hasMySites()
417                    throws com.liferay.portal.kernel.exception.PortalException,
418                            com.liferay.portal.kernel.exception.SystemException;
419    
420            public boolean hasOrganization()
421                    throws com.liferay.portal.kernel.exception.PortalException,
422                            com.liferay.portal.kernel.exception.SystemException;
423    
424            public boolean hasPrivateLayouts()
425                    throws com.liferay.portal.kernel.exception.PortalException,
426                            com.liferay.portal.kernel.exception.SystemException;
427    
428            public boolean hasPublicLayouts()
429                    throws com.liferay.portal.kernel.exception.PortalException,
430                            com.liferay.portal.kernel.exception.SystemException;
431    
432            public boolean hasReminderQuery();
433    
434            public boolean isActive();
435    
436            public boolean isEmailAddressComplete();
437    
438            public boolean isEmailAddressVerificationComplete();
439    
440            public boolean isFemale()
441                    throws com.liferay.portal.kernel.exception.PortalException,
442                            com.liferay.portal.kernel.exception.SystemException;
443    
444            public boolean isMale()
445                    throws com.liferay.portal.kernel.exception.PortalException,
446                            com.liferay.portal.kernel.exception.SystemException;
447    
448            public boolean isPasswordModified();
449    
450            public boolean isReminderQueryComplete();
451    
452            public boolean isSetupComplete();
453    
454            public boolean isTermsOfUseComplete();
455    
456            public void setPasswordModified(boolean passwordModified);
457    
458            public void setPasswordUnencrypted(java.lang.String passwordUnencrypted);
459    }