1
22
23 package com.liferay.portal.service;
24
25
26
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 begin, int end)
254 throws com.liferay.portal.SystemException,
255 com.liferay.portal.PortalException;
256
257 public java.util.List<com.liferay.portal.model.User> getSocialUsers(
258 long userId, int type, int begin, int end)
259 throws com.liferay.portal.SystemException,
260 com.liferay.portal.PortalException;
261
262 public java.util.List<com.liferay.portal.model.User> getSocialUsers(
263 long userId1, long userId2, int type, int begin, int end)
264 throws com.liferay.portal.SystemException,
265 com.liferay.portal.PortalException;
266
267 public int getSocialUsersCount(long userId)
268 throws com.liferay.portal.SystemException,
269 com.liferay.portal.PortalException;
270
271 public int getSocialUsersCount(long userId, int type)
272 throws com.liferay.portal.SystemException,
273 com.liferay.portal.PortalException;
274
275 public int getSocialUsersCount(long userId1, long userId2, int type)
276 throws com.liferay.portal.SystemException,
277 com.liferay.portal.PortalException;
278
279 public java.util.List<com.liferay.portal.model.User> getUserGroupUsers(
280 long userGroupId)
281 throws com.liferay.portal.SystemException,
282 com.liferay.portal.PortalException;
283
284 public int getUserGroupUsersCount(long userGroupId)
285 throws com.liferay.portal.SystemException;
286
287 public int getUserGroupUsersCount(long userGroupId, boolean active)
288 throws com.liferay.portal.SystemException,
289 com.liferay.portal.PortalException;
290
291 public com.liferay.portal.model.User getUserByContactId(long contactId)
292 throws com.liferay.portal.SystemException,
293 com.liferay.portal.PortalException;
294
295 public com.liferay.portal.model.User getUserByEmailAddress(long companyId,
296 java.lang.String emailAddress)
297 throws com.liferay.portal.SystemException,
298 com.liferay.portal.PortalException;
299
300 public com.liferay.portal.model.User getUserById(long userId)
301 throws com.liferay.portal.SystemException,
302 com.liferay.portal.PortalException;
303
304 public com.liferay.portal.model.User getUserById(long companyId, long userId)
305 throws com.liferay.portal.SystemException,
306 com.liferay.portal.PortalException;
307
308 public com.liferay.portal.model.User getUserByPortraitId(long portraitId)
309 throws com.liferay.portal.SystemException,
310 com.liferay.portal.PortalException;
311
312 public com.liferay.portal.model.User getUserByScreenName(long companyId,
313 java.lang.String screenName)
314 throws com.liferay.portal.SystemException,
315 com.liferay.portal.PortalException;
316
317 public long getUserIdByEmailAddress(long companyId,
318 java.lang.String emailAddress)
319 throws com.liferay.portal.SystemException,
320 com.liferay.portal.PortalException;
321
322 public long getUserIdByScreenName(long companyId,
323 java.lang.String screenName)
324 throws com.liferay.portal.SystemException,
325 com.liferay.portal.PortalException;
326
327 public boolean hasGroupUser(long groupId, long userId)
328 throws com.liferay.portal.SystemException,
329 com.liferay.portal.PortalException;
330
331 public boolean hasOrganizationUser(long organizationId, long userId)
332 throws com.liferay.portal.SystemException,
333 com.liferay.portal.PortalException;
334
335 public boolean hasPasswordPolicyUser(long passwordPolicyId, long userId)
336 throws com.liferay.portal.SystemException,
337 com.liferay.portal.PortalException;
338
339 public boolean hasRoleUser(long roleId, long userId)
340 throws com.liferay.portal.SystemException,
341 com.liferay.portal.PortalException;
342
343 public boolean hasUserGroupUser(long userGroupId, long userId)
344 throws com.liferay.portal.SystemException,
345 com.liferay.portal.PortalException;
346
347 public boolean isPasswordExpired(com.liferay.portal.model.User user)
348 throws com.liferay.portal.SystemException,
349 com.liferay.portal.PortalException;
350
351 public boolean isPasswordExpiringSoon(com.liferay.portal.model.User user)
352 throws com.liferay.portal.SystemException,
353 com.liferay.portal.PortalException;
354
355 public java.util.List<com.liferay.portal.model.User> search(
356 long companyId, java.lang.String keywords, java.lang.Boolean active,
357 java.util.LinkedHashMap<String, Object> params, int begin, int end,
358 com.liferay.portal.kernel.util.OrderByComparator obc)
359 throws com.liferay.portal.SystemException;
360
361 public java.util.List<com.liferay.portal.model.User> search(
362 long companyId, java.lang.String firstName,
363 java.lang.String middleName, java.lang.String lastName,
364 java.lang.String screenName, java.lang.String emailAddress,
365 java.lang.Boolean active,
366 java.util.LinkedHashMap<String, Object> params, boolean andSearch,
367 int begin, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
368 throws com.liferay.portal.SystemException;
369
370 public int searchCount(long companyId, java.lang.String keywords,
371 java.lang.Boolean active, java.util.LinkedHashMap<String, Object> params)
372 throws com.liferay.portal.SystemException;
373
374 public int searchCount(long companyId, java.lang.String firstName,
375 java.lang.String middleName, java.lang.String lastName,
376 java.lang.String screenName, java.lang.String emailAddress,
377 java.lang.Boolean active,
378 java.util.LinkedHashMap<String, Object> params, boolean andSearch)
379 throws com.liferay.portal.SystemException;
380
381 public void sendPassword(long companyId, java.lang.String emailAddress,
382 java.lang.String remoteAddr, java.lang.String remoteHost,
383 java.lang.String userAgent)
384 throws com.liferay.portal.SystemException,
385 com.liferay.portal.PortalException;
386
387 public void setRoleUsers(long roleId, long[] userIds)
388 throws com.liferay.portal.SystemException,
389 com.liferay.portal.PortalException;
390
391 public void setUserGroupUsers(long userGroupId, long[] userIds)
392 throws com.liferay.portal.SystemException,
393 com.liferay.portal.PortalException;
394
395 public void unsetGroupUsers(long groupId, long[] userIds)
396 throws com.liferay.portal.SystemException,
397 com.liferay.portal.PortalException;
398
399 public void unsetOrganizationUsers(long organizationId, long[] userIds)
400 throws com.liferay.portal.SystemException,
401 com.liferay.portal.PortalException;
402
403 public void unsetPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
404 throws com.liferay.portal.SystemException,
405 com.liferay.portal.PortalException;
406
407 public void unsetRoleUsers(long roleId, long[] userIds)
408 throws com.liferay.portal.SystemException,
409 com.liferay.portal.PortalException;
410
411 public void unsetUserGroupUsers(long userGroupId, long[] userIds)
412 throws com.liferay.portal.SystemException,
413 com.liferay.portal.PortalException;
414
415 public com.liferay.portal.model.User updateActive(long userId,
416 boolean active)
417 throws com.liferay.portal.SystemException,
418 com.liferay.portal.PortalException;
419
420 public com.liferay.portal.model.User updateAgreedToTermsOfUse(long userId,
421 boolean agreedToTermsOfUse)
422 throws com.liferay.portal.SystemException,
423 com.liferay.portal.PortalException;
424
425 public com.liferay.portal.model.User updateCreateDate(long userId,
426 java.util.Date createDate)
427 throws com.liferay.portal.SystemException,
428 com.liferay.portal.PortalException;
429
430 public com.liferay.portal.model.User updateLastLogin(long userId,
431 java.lang.String loginIP)
432 throws com.liferay.portal.SystemException,
433 com.liferay.portal.PortalException;
434
435 public com.liferay.portal.model.User updateLockout(
436 com.liferay.portal.model.User user, boolean lockout)
437 throws com.liferay.portal.SystemException,
438 com.liferay.portal.PortalException;
439
440 public com.liferay.portal.model.User updateLockoutByEmailAddress(
441 long companyId, java.lang.String emailAddress, boolean lockout)
442 throws com.liferay.portal.SystemException,
443 com.liferay.portal.PortalException;
444
445 public com.liferay.portal.model.User updateLockoutById(long userId,
446 boolean lockout)
447 throws com.liferay.portal.SystemException,
448 com.liferay.portal.PortalException;
449
450 public com.liferay.portal.model.User updateLockoutByScreenName(
451 long companyId, java.lang.String screenName, boolean lockout)
452 throws com.liferay.portal.SystemException,
453 com.liferay.portal.PortalException;
454
455 public com.liferay.portal.model.User updateModifiedDate(long userId,
456 java.util.Date modifiedDate)
457 throws com.liferay.portal.SystemException,
458 com.liferay.portal.PortalException;
459
460 public void updateOrganizations(long userId, long[] newOrganizationIds)
461 throws com.liferay.portal.SystemException,
462 com.liferay.portal.PortalException;
463
464 public com.liferay.portal.model.User updatePassword(long userId,
465 java.lang.String password1, java.lang.String password2,
466 boolean passwordReset)
467 throws com.liferay.portal.SystemException,
468 com.liferay.portal.PortalException;
469
470 public com.liferay.portal.model.User updatePassword(long userId,
471 java.lang.String password1, java.lang.String password2,
472 boolean passwordReset, boolean silentUpdate)
473 throws com.liferay.portal.SystemException,
474 com.liferay.portal.PortalException;
475
476 public com.liferay.portal.model.User updatePasswordManually(long userId,
477 java.lang.String password, boolean passwordEncrypted,
478 boolean passwordReset, java.util.Date passwordModifiedDate)
479 throws com.liferay.portal.SystemException,
480 com.liferay.portal.PortalException;
481
482 public void updatePasswordReset(long userId, boolean passwordReset)
483 throws com.liferay.portal.SystemException,
484 com.liferay.portal.PortalException;
485
486 public void updatePortrait(long userId, byte[] bytes)
487 throws com.liferay.portal.SystemException,
488 com.liferay.portal.PortalException;
489
490 public void updateScreenName(long userId, java.lang.String screenName)
491 throws com.liferay.portal.SystemException,
492 com.liferay.portal.PortalException;
493
494 public com.liferay.portal.model.User updateUser(long userId,
495 java.lang.String oldPassword, boolean passwordReset,
496 java.lang.String screenName, java.lang.String emailAddress,
497 java.lang.String languageId, java.lang.String timeZoneId,
498 java.lang.String greeting, java.lang.String comments,
499 java.lang.String firstName, java.lang.String middleName,
500 java.lang.String lastName, int prefixId, int suffixId, boolean male,
501 int birthdayMonth, int birthdayDay, int birthdayYear,
502 java.lang.String smsSn, java.lang.String aimSn, java.lang.String icqSn,
503 java.lang.String jabberSn, java.lang.String msnSn,
504 java.lang.String skypeSn, java.lang.String ymSn,
505 java.lang.String jobTitle, long[] organizationIds)
506 throws com.liferay.portal.SystemException,
507 com.liferay.portal.PortalException;
508
509 public com.liferay.portal.model.User updateUser(long userId,
510 java.lang.String oldPassword, java.lang.String newPassword1,
511 java.lang.String newPassword2, boolean passwordReset,
512 java.lang.String screenName, java.lang.String emailAddress,
513 java.lang.String languageId, java.lang.String timeZoneId,
514 java.lang.String greeting, java.lang.String comments,
515 java.lang.String firstName, java.lang.String middleName,
516 java.lang.String lastName, int prefixId, int suffixId, boolean male,
517 int birthdayMonth, int birthdayDay, int birthdayYear,
518 java.lang.String smsSn, java.lang.String aimSn, java.lang.String icqSn,
519 java.lang.String jabberSn, java.lang.String msnSn,
520 java.lang.String skypeSn, java.lang.String ymSn,
521 java.lang.String jobTitle, long[] organizationIds)
522 throws com.liferay.portal.SystemException,
523 com.liferay.portal.PortalException;
524 }