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