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    /**
018     * 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.
019     *
020     * @author Brian Wing Shun Chan
021     * @see UserModel
022     * @see com.liferay.portal.model.impl.UserImpl
023     * @see com.liferay.portal.model.impl.UserModelImpl
024     * @generated
025     */
026    public interface User extends UserModel, PersistedModel {
027            /*
028             * NOTE FOR DEVELOPERS:
029             *
030             * 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.
031             */
032            public void addRemotePreference(
033                    com.liferay.portal.kernel.util.RemotePreference remotePreference);
034    
035            public java.util.List<com.liferay.portal.model.Address> getAddresses()
036                    throws com.liferay.portal.kernel.exception.SystemException;
037    
038            public java.util.Date getBirthday()
039                    throws com.liferay.portal.kernel.exception.PortalException,
040                            com.liferay.portal.kernel.exception.SystemException;
041    
042            public java.lang.String getCompanyMx()
043                    throws com.liferay.portal.kernel.exception.PortalException,
044                            com.liferay.portal.kernel.exception.SystemException;
045    
046            public com.liferay.portal.model.Contact getContact()
047                    throws com.liferay.portal.kernel.exception.PortalException,
048                            com.liferay.portal.kernel.exception.SystemException;
049    
050            public java.lang.String getDigest(java.lang.String password);
051    
052            public java.lang.String getDisplayEmailAddress();
053    
054            public java.lang.String getDisplayURL(java.lang.String portalURL,
055                    java.lang.String mainPath)
056                    throws com.liferay.portal.kernel.exception.PortalException,
057                            com.liferay.portal.kernel.exception.SystemException;
058    
059            public java.lang.String getDisplayURL(java.lang.String portalURL,
060                    java.lang.String mainPath, boolean privateLayout)
061                    throws com.liferay.portal.kernel.exception.PortalException,
062                            com.liferay.portal.kernel.exception.SystemException;
063    
064            public java.lang.String getDisplayURL(
065                    com.liferay.portal.theme.ThemeDisplay themeDisplay)
066                    throws com.liferay.portal.kernel.exception.PortalException,
067                            com.liferay.portal.kernel.exception.SystemException;
068    
069            public java.lang.String getDisplayURL(
070                    com.liferay.portal.theme.ThemeDisplay themeDisplay,
071                    boolean privateLayout)
072                    throws com.liferay.portal.kernel.exception.PortalException,
073                            com.liferay.portal.kernel.exception.SystemException;
074    
075            public java.util.List<com.liferay.portal.model.EmailAddress> getEmailAddresses()
076                    throws com.liferay.portal.kernel.exception.SystemException;
077    
078            public boolean getFemale()
079                    throws com.liferay.portal.kernel.exception.PortalException,
080                            com.liferay.portal.kernel.exception.SystemException;
081    
082            @com.liferay.portal.kernel.bean.AutoEscape()
083            public java.lang.String getFullName();
084    
085            public com.liferay.portal.model.Group getGroup()
086                    throws com.liferay.portal.kernel.exception.PortalException,
087                            com.liferay.portal.kernel.exception.SystemException;
088    
089            public long getGroupId()
090                    throws com.liferay.portal.kernel.exception.PortalException,
091                            com.liferay.portal.kernel.exception.SystemException;
092    
093            public long[] getGroupIds()
094                    throws com.liferay.portal.kernel.exception.SystemException;
095    
096            public java.util.List<com.liferay.portal.model.Group> getGroups()
097                    throws com.liferay.portal.kernel.exception.SystemException;
098    
099            public java.util.Locale getLocale();
100    
101            public java.lang.String getLogin()
102                    throws com.liferay.portal.kernel.exception.PortalException,
103                            com.liferay.portal.kernel.exception.SystemException;
104    
105            public boolean getMale()
106                    throws com.liferay.portal.kernel.exception.PortalException,
107                            com.liferay.portal.kernel.exception.SystemException;
108    
109            public java.util.List<com.liferay.portal.model.Group> getMySiteGroups()
110                    throws com.liferay.portal.kernel.exception.PortalException,
111                            com.liferay.portal.kernel.exception.SystemException;
112    
113            public java.util.List<com.liferay.portal.model.Group> getMySiteGroups(
114                    boolean includeControlPanel, int max)
115                    throws com.liferay.portal.kernel.exception.PortalException,
116                            com.liferay.portal.kernel.exception.SystemException;
117    
118            public java.util.List<com.liferay.portal.model.Group> getMySiteGroups(
119                    int max)
120                    throws com.liferay.portal.kernel.exception.PortalException,
121                            com.liferay.portal.kernel.exception.SystemException;
122    
123            public java.util.List<com.liferay.portal.model.Group> getMySiteGroups(
124                    java.lang.String[] classNames, boolean includeControlPanel, int max)
125                    throws com.liferay.portal.kernel.exception.PortalException,
126                            com.liferay.portal.kernel.exception.SystemException;
127    
128            public java.util.List<com.liferay.portal.model.Group> getMySiteGroups(
129                    java.lang.String[] classNames, int max)
130                    throws com.liferay.portal.kernel.exception.PortalException,
131                            com.liferay.portal.kernel.exception.SystemException;
132    
133            /**
134            * @deprecated As of 6.2.0, replaced by {@link #getMySiteGroups}
135            */
136            public java.util.List<com.liferay.portal.model.Group> getMySites()
137                    throws com.liferay.portal.kernel.exception.PortalException,
138                            com.liferay.portal.kernel.exception.SystemException;
139    
140            /**
141            * @deprecated As of 6.2.0, replaced by {@link #getMySiteGroups(boolean,
142            int)}
143            */
144            public java.util.List<com.liferay.portal.model.Group> getMySites(
145                    boolean includeControlPanel, int max)
146                    throws com.liferay.portal.kernel.exception.PortalException,
147                            com.liferay.portal.kernel.exception.SystemException;
148    
149            /**
150            * @deprecated As of 6.2.0, replaced by {@link #getMySiteGroups(int)}
151            */
152            public java.util.List<com.liferay.portal.model.Group> getMySites(int max)
153                    throws com.liferay.portal.kernel.exception.PortalException,
154                            com.liferay.portal.kernel.exception.SystemException;
155    
156            /**
157            * @deprecated As of 6.2.0, replaced by {@link #getMySiteGroups(String[],
158            boolean, int)}
159            */
160            public java.util.List<com.liferay.portal.model.Group> getMySites(
161                    java.lang.String[] classNames, boolean includeControlPanel, int max)
162                    throws com.liferay.portal.kernel.exception.PortalException,
163                            com.liferay.portal.kernel.exception.SystemException;
164    
165            /**
166            * @deprecated As of 6.2.0, replaced by {@link #getMySiteGroups(String[],
167            int)}
168            */
169            public java.util.List<com.liferay.portal.model.Group> getMySites(
170                    java.lang.String[] classNames, int max)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException;
173    
174            public long[] getOrganizationIds()
175                    throws com.liferay.portal.kernel.exception.PortalException,
176                            com.liferay.portal.kernel.exception.SystemException;
177    
178            public long[] getOrganizationIds(boolean includeAdministrative)
179                    throws com.liferay.portal.kernel.exception.PortalException,
180                            com.liferay.portal.kernel.exception.SystemException;
181    
182            public java.util.List<com.liferay.portal.model.Organization> getOrganizations()
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException;
185    
186            public java.util.List<com.liferay.portal.model.Organization> getOrganizations(
187                    boolean includeAdministrative)
188                    throws com.liferay.portal.kernel.exception.PortalException,
189                            com.liferay.portal.kernel.exception.SystemException;
190    
191            public boolean getPasswordModified();
192    
193            public com.liferay.portal.model.PasswordPolicy getPasswordPolicy()
194                    throws com.liferay.portal.kernel.exception.PortalException,
195                            com.liferay.portal.kernel.exception.SystemException;
196    
197            public java.lang.String getPasswordUnencrypted();
198    
199            public java.util.List<com.liferay.portal.model.Phone> getPhones()
200                    throws com.liferay.portal.kernel.exception.SystemException;
201    
202            public java.lang.String getPortraitURL(
203                    com.liferay.portal.theme.ThemeDisplay themeDisplay)
204                    throws com.liferay.portal.kernel.exception.PortalException,
205                            com.liferay.portal.kernel.exception.SystemException;
206    
207            public int getPrivateLayoutsPageCount()
208                    throws com.liferay.portal.kernel.exception.PortalException,
209                            com.liferay.portal.kernel.exception.SystemException;
210    
211            public int getPublicLayoutsPageCount()
212                    throws com.liferay.portal.kernel.exception.PortalException,
213                            com.liferay.portal.kernel.exception.SystemException;
214    
215            public java.util.Set<java.lang.String> getReminderQueryQuestions()
216                    throws com.liferay.portal.kernel.exception.PortalException,
217                            com.liferay.portal.kernel.exception.SystemException;
218    
219            public com.liferay.portal.kernel.util.RemotePreference getRemotePreference(
220                    java.lang.String name);
221    
222            public java.lang.Iterable<com.liferay.portal.kernel.util.RemotePreference> getRemotePreferences();
223    
224            public long[] getRoleIds()
225                    throws com.liferay.portal.kernel.exception.SystemException;
226    
227            public java.util.List<com.liferay.portal.model.Role> getRoles()
228                    throws com.liferay.portal.kernel.exception.SystemException;
229    
230            public java.util.List<com.liferay.portal.model.Group> getSiteGroups()
231                    throws com.liferay.portal.kernel.exception.PortalException,
232                            com.liferay.portal.kernel.exception.SystemException;
233    
234            public java.util.List<com.liferay.portal.model.Group> getSiteGroups(
235                    boolean includeAdministrative)
236                    throws com.liferay.portal.kernel.exception.PortalException,
237                            com.liferay.portal.kernel.exception.SystemException;
238    
239            public long[] getTeamIds()
240                    throws com.liferay.portal.kernel.exception.SystemException;
241    
242            public java.util.List<com.liferay.portal.model.Team> getTeams()
243                    throws com.liferay.portal.kernel.exception.SystemException;
244    
245            public java.util.TimeZone getTimeZone();
246    
247            public long[] getUserGroupIds()
248                    throws com.liferay.portal.kernel.exception.SystemException;
249    
250            public java.util.List<com.liferay.portal.model.UserGroup> getUserGroups()
251                    throws com.liferay.portal.kernel.exception.SystemException;
252    
253            public java.util.List<com.liferay.portal.model.Website> getWebsites()
254                    throws com.liferay.portal.kernel.exception.SystemException;
255    
256            public boolean hasCompanyMx()
257                    throws com.liferay.portal.kernel.exception.PortalException,
258                            com.liferay.portal.kernel.exception.SystemException;
259    
260            public boolean hasCompanyMx(java.lang.String emailAddress)
261                    throws com.liferay.portal.kernel.exception.PortalException,
262                            com.liferay.portal.kernel.exception.SystemException;
263    
264            public boolean hasMySites()
265                    throws com.liferay.portal.kernel.exception.PortalException,
266                            com.liferay.portal.kernel.exception.SystemException;
267    
268            public boolean hasOrganization()
269                    throws com.liferay.portal.kernel.exception.PortalException,
270                            com.liferay.portal.kernel.exception.SystemException;
271    
272            public boolean hasPrivateLayouts()
273                    throws com.liferay.portal.kernel.exception.PortalException,
274                            com.liferay.portal.kernel.exception.SystemException;
275    
276            public boolean hasPublicLayouts()
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException;
279    
280            public boolean hasReminderQuery();
281    
282            public boolean isActive();
283    
284            public boolean isFemale()
285                    throws com.liferay.portal.kernel.exception.PortalException,
286                            com.liferay.portal.kernel.exception.SystemException;
287    
288            public boolean isMale()
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException;
291    
292            public boolean isPasswordModified();
293    
294            public void setPasswordModified(boolean passwordModified);
295    
296            public void setPasswordUnencrypted(java.lang.String passwordUnencrypted);
297    }