1   /**
2    * Copyright (c) 2000-2008 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.service;
24  
25  
26  /**
27   * <a href="UserLocalService.java.html"><b><i>View Source</i></b></a>
28   *
29   * <p>
30   * ServiceBuilder generated this class. Modifications in this class will be
31   * overwritten the next time is generated.
32   * </p>
33   *
34   * <p>
35   * This interface defines the service. The default implementation is
36   * <code>com.liferay.portal.service.impl.UserLocalServiceImpl</code>.
37   * Modify methods in that class and rerun ServiceBuilder to populate this class
38   * and all other generated classes.
39   * </p>
40   *
41   * <p>
42   * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
43   * </p>
44   *
45   * @author Brian Wing Shun Chan
46   *
47   * @see com.liferay.portal.service.UserLocalServiceFactory
48   * @see com.liferay.portal.service.UserLocalServiceUtil
49   *
50   */
51  public interface UserLocalService {
52      public com.liferay.portal.model.User addUser(
53          com.liferay.portal.model.User user)
54          throws com.liferay.portal.SystemException;
55  
56      public void deleteUser(long userId)
57          throws com.liferay.portal.SystemException,
58              com.liferay.portal.PortalException;
59  
60      public void deleteUser(com.liferay.portal.model.User user)
61          throws com.liferay.portal.SystemException,
62              com.liferay.portal.PortalException;
63  
64      public java.util.List<com.liferay.portal.model.User> dynamicQuery(
65          com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer)
66          throws com.liferay.portal.SystemException;
67  
68      public java.util.List<com.liferay.portal.model.User> dynamicQuery(
69          com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer,
70          int begin, int end) throws com.liferay.portal.SystemException;
71  
72      public com.liferay.portal.model.User updateUser(
73          com.liferay.portal.model.User user)
74          throws com.liferay.portal.SystemException;
75  
76      public void addGroupUsers(long groupId, long[] userIds)
77          throws com.liferay.portal.SystemException,
78              com.liferay.portal.PortalException;
79  
80      public void addOrganizationUsers(long organizationId, long[] userIds)
81          throws com.liferay.portal.SystemException,
82              com.liferay.portal.PortalException;
83  
84      public void addPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
85          throws com.liferay.portal.SystemException,
86              com.liferay.portal.PortalException;
87  
88      public void addRoleUsers(long roleId, long[] userIds)
89          throws com.liferay.portal.SystemException,
90              com.liferay.portal.PortalException;
91  
92      public void addUserGroupUsers(long userGroupId, long[] userIds)
93          throws com.liferay.portal.SystemException,
94              com.liferay.portal.PortalException;
95  
96      public com.liferay.portal.model.User addUser(long creatorUserId,
97          long companyId, boolean autoPassword, java.lang.String password1,
98          java.lang.String password2, boolean autoScreenName,
99          java.lang.String screenName, java.lang.String emailAddress,
100         java.util.Locale locale, java.lang.String firstName,
101         java.lang.String middleName, java.lang.String lastName, int prefixId,
102         int suffixId, boolean male, int birthdayMonth, int birthdayDay,
103         int birthdayYear, java.lang.String jobTitle, long[] organizationIds,
104         boolean sendEmail)
105         throws com.liferay.portal.SystemException,
106             com.liferay.portal.PortalException;
107 
108     public int authenticateByEmailAddress(long companyId,
109         java.lang.String emailAddress, java.lang.String password,
110         java.util.Map<String, String[]> headerMap,
111         java.util.Map<String, String[]> parameterMap)
112         throws com.liferay.portal.SystemException,
113             com.liferay.portal.PortalException;
114 
115     public int authenticateByScreenName(long companyId,
116         java.lang.String screenName, java.lang.String password,
117         java.util.Map<String, String[]> headerMap,
118         java.util.Map<String, String[]> parameterMap)
119         throws com.liferay.portal.SystemException,
120             com.liferay.portal.PortalException;
121 
122     public int authenticateByUserId(long companyId, long userId,
123         java.lang.String password, java.util.Map<String, String[]> headerMap,
124         java.util.Map<String, String[]> parameterMap)
125         throws com.liferay.portal.SystemException,
126             com.liferay.portal.PortalException;
127 
128     public long authenticateForBasic(long companyId, java.lang.String authType,
129         java.lang.String login, java.lang.String password)
130         throws com.liferay.portal.SystemException,
131             com.liferay.portal.PortalException;
132 
133     public boolean authenticateForJAAS(long userId, java.lang.String encPassword)
134         throws com.liferay.portal.SystemException,
135             com.liferay.portal.PortalException;
136 
137     public void checkLockout(com.liferay.portal.model.User user)
138         throws com.liferay.portal.SystemException,
139             com.liferay.portal.PortalException;
140 
141     public void checkLoginFailure(com.liferay.portal.model.User user)
142         throws com.liferay.portal.SystemException,
143             com.liferay.portal.PortalException;
144 
145     public void checkLoginFailureByEmailAddress(long companyId,
146         java.lang.String emailAddress)
147         throws com.liferay.portal.SystemException,
148             com.liferay.portal.PortalException;
149 
150     public void checkLoginFailureById(long userId)
151         throws com.liferay.portal.SystemException,
152             com.liferay.portal.PortalException;
153 
154     public void checkLoginFailureByScreenName(long companyId,
155         java.lang.String screenName)
156         throws com.liferay.portal.SystemException,
157             com.liferay.portal.PortalException;
158 
159     public void checkPasswordExpired(com.liferay.portal.model.User user)
160         throws com.liferay.portal.SystemException,
161             com.liferay.portal.PortalException;
162 
163     public void clearOrganizationUsers(long organizationId)
164         throws com.liferay.portal.SystemException,
165             com.liferay.portal.PortalException;
166 
167     public void clearUserGroupUsers(long userGroupId)
168         throws com.liferay.portal.SystemException,
169             com.liferay.portal.PortalException;
170 
171     public com.liferay.portal.kernel.util.KeyValuePair decryptUserId(
172         long companyId, java.lang.String name, java.lang.String password)
173         throws com.liferay.portal.SystemException,
174             com.liferay.portal.PortalException;
175 
176     public void deletePasswordPolicyUser(long passwordPolicyId, long userId)
177         throws com.liferay.portal.SystemException,
178             com.liferay.portal.PortalException;
179 
180     public void deleteRoleUser(long roleId, long userId)
181         throws com.liferay.portal.SystemException,
182             com.liferay.portal.PortalException;
183 
184     public java.lang.String encryptUserId(java.lang.String name)
185         throws com.liferay.portal.SystemException,
186             com.liferay.portal.PortalException;
187 
188     public com.liferay.portal.model.User getDefaultUser(long companyId)
189         throws com.liferay.portal.SystemException,
190             com.liferay.portal.PortalException;
191 
192     public long getDefaultUserId(long companyId)
193         throws com.liferay.portal.SystemException,
194             com.liferay.portal.PortalException;
195 
196     public java.util.List<com.liferay.portal.model.User> getGroupUsers(
197         long groupId)
198         throws com.liferay.portal.SystemException,
199             com.liferay.portal.PortalException;
200 
201     public int getGroupUsersCount(long groupId)
202         throws com.liferay.portal.SystemException;
203 
204     public int getGroupUsersCount(long groupId, boolean active)
205         throws com.liferay.portal.SystemException,
206             com.liferay.portal.PortalException;
207 
208     public java.util.List<com.liferay.portal.model.User> getNoAnnouncementsDeliveries(
209         java.lang.String type) throws com.liferay.portal.SystemException;
210 
211     public java.util.List<com.liferay.portal.model.User> getOrganizationUsers(
212         long organizationId)
213         throws com.liferay.portal.SystemException,
214             com.liferay.portal.PortalException;
215 
216     public int getOrganizationUsersCount(long organizationId)
217         throws com.liferay.portal.SystemException;
218 
219     public int getOrganizationUsersCount(long organizationId, boolean active)
220         throws com.liferay.portal.SystemException,
221             com.liferay.portal.PortalException;
222 
223     public java.util.List<com.liferay.portal.model.User> getPermissionUsers(
224         long companyId, long groupId, java.lang.String name,
225         java.lang.String primKey, java.lang.String actionId,
226         java.lang.String firstName, java.lang.String middleName,
227         java.lang.String lastName, java.lang.String emailAddress,
228         boolean andOperator, int begin, int end)
229         throws com.liferay.portal.SystemException,
230             com.liferay.portal.PortalException;
231 
232     public int getPermissionUsersCount(long companyId, long groupId,
233         java.lang.String name, java.lang.String primKey,
234         java.lang.String actionId, java.lang.String firstName,
235         java.lang.String middleName, java.lang.String lastName,
236         java.lang.String emailAddress, boolean andOperator)
237         throws com.liferay.portal.SystemException,
238             com.liferay.portal.PortalException;
239 
240     public java.util.List<com.liferay.portal.model.User> getRoleUsers(
241         long roleId)
242         throws com.liferay.portal.SystemException,
243             com.liferay.portal.PortalException;
244 
245     public int getRoleUsersCount(long roleId)
246         throws com.liferay.portal.SystemException;
247 
248     public int getRoleUsersCount(long roleId, boolean active)
249         throws com.liferay.portal.SystemException,
250             com.liferay.portal.PortalException;
251 
252     public java.util.List<com.liferay.portal.model.User> getSocialUsers(
253         long userId, int type, int begin, int end)
254         throws com.liferay.portal.SystemException,
255             com.liferay.portal.PortalException;
256 
257     public int getSocialUsersCount(long userId, int type)
258         throws com.liferay.portal.SystemException,
259             com.liferay.portal.PortalException;
260 
261     public java.util.List<com.liferay.portal.model.User> getUserGroupUsers(
262         long userGroupId)
263         throws com.liferay.portal.SystemException,
264             com.liferay.portal.PortalException;
265 
266     public int getUserGroupUsersCount(long userGroupId)
267         throws com.liferay.portal.SystemException;
268 
269     public int getUserGroupUsersCount(long userGroupId, boolean active)
270         throws com.liferay.portal.SystemException,
271             com.liferay.portal.PortalException;
272 
273     public com.liferay.portal.model.User getUserByContactId(long contactId)
274         throws com.liferay.portal.SystemException,
275             com.liferay.portal.PortalException;
276 
277     public com.liferay.portal.model.User getUserByEmailAddress(long companyId,
278         java.lang.String emailAddress)
279         throws com.liferay.portal.SystemException,
280             com.liferay.portal.PortalException;
281 
282     public com.liferay.portal.model.User getUserById(long userId)
283         throws com.liferay.portal.SystemException,
284             com.liferay.portal.PortalException;
285 
286     public com.liferay.portal.model.User getUserById(long companyId, long userId)
287         throws com.liferay.portal.SystemException,
288             com.liferay.portal.PortalException;
289 
290     public com.liferay.portal.model.User getUserByPortraitId(long portraitId)
291         throws com.liferay.portal.SystemException,
292             com.liferay.portal.PortalException;
293 
294     public com.liferay.portal.model.User getUserByScreenName(long companyId,
295         java.lang.String screenName)
296         throws com.liferay.portal.SystemException,
297             com.liferay.portal.PortalException;
298 
299     public long getUserIdByEmailAddress(long companyId,
300         java.lang.String emailAddress)
301         throws com.liferay.portal.SystemException,
302             com.liferay.portal.PortalException;
303 
304     public long getUserIdByScreenName(long companyId,
305         java.lang.String screenName)
306         throws com.liferay.portal.SystemException,
307             com.liferay.portal.PortalException;
308 
309     public boolean hasGroupUser(long groupId, long userId)
310         throws com.liferay.portal.SystemException,
311             com.liferay.portal.PortalException;
312 
313     public boolean hasOrganizationUser(long organizationId, long userId)
314         throws com.liferay.portal.SystemException,
315             com.liferay.portal.PortalException;
316 
317     public boolean hasPasswordPolicyUser(long passwordPolicyId, long userId)
318         throws com.liferay.portal.SystemException,
319             com.liferay.portal.PortalException;
320 
321     public boolean hasRoleUser(long roleId, long userId)
322         throws com.liferay.portal.SystemException,
323             com.liferay.portal.PortalException;
324 
325     public boolean hasUserGroupUser(long userGroupId, long userId)
326         throws com.liferay.portal.SystemException,
327             com.liferay.portal.PortalException;
328 
329     public boolean isPasswordExpired(com.liferay.portal.model.User user)
330         throws com.liferay.portal.SystemException,
331             com.liferay.portal.PortalException;
332 
333     public boolean isPasswordExpiringSoon(com.liferay.portal.model.User user)
334         throws com.liferay.portal.SystemException,
335             com.liferay.portal.PortalException;
336 
337     public java.util.List<com.liferay.portal.model.User> search(
338         long companyId, java.lang.String keywords, java.lang.Boolean active,
339         java.util.LinkedHashMap<String, Object> params, int begin, int end,
340         com.liferay.portal.kernel.util.OrderByComparator obc)
341         throws com.liferay.portal.SystemException;
342 
343     public java.util.List<com.liferay.portal.model.User> search(
344         long companyId, java.lang.String firstName,
345         java.lang.String middleName, java.lang.String lastName,
346         java.lang.String screenName, java.lang.String emailAddress,
347         java.lang.Boolean active,
348         java.util.LinkedHashMap<String, Object> params, boolean andSearch,
349         int begin, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
350         throws com.liferay.portal.SystemException;
351 
352     public int searchCount(long companyId, java.lang.String keywords,
353         java.lang.Boolean active, java.util.LinkedHashMap<String, Object> params)
354         throws com.liferay.portal.SystemException;
355 
356     public int searchCount(long companyId, java.lang.String firstName,
357         java.lang.String middleName, java.lang.String lastName,
358         java.lang.String screenName, java.lang.String emailAddress,
359         java.lang.Boolean active,
360         java.util.LinkedHashMap<String, Object> params, boolean andSearch)
361         throws com.liferay.portal.SystemException;
362 
363     public void sendPassword(long companyId, java.lang.String emailAddress,
364         java.lang.String remoteAddr, java.lang.String remoteHost,
365         java.lang.String userAgent)
366         throws com.liferay.portal.SystemException,
367             com.liferay.portal.PortalException;
368 
369     public void setRoleUsers(long roleId, long[] userIds)
370         throws com.liferay.portal.SystemException,
371             com.liferay.portal.PortalException;
372 
373     public void setUserGroupUsers(long userGroupId, long[] userIds)
374         throws com.liferay.portal.SystemException,
375             com.liferay.portal.PortalException;
376 
377     public void unsetGroupUsers(long groupId, long[] userIds)
378         throws com.liferay.portal.SystemException,
379             com.liferay.portal.PortalException;
380 
381     public void unsetOrganizationUsers(long organizationId, long[] userIds)
382         throws com.liferay.portal.SystemException,
383             com.liferay.portal.PortalException;
384 
385     public void unsetPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
386         throws com.liferay.portal.SystemException,
387             com.liferay.portal.PortalException;
388 
389     public void unsetRoleUsers(long roleId, long[] userIds)
390         throws com.liferay.portal.SystemException,
391             com.liferay.portal.PortalException;
392 
393     public void unsetUserGroupUsers(long userGroupId, long[] userIds)
394         throws com.liferay.portal.SystemException,
395             com.liferay.portal.PortalException;
396 
397     public com.liferay.portal.model.User updateActive(long userId,
398         boolean active)
399         throws com.liferay.portal.SystemException,
400             com.liferay.portal.PortalException;
401 
402     public com.liferay.portal.model.User updateAgreedToTermsOfUse(long userId,
403         boolean agreedToTermsOfUse)
404         throws com.liferay.portal.SystemException,
405             com.liferay.portal.PortalException;
406 
407     public com.liferay.portal.model.User updateCreateDate(long userId,
408         java.util.Date createDate)
409         throws com.liferay.portal.SystemException,
410             com.liferay.portal.PortalException;
411 
412     public com.liferay.portal.model.User updateLastLogin(long userId,
413         java.lang.String loginIP)
414         throws com.liferay.portal.SystemException,
415             com.liferay.portal.PortalException;
416 
417     public com.liferay.portal.model.User updateLockout(
418         com.liferay.portal.model.User user, boolean lockout)
419         throws com.liferay.portal.SystemException,
420             com.liferay.portal.PortalException;
421 
422     public com.liferay.portal.model.User updateLockoutByEmailAddress(
423         long companyId, java.lang.String emailAddress, boolean lockout)
424         throws com.liferay.portal.SystemException,
425             com.liferay.portal.PortalException;
426 
427     public com.liferay.portal.model.User updateLockoutById(long userId,
428         boolean lockout)
429         throws com.liferay.portal.SystemException,
430             com.liferay.portal.PortalException;
431 
432     public com.liferay.portal.model.User updateLockoutByScreenName(
433         long companyId, java.lang.String screenName, boolean lockout)
434         throws com.liferay.portal.SystemException,
435             com.liferay.portal.PortalException;
436 
437     public com.liferay.portal.model.User updateModifiedDate(long userId,
438         java.util.Date modifiedDate)
439         throws com.liferay.portal.SystemException,
440             com.liferay.portal.PortalException;
441 
442     public void updateOrganizations(long userId, long[] newOrganizationIds)
443         throws com.liferay.portal.SystemException,
444             com.liferay.portal.PortalException;
445 
446     public com.liferay.portal.model.User updatePassword(long userId,
447         java.lang.String password1, java.lang.String password2,
448         boolean passwordReset)
449         throws com.liferay.portal.SystemException,
450             com.liferay.portal.PortalException;
451 
452     public com.liferay.portal.model.User updatePassword(long userId,
453         java.lang.String password1, java.lang.String password2,
454         boolean passwordReset, boolean silentUpdate)
455         throws com.liferay.portal.SystemException,
456             com.liferay.portal.PortalException;
457 
458     public com.liferay.portal.model.User updatePasswordManually(long userId,
459         java.lang.String password, boolean passwordEncrypted,
460         boolean passwordReset, java.util.Date passwordModifiedDate)
461         throws com.liferay.portal.SystemException,
462             com.liferay.portal.PortalException;
463 
464     public void updatePasswordReset(long userId, boolean passwordReset)
465         throws com.liferay.portal.SystemException,
466             com.liferay.portal.PortalException;
467 
468     public void updatePortrait(long userId, byte[] bytes)
469         throws com.liferay.portal.SystemException,
470             com.liferay.portal.PortalException;
471 
472     public void updateScreenName(long userId, java.lang.String screenName)
473         throws com.liferay.portal.SystemException,
474             com.liferay.portal.PortalException;
475 
476     public com.liferay.portal.model.User updateUser(long userId,
477         java.lang.String oldPassword, boolean passwordReset,
478         java.lang.String screenName, java.lang.String emailAddress,
479         java.lang.String languageId, java.lang.String timeZoneId,
480         java.lang.String greeting, java.lang.String comments,
481         java.lang.String firstName, java.lang.String middleName,
482         java.lang.String lastName, int prefixId, int suffixId, boolean male,
483         int birthdayMonth, int birthdayDay, int birthdayYear,
484         java.lang.String smsSn, java.lang.String aimSn, java.lang.String icqSn,
485         java.lang.String jabberSn, java.lang.String msnSn,
486         java.lang.String skypeSn, java.lang.String ymSn,
487         java.lang.String jobTitle, long[] organizationIds)
488         throws com.liferay.portal.SystemException,
489             com.liferay.portal.PortalException;
490 
491     public com.liferay.portal.model.User updateUser(long userId,
492         java.lang.String oldPassword, java.lang.String newPassword1,
493         java.lang.String newPassword2, boolean passwordReset,
494         java.lang.String screenName, java.lang.String emailAddress,
495         java.lang.String languageId, java.lang.String timeZoneId,
496         java.lang.String greeting, java.lang.String comments,
497         java.lang.String firstName, java.lang.String middleName,
498         java.lang.String lastName, int prefixId, int suffixId, boolean male,
499         int birthdayMonth, int birthdayDay, int birthdayYear,
500         java.lang.String smsSn, java.lang.String aimSn, java.lang.String icqSn,
501         java.lang.String jabberSn, java.lang.String msnSn,
502         java.lang.String skypeSn, java.lang.String ymSn,
503         java.lang.String jobTitle, long[] organizationIds)
504         throws com.liferay.portal.SystemException,
505             com.liferay.portal.PortalException;
506 }