001    /**
002     * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.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            /**
039            * Returns the user's addresses.
040            *
041            * @return the user's addresses
042            */
043            public java.util.List<com.liferay.portal.model.Address> getAddresses();
044    
045            /**
046            * Returns the user's birth date.
047            *
048            * @return the user's birth date
049            * @throws PortalException if a portal exception occurred
050            */
051            public java.util.Date getBirthday()
052                    throws com.liferay.portal.kernel.exception.PortalException;
053    
054            /**
055            * Returns the user's company's mail domain.
056            *
057            * @return the user's company's mail domain
058            * @throws PortalException if a portal exception occurred
059            */
060            public java.lang.String getCompanyMx()
061                    throws com.liferay.portal.kernel.exception.PortalException;
062    
063            /**
064            * Returns the user's associated contact.
065            *
066            * @return the user's associated contact
067            * @throws PortalException if a portal exception occurred
068            * @see Contact
069            */
070            public com.liferay.portal.model.Contact getContact()
071                    throws com.liferay.portal.kernel.exception.PortalException;
072    
073            /**
074            * Returns a digest for the user, incorporating the password.
075            *
076            * @param password a password to incorporate with the digest
077            * @return a digest for the user, incorporating the password
078            */
079            public java.lang.String getDigest(java.lang.String password);
080    
081            /**
082            * Returns the user's primary email address, or a blank string if the
083            * address is fake.
084            *
085            * @return the user's primary email address, or a blank string if the
086            address is fake
087            */
088            public java.lang.String getDisplayEmailAddress();
089    
090            /**
091            * Returns the user's display URL, discounting the URL of the user's default
092            * intranet site home page.
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            * Otherwise, return the URL of the user's default extranet site home page.
108            * </li>
109            * </ol>
110            *
111            * @param portalURL the portal's URL
112            * @param mainPath the main path
113            * @return the user's display URL
114            * @throws PortalException if a portal exception occurred
115            * @deprecated As of 7.0.0, replaced by {@link #getDisplayURL(ThemeDisplay)}
116            */
117            @java.lang.Deprecated()
118            public java.lang.String getDisplayURL(java.lang.String portalURL,
119                    java.lang.String mainPath)
120                    throws com.liferay.portal.kernel.exception.PortalException;
121    
122            /**
123            * Returns the user's display URL.
124            *
125            * <p>
126            * The logic for the display URL to return is as follows:
127            * </p>
128            *
129            * <ol>
130            * <li>
131            * If the user is the guest user, return an empty string.
132            * </li>
133            * <li>
134            * Else, if a friendly URL is available for the user's profile, return that
135            * friendly URL.
136            * </li>
137            * <li>
138            * Else, if <code>privateLayout</code> is <code>true</code>, return the URL
139            * of the user's default intranet site home page.
140            * </li>
141            * <li>
142            * Otherwise, return the URL of the user's default extranet site home page.
143            * </li>
144            * </ol>
145            *
146            * @param portalURL the portal's URL
147            * @param mainPath the main path
148            * @param privateLayout whether to use the URL of the user's default
149            intranet(versus extranet)  site home page, if no friendly URL
150            is available for the user's profile
151            * @return the user's display URL
152            * @throws PortalException if a portal exception occurred
153            * @deprecated As of 7.0.0, replaced by {@link #getDisplayURL(ThemeDisplay)}
154            */
155            @java.lang.Deprecated()
156            public java.lang.String getDisplayURL(java.lang.String portalURL,
157                    java.lang.String mainPath, boolean privateLayout)
158                    throws com.liferay.portal.kernel.exception.PortalException;
159    
160            /**
161            * Returns the user's display URL based on the theme display, discounting
162            * the URL of the user's default intranet site home page.
163            *
164            * <p>
165            * The logic for the display URL to return is as follows:
166            * </p>
167            *
168            * <ol>
169            * <li>
170            * If the user is the guest user, return an empty string.
171            * </li>
172            * <li>
173            * Else, if a friendly URL is available for the user's profile, return that
174            * friendly URL.
175            * </li>
176            * <li>
177            * Otherwise, return the URL of the user's default extranet site home page.
178            * </li>
179            * </ol>
180            *
181            * @param themeDisplay the theme display
182            * @return the user's display URL
183            * @throws PortalException if a portal exception occurred
184            */
185            public java.lang.String getDisplayURL(
186                    com.liferay.portal.theme.ThemeDisplay themeDisplay)
187                    throws com.liferay.portal.kernel.exception.PortalException;
188    
189            /**
190            * Returns the user's display URL based on the theme display.
191            *
192            * <p>
193            * The logic for the display URL to return is as follows:
194            * </p>
195            *
196            * <ol>
197            * <li>
198            * If the user is the guest user, return an empty string.
199            * </li>
200            * <li>
201            * Else, if a friendly URL is available for the user's profile, return that
202            * friendly URL.
203            * </li>
204            * <li>
205            * Else, if <code>privateLayout</code> is <code>true</code>, return the URL
206            * of the user's default intranet site home page.
207            * </li>
208            * <li>
209            * Otherwise, return the URL of the user's default extranet site home page.
210            * </li>
211            * </ol>
212            *
213            * @param themeDisplay the theme display
214            * @param privateLayout whether to use the URL of the user's default
215            intranet (versus extranet) site home page, if no friendly URL is
216            available for the user's profile
217            * @return the user's display URL
218            * @throws PortalException if a portal exception occurred
219            */
220            public java.lang.String getDisplayURL(
221                    com.liferay.portal.theme.ThemeDisplay themeDisplay,
222                    boolean privateLayout)
223                    throws com.liferay.portal.kernel.exception.PortalException;
224    
225            /**
226            * Returns the user's email addresses.
227            *
228            * @return the user's email addresses
229            */
230            public java.util.List<com.liferay.portal.model.EmailAddress> getEmailAddresses();
231    
232            /**
233            * Returns <code>true</code> if the user is female.
234            *
235            * @return <code>true</code> if the user is female; <code>false</code>
236            otherwise
237            * @throws PortalException if a portal exception occurred
238            */
239            public boolean getFemale()
240                    throws com.liferay.portal.kernel.exception.PortalException;
241    
242            /**
243            * Returns the user's full name.
244            *
245            * @return the user's full name
246            */
247            @com.liferay.portal.kernel.bean.AutoEscape()
248            public java.lang.String getFullName();
249    
250            public com.liferay.portal.model.Group getGroup()
251                    throws com.liferay.portal.kernel.exception.PortalException;
252    
253            public long getGroupId()
254                    throws com.liferay.portal.kernel.exception.PortalException;
255    
256            public long[] getGroupIds();
257    
258            public java.util.List<com.liferay.portal.model.Group> getGroups();
259    
260            public java.util.Locale getLocale();
261    
262            public java.lang.String getLogin()
263                    throws com.liferay.portal.kernel.exception.PortalException;
264    
265            /**
266            * Returns <code>true</code> if the user is male.
267            *
268            * @return <code>true</code> if the user is male; <code>false</code>
269            otherwise
270            * @throws PortalException if a portal exception occurred
271            */
272            public boolean getMale()
273                    throws com.liferay.portal.kernel.exception.PortalException;
274    
275            public java.util.List<com.liferay.portal.model.Group> getMySiteGroups()
276                    throws com.liferay.portal.kernel.exception.PortalException;
277    
278            public java.util.List<com.liferay.portal.model.Group> getMySiteGroups(
279                    boolean includeControlPanel, int max)
280                    throws com.liferay.portal.kernel.exception.PortalException;
281    
282            public java.util.List<com.liferay.portal.model.Group> getMySiteGroups(
283                    int max) throws com.liferay.portal.kernel.exception.PortalException;
284    
285            public java.util.List<com.liferay.portal.model.Group> getMySiteGroups(
286                    java.lang.String[] classNames, boolean includeControlPanel, int max)
287                    throws com.liferay.portal.kernel.exception.PortalException;
288    
289            public java.util.List<com.liferay.portal.model.Group> getMySiteGroups(
290                    java.lang.String[] classNames, int max)
291                    throws com.liferay.portal.kernel.exception.PortalException;
292    
293            /**
294            * @deprecated As of 6.2.0, replaced by {@link #getMySiteGroups}
295            */
296            @java.lang.Deprecated()
297            public java.util.List<com.liferay.portal.model.Group> getMySites()
298                    throws com.liferay.portal.kernel.exception.PortalException;
299    
300            /**
301            * @deprecated As of 6.2.0, replaced by {@link #getMySiteGroups(boolean,
302            int)}
303            */
304            @java.lang.Deprecated()
305            public java.util.List<com.liferay.portal.model.Group> getMySites(
306                    boolean includeControlPanel, int max)
307                    throws com.liferay.portal.kernel.exception.PortalException;
308    
309            /**
310            * @deprecated As of 6.2.0, replaced by {@link #getMySiteGroups(int)}
311            */
312            @java.lang.Deprecated()
313            public java.util.List<com.liferay.portal.model.Group> getMySites(int max)
314                    throws com.liferay.portal.kernel.exception.PortalException;
315    
316            /**
317            * @deprecated As of 6.2.0, replaced by {@link #getMySiteGroups(String[],
318            boolean, int)}
319            */
320            @java.lang.Deprecated()
321            public java.util.List<com.liferay.portal.model.Group> getMySites(
322                    java.lang.String[] classNames, boolean includeControlPanel, int max)
323                    throws com.liferay.portal.kernel.exception.PortalException;
324    
325            /**
326            * @deprecated As of 6.2.0, replaced by {@link #getMySiteGroups(String[],
327            int)}
328            */
329            @java.lang.Deprecated()
330            public java.util.List<com.liferay.portal.model.Group> getMySites(
331                    java.lang.String[] classNames, int max)
332                    throws com.liferay.portal.kernel.exception.PortalException;
333    
334            public long[] getOrganizationIds()
335                    throws com.liferay.portal.kernel.exception.PortalException;
336    
337            public long[] getOrganizationIds(boolean includeAdministrative)
338                    throws com.liferay.portal.kernel.exception.PortalException;
339    
340            public java.util.List<com.liferay.portal.model.Organization> getOrganizations()
341                    throws com.liferay.portal.kernel.exception.PortalException;
342    
343            public java.util.List<com.liferay.portal.model.Organization> getOrganizations(
344                    boolean includeAdministrative)
345                    throws com.liferay.portal.kernel.exception.PortalException;
346    
347            public boolean getPasswordModified();
348    
349            public com.liferay.portal.model.PasswordPolicy getPasswordPolicy()
350                    throws com.liferay.portal.kernel.exception.PortalException;
351    
352            public java.lang.String getPasswordUnencrypted();
353    
354            public java.util.List<com.liferay.portal.model.Phone> getPhones();
355    
356            public java.lang.String getPortraitURL(
357                    com.liferay.portal.theme.ThemeDisplay themeDisplay)
358                    throws com.liferay.portal.kernel.exception.PortalException;
359    
360            public int getPrivateLayoutsPageCount()
361                    throws com.liferay.portal.kernel.exception.PortalException;
362    
363            public int getPublicLayoutsPageCount()
364                    throws com.liferay.portal.kernel.exception.PortalException;
365    
366            public java.util.Set<java.lang.String> getReminderQueryQuestions()
367                    throws com.liferay.portal.kernel.exception.PortalException;
368    
369            public com.liferay.portal.kernel.util.RemotePreference getRemotePreference(
370                    java.lang.String name);
371    
372            public java.lang.Iterable<com.liferay.portal.kernel.util.RemotePreference> getRemotePreferences();
373    
374            public long[] getRoleIds();
375    
376            public java.util.List<com.liferay.portal.model.Role> getRoles();
377    
378            public java.util.List<com.liferay.portal.model.Group> getSiteGroups()
379                    throws com.liferay.portal.kernel.exception.PortalException;
380    
381            public java.util.List<com.liferay.portal.model.Group> getSiteGroups(
382                    boolean includeAdministrative)
383                    throws com.liferay.portal.kernel.exception.PortalException;
384    
385            public long[] getTeamIds();
386    
387            public java.util.List<com.liferay.portal.model.Team> getTeams();
388    
389            public java.util.TimeZone getTimeZone();
390    
391            public long[] getUserGroupIds();
392    
393            public java.util.List<com.liferay.portal.model.UserGroup> getUserGroups();
394    
395            public java.util.List<com.liferay.portal.model.Website> getWebsites();
396    
397            public boolean hasCompanyMx()
398                    throws com.liferay.portal.kernel.exception.PortalException;
399    
400            public boolean hasCompanyMx(java.lang.String emailAddress)
401                    throws com.liferay.portal.kernel.exception.PortalException;
402    
403            public boolean hasMySites()
404                    throws com.liferay.portal.kernel.exception.PortalException;
405    
406            public boolean hasOrganization();
407    
408            public boolean hasPrivateLayouts()
409                    throws com.liferay.portal.kernel.exception.PortalException;
410    
411            public boolean hasPublicLayouts()
412                    throws com.liferay.portal.kernel.exception.PortalException;
413    
414            public boolean hasReminderQuery();
415    
416            public boolean isActive();
417    
418            public boolean isEmailAddressComplete();
419    
420            public boolean isEmailAddressVerificationComplete();
421    
422            public boolean isFemale()
423                    throws com.liferay.portal.kernel.exception.PortalException;
424    
425            public boolean isMale()
426                    throws com.liferay.portal.kernel.exception.PortalException;
427    
428            public boolean isPasswordModified();
429    
430            public boolean isReminderQueryComplete();
431    
432            public boolean isSetupComplete();
433    
434            public boolean isTermsOfUseComplete();
435    
436            public void setPasswordModified(boolean passwordModified);
437    
438            public void setPasswordUnencrypted(java.lang.String passwordUnencrypted);
439    }