001 /** 002 * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved. 003 * 004 * The contents of this file are subject to the terms of the Liferay Enterprise 005 * Subscription License ("License"). You may not use this file except in 006 * compliance with the License. You can obtain a copy of the License by 007 * contacting Liferay, Inc. See the License for the specific language governing 008 * permissions and limitations under the License, including but not limited to 009 * distribution rights of the Software. 010 * 011 * 012 * 013 */ 014 015 package com.liferay.portal.service; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 /** 020 * Provides a wrapper for {@link UserLocalService}. 021 * 022 * @author Brian Wing Shun Chan 023 * @see UserLocalService 024 * @generated 025 */ 026 @ProviderType 027 public class UserLocalServiceWrapper implements UserLocalService, 028 ServiceWrapper<UserLocalService> { 029 public UserLocalServiceWrapper(UserLocalService userLocalService) { 030 _userLocalService = userLocalService; 031 } 032 033 /** 034 * Adds the user to the database. Also notifies the appropriate model listeners. 035 * 036 * @param user the user 037 * @return the user that was added 038 * @throws SystemException if a system exception occurred 039 */ 040 @Override 041 public com.liferay.portal.model.User addUser( 042 com.liferay.portal.model.User user) 043 throws com.liferay.portal.kernel.exception.SystemException { 044 return _userLocalService.addUser(user); 045 } 046 047 /** 048 * Creates a new user with the primary key. Does not add the user to the database. 049 * 050 * @param userId the primary key for the new user 051 * @return the new user 052 */ 053 @Override 054 public com.liferay.portal.model.User createUser(long userId) { 055 return _userLocalService.createUser(userId); 056 } 057 058 /** 059 * Deletes the user with the primary key from the database. Also notifies the appropriate model listeners. 060 * 061 * @param userId the primary key of the user 062 * @return the user that was removed 063 * @throws PortalException if a user with the primary key could not be found 064 * @throws SystemException if a system exception occurred 065 */ 066 @Override 067 public com.liferay.portal.model.User deleteUser(long userId) 068 throws com.liferay.portal.kernel.exception.PortalException, 069 com.liferay.portal.kernel.exception.SystemException { 070 return _userLocalService.deleteUser(userId); 071 } 072 073 /** 074 * Deletes the user from the database. Also notifies the appropriate model listeners. 075 * 076 * @param user the user 077 * @return the user that was removed 078 * @throws PortalException 079 * @throws SystemException if a system exception occurred 080 */ 081 @Override 082 public com.liferay.portal.model.User deleteUser( 083 com.liferay.portal.model.User user) 084 throws com.liferay.portal.kernel.exception.PortalException, 085 com.liferay.portal.kernel.exception.SystemException { 086 return _userLocalService.deleteUser(user); 087 } 088 089 @Override 090 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() { 091 return _userLocalService.dynamicQuery(); 092 } 093 094 /** 095 * Performs a dynamic query on the database and returns the matching rows. 096 * 097 * @param dynamicQuery the dynamic query 098 * @return the matching rows 099 * @throws SystemException if a system exception occurred 100 */ 101 @Override 102 @SuppressWarnings("rawtypes") 103 public java.util.List dynamicQuery( 104 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 105 throws com.liferay.portal.kernel.exception.SystemException { 106 return _userLocalService.dynamicQuery(dynamicQuery); 107 } 108 109 /** 110 * Performs a dynamic query on the database and returns a range of the matching rows. 111 * 112 * <p> 113 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.UserModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 114 * </p> 115 * 116 * @param dynamicQuery the dynamic query 117 * @param start the lower bound of the range of model instances 118 * @param end the upper bound of the range of model instances (not inclusive) 119 * @return the range of matching rows 120 * @throws SystemException if a system exception occurred 121 */ 122 @Override 123 @SuppressWarnings("rawtypes") 124 public java.util.List dynamicQuery( 125 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 126 int end) throws com.liferay.portal.kernel.exception.SystemException { 127 return _userLocalService.dynamicQuery(dynamicQuery, start, end); 128 } 129 130 /** 131 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 132 * 133 * <p> 134 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.UserModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 135 * </p> 136 * 137 * @param dynamicQuery the dynamic query 138 * @param start the lower bound of the range of model instances 139 * @param end the upper bound of the range of model instances (not inclusive) 140 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 141 * @return the ordered range of matching rows 142 * @throws SystemException if a system exception occurred 143 */ 144 @Override 145 @SuppressWarnings("rawtypes") 146 public java.util.List dynamicQuery( 147 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 148 int end, 149 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 150 throws com.liferay.portal.kernel.exception.SystemException { 151 return _userLocalService.dynamicQuery(dynamicQuery, start, end, 152 orderByComparator); 153 } 154 155 /** 156 * Returns the number of rows that match the dynamic query. 157 * 158 * @param dynamicQuery the dynamic query 159 * @return the number of rows that match the dynamic query 160 * @throws SystemException if a system exception occurred 161 */ 162 @Override 163 public long dynamicQueryCount( 164 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 165 throws com.liferay.portal.kernel.exception.SystemException { 166 return _userLocalService.dynamicQueryCount(dynamicQuery); 167 } 168 169 /** 170 * Returns the number of rows that match the dynamic query. 171 * 172 * @param dynamicQuery the dynamic query 173 * @param projection the projection to apply to the query 174 * @return the number of rows that match the dynamic query 175 * @throws SystemException if a system exception occurred 176 */ 177 @Override 178 public long dynamicQueryCount( 179 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 180 com.liferay.portal.kernel.dao.orm.Projection projection) 181 throws com.liferay.portal.kernel.exception.SystemException { 182 return _userLocalService.dynamicQueryCount(dynamicQuery, projection); 183 } 184 185 @Override 186 public com.liferay.portal.model.User fetchUser(long userId) 187 throws com.liferay.portal.kernel.exception.SystemException { 188 return _userLocalService.fetchUser(userId); 189 } 190 191 /** 192 * Returns the user with the matching UUID and company. 193 * 194 * @param uuid the user's UUID 195 * @param companyId the primary key of the company 196 * @return the matching user, or <code>null</code> if a matching user could not be found 197 * @throws SystemException if a system exception occurred 198 */ 199 @Override 200 public com.liferay.portal.model.User fetchUserByUuidAndCompanyId( 201 java.lang.String uuid, long companyId) 202 throws com.liferay.portal.kernel.exception.SystemException { 203 return _userLocalService.fetchUserByUuidAndCompanyId(uuid, companyId); 204 } 205 206 /** 207 * Returns the user with the primary key. 208 * 209 * @param userId the primary key of the user 210 * @return the user 211 * @throws PortalException if a user with the primary key could not be found 212 * @throws SystemException if a system exception occurred 213 */ 214 @Override 215 public com.liferay.portal.model.User getUser(long userId) 216 throws com.liferay.portal.kernel.exception.PortalException, 217 com.liferay.portal.kernel.exception.SystemException { 218 return _userLocalService.getUser(userId); 219 } 220 221 @Override 222 public com.liferay.portal.model.PersistedModel getPersistedModel( 223 java.io.Serializable primaryKeyObj) 224 throws com.liferay.portal.kernel.exception.PortalException, 225 com.liferay.portal.kernel.exception.SystemException { 226 return _userLocalService.getPersistedModel(primaryKeyObj); 227 } 228 229 /** 230 * Returns the user with the matching UUID and company. 231 * 232 * @param uuid the user's UUID 233 * @param companyId the primary key of the company 234 * @return the matching user 235 * @throws PortalException if a matching user could not be found 236 * @throws SystemException if a system exception occurred 237 */ 238 @Override 239 public com.liferay.portal.model.User getUserByUuidAndCompanyId( 240 java.lang.String uuid, long companyId) 241 throws com.liferay.portal.kernel.exception.PortalException, 242 com.liferay.portal.kernel.exception.SystemException { 243 return _userLocalService.getUserByUuidAndCompanyId(uuid, companyId); 244 } 245 246 /** 247 * Returns a range of all the users. 248 * 249 * <p> 250 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.UserModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 251 * </p> 252 * 253 * @param start the lower bound of the range of users 254 * @param end the upper bound of the range of users (not inclusive) 255 * @return the range of users 256 * @throws SystemException if a system exception occurred 257 */ 258 @Override 259 public java.util.List<com.liferay.portal.model.User> getUsers(int start, 260 int end) throws com.liferay.portal.kernel.exception.SystemException { 261 return _userLocalService.getUsers(start, end); 262 } 263 264 /** 265 * Returns the number of users. 266 * 267 * @return the number of users 268 * @throws SystemException if a system exception occurred 269 */ 270 @Override 271 public int getUsersCount() 272 throws com.liferay.portal.kernel.exception.SystemException { 273 return _userLocalService.getUsersCount(); 274 } 275 276 /** 277 * Updates the user in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 278 * 279 * @param user the user 280 * @return the user that was updated 281 * @throws SystemException if a system exception occurred 282 */ 283 @Override 284 public com.liferay.portal.model.User updateUser( 285 com.liferay.portal.model.User user) 286 throws com.liferay.portal.kernel.exception.SystemException { 287 return _userLocalService.updateUser(user); 288 } 289 290 /** 291 * @throws SystemException if a system exception occurred 292 */ 293 @Override 294 public void addGroupUser(long groupId, long userId) 295 throws com.liferay.portal.kernel.exception.SystemException { 296 _userLocalService.addGroupUser(groupId, userId); 297 } 298 299 /** 300 * @throws SystemException if a system exception occurred 301 */ 302 @Override 303 public void addGroupUser(long groupId, com.liferay.portal.model.User user) 304 throws com.liferay.portal.kernel.exception.SystemException { 305 _userLocalService.addGroupUser(groupId, user); 306 } 307 308 /** 309 * @throws PortalException 310 * @throws SystemException if a system exception occurred 311 */ 312 @Override 313 public void addGroupUsers(long groupId, long[] userIds) 314 throws com.liferay.portal.kernel.exception.PortalException, 315 com.liferay.portal.kernel.exception.SystemException { 316 _userLocalService.addGroupUsers(groupId, userIds); 317 } 318 319 /** 320 * @throws PortalException 321 * @throws SystemException if a system exception occurred 322 */ 323 @Override 324 public void addGroupUsers(long groupId, 325 java.util.List<com.liferay.portal.model.User> Users) 326 throws com.liferay.portal.kernel.exception.PortalException, 327 com.liferay.portal.kernel.exception.SystemException { 328 _userLocalService.addGroupUsers(groupId, Users); 329 } 330 331 /** 332 * @throws SystemException if a system exception occurred 333 */ 334 @Override 335 public void clearGroupUsers(long groupId) 336 throws com.liferay.portal.kernel.exception.SystemException { 337 _userLocalService.clearGroupUsers(groupId); 338 } 339 340 /** 341 * @throws SystemException if a system exception occurred 342 */ 343 @Override 344 public void deleteGroupUser(long groupId, long userId) 345 throws com.liferay.portal.kernel.exception.SystemException { 346 _userLocalService.deleteGroupUser(groupId, userId); 347 } 348 349 /** 350 * @throws SystemException if a system exception occurred 351 */ 352 @Override 353 public void deleteGroupUser(long groupId, com.liferay.portal.model.User user) 354 throws com.liferay.portal.kernel.exception.SystemException { 355 _userLocalService.deleteGroupUser(groupId, user); 356 } 357 358 /** 359 * @throws SystemException if a system exception occurred 360 */ 361 @Override 362 public void deleteGroupUsers(long groupId, long[] userIds) 363 throws com.liferay.portal.kernel.exception.SystemException { 364 _userLocalService.deleteGroupUsers(groupId, userIds); 365 } 366 367 /** 368 * @throws SystemException if a system exception occurred 369 */ 370 @Override 371 public void deleteGroupUsers(long groupId, 372 java.util.List<com.liferay.portal.model.User> Users) 373 throws com.liferay.portal.kernel.exception.SystemException { 374 _userLocalService.deleteGroupUsers(groupId, Users); 375 } 376 377 /** 378 * @throws SystemException if a system exception occurred 379 */ 380 @Override 381 public java.util.List<com.liferay.portal.model.User> getGroupUsers( 382 long groupId) 383 throws com.liferay.portal.kernel.exception.SystemException { 384 return _userLocalService.getGroupUsers(groupId); 385 } 386 387 /** 388 * @throws SystemException if a system exception occurred 389 */ 390 @Override 391 public java.util.List<com.liferay.portal.model.User> getGroupUsers( 392 long groupId, int start, int end) 393 throws com.liferay.portal.kernel.exception.SystemException { 394 return _userLocalService.getGroupUsers(groupId, start, end); 395 } 396 397 /** 398 * @throws SystemException if a system exception occurred 399 */ 400 @Override 401 public java.util.List<com.liferay.portal.model.User> getGroupUsers( 402 long groupId, int start, int end, 403 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 404 throws com.liferay.portal.kernel.exception.SystemException { 405 return _userLocalService.getGroupUsers(groupId, start, end, 406 orderByComparator); 407 } 408 409 /** 410 * @throws SystemException if a system exception occurred 411 */ 412 @Override 413 public int getGroupUsersCount(long groupId) 414 throws com.liferay.portal.kernel.exception.SystemException { 415 return _userLocalService.getGroupUsersCount(groupId); 416 } 417 418 /** 419 * @throws SystemException if a system exception occurred 420 */ 421 @Override 422 public boolean hasGroupUser(long groupId, long userId) 423 throws com.liferay.portal.kernel.exception.SystemException { 424 return _userLocalService.hasGroupUser(groupId, userId); 425 } 426 427 /** 428 * @throws SystemException if a system exception occurred 429 */ 430 @Override 431 public boolean hasGroupUsers(long groupId) 432 throws com.liferay.portal.kernel.exception.SystemException { 433 return _userLocalService.hasGroupUsers(groupId); 434 } 435 436 /** 437 * @throws SystemException if a system exception occurred 438 */ 439 @Override 440 public void setGroupUsers(long groupId, long[] userIds) 441 throws com.liferay.portal.kernel.exception.SystemException { 442 _userLocalService.setGroupUsers(groupId, userIds); 443 } 444 445 /** 446 * @throws SystemException if a system exception occurred 447 */ 448 @Override 449 public void addOrganizationUser(long organizationId, long userId) 450 throws com.liferay.portal.kernel.exception.SystemException { 451 _userLocalService.addOrganizationUser(organizationId, userId); 452 } 453 454 /** 455 * @throws SystemException if a system exception occurred 456 */ 457 @Override 458 public void addOrganizationUser(long organizationId, 459 com.liferay.portal.model.User user) 460 throws com.liferay.portal.kernel.exception.SystemException { 461 _userLocalService.addOrganizationUser(organizationId, user); 462 } 463 464 /** 465 * @throws PortalException 466 * @throws SystemException if a system exception occurred 467 */ 468 @Override 469 public void addOrganizationUsers(long organizationId, long[] userIds) 470 throws com.liferay.portal.kernel.exception.PortalException, 471 com.liferay.portal.kernel.exception.SystemException { 472 _userLocalService.addOrganizationUsers(organizationId, userIds); 473 } 474 475 /** 476 * @throws PortalException 477 * @throws SystemException if a system exception occurred 478 */ 479 @Override 480 public void addOrganizationUsers(long organizationId, 481 java.util.List<com.liferay.portal.model.User> Users) 482 throws com.liferay.portal.kernel.exception.PortalException, 483 com.liferay.portal.kernel.exception.SystemException { 484 _userLocalService.addOrganizationUsers(organizationId, Users); 485 } 486 487 /** 488 * @throws SystemException if a system exception occurred 489 */ 490 @Override 491 public void clearOrganizationUsers(long organizationId) 492 throws com.liferay.portal.kernel.exception.SystemException { 493 _userLocalService.clearOrganizationUsers(organizationId); 494 } 495 496 /** 497 * @throws SystemException if a system exception occurred 498 */ 499 @Override 500 public void deleteOrganizationUser(long organizationId, long userId) 501 throws com.liferay.portal.kernel.exception.SystemException { 502 _userLocalService.deleteOrganizationUser(organizationId, userId); 503 } 504 505 /** 506 * @throws SystemException if a system exception occurred 507 */ 508 @Override 509 public void deleteOrganizationUser(long organizationId, 510 com.liferay.portal.model.User user) 511 throws com.liferay.portal.kernel.exception.SystemException { 512 _userLocalService.deleteOrganizationUser(organizationId, user); 513 } 514 515 /** 516 * @throws SystemException if a system exception occurred 517 */ 518 @Override 519 public void deleteOrganizationUsers(long organizationId, long[] userIds) 520 throws com.liferay.portal.kernel.exception.SystemException { 521 _userLocalService.deleteOrganizationUsers(organizationId, userIds); 522 } 523 524 /** 525 * @throws SystemException if a system exception occurred 526 */ 527 @Override 528 public void deleteOrganizationUsers(long organizationId, 529 java.util.List<com.liferay.portal.model.User> Users) 530 throws com.liferay.portal.kernel.exception.SystemException { 531 _userLocalService.deleteOrganizationUsers(organizationId, Users); 532 } 533 534 /** 535 * @throws SystemException if a system exception occurred 536 */ 537 @Override 538 public java.util.List<com.liferay.portal.model.User> getOrganizationUsers( 539 long organizationId) 540 throws com.liferay.portal.kernel.exception.SystemException { 541 return _userLocalService.getOrganizationUsers(organizationId); 542 } 543 544 /** 545 * @throws SystemException if a system exception occurred 546 */ 547 @Override 548 public java.util.List<com.liferay.portal.model.User> getOrganizationUsers( 549 long organizationId, int start, int end) 550 throws com.liferay.portal.kernel.exception.SystemException { 551 return _userLocalService.getOrganizationUsers(organizationId, start, end); 552 } 553 554 /** 555 * @throws SystemException if a system exception occurred 556 */ 557 @Override 558 public java.util.List<com.liferay.portal.model.User> getOrganizationUsers( 559 long organizationId, int start, int end, 560 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 561 throws com.liferay.portal.kernel.exception.SystemException { 562 return _userLocalService.getOrganizationUsers(organizationId, start, 563 end, orderByComparator); 564 } 565 566 /** 567 * @throws SystemException if a system exception occurred 568 */ 569 @Override 570 public int getOrganizationUsersCount(long organizationId) 571 throws com.liferay.portal.kernel.exception.SystemException { 572 return _userLocalService.getOrganizationUsersCount(organizationId); 573 } 574 575 /** 576 * @throws SystemException if a system exception occurred 577 */ 578 @Override 579 public boolean hasOrganizationUser(long organizationId, long userId) 580 throws com.liferay.portal.kernel.exception.SystemException { 581 return _userLocalService.hasOrganizationUser(organizationId, userId); 582 } 583 584 /** 585 * @throws SystemException if a system exception occurred 586 */ 587 @Override 588 public boolean hasOrganizationUsers(long organizationId) 589 throws com.liferay.portal.kernel.exception.SystemException { 590 return _userLocalService.hasOrganizationUsers(organizationId); 591 } 592 593 /** 594 * @throws SystemException if a system exception occurred 595 */ 596 @Override 597 public void setOrganizationUsers(long organizationId, long[] userIds) 598 throws com.liferay.portal.kernel.exception.SystemException { 599 _userLocalService.setOrganizationUsers(organizationId, userIds); 600 } 601 602 /** 603 * @throws SystemException if a system exception occurred 604 */ 605 @Override 606 public void addRoleUser(long roleId, long userId) 607 throws com.liferay.portal.kernel.exception.SystemException { 608 _userLocalService.addRoleUser(roleId, userId); 609 } 610 611 /** 612 * @throws SystemException if a system exception occurred 613 */ 614 @Override 615 public void addRoleUser(long roleId, com.liferay.portal.model.User user) 616 throws com.liferay.portal.kernel.exception.SystemException { 617 _userLocalService.addRoleUser(roleId, user); 618 } 619 620 /** 621 * @throws PortalException 622 * @throws SystemException if a system exception occurred 623 */ 624 @Override 625 public void addRoleUsers(long roleId, long[] userIds) 626 throws com.liferay.portal.kernel.exception.PortalException, 627 com.liferay.portal.kernel.exception.SystemException { 628 _userLocalService.addRoleUsers(roleId, userIds); 629 } 630 631 /** 632 * @throws PortalException 633 * @throws SystemException if a system exception occurred 634 */ 635 @Override 636 public void addRoleUsers(long roleId, 637 java.util.List<com.liferay.portal.model.User> Users) 638 throws com.liferay.portal.kernel.exception.PortalException, 639 com.liferay.portal.kernel.exception.SystemException { 640 _userLocalService.addRoleUsers(roleId, Users); 641 } 642 643 /** 644 * @throws SystemException if a system exception occurred 645 */ 646 @Override 647 public void clearRoleUsers(long roleId) 648 throws com.liferay.portal.kernel.exception.SystemException { 649 _userLocalService.clearRoleUsers(roleId); 650 } 651 652 /** 653 * @throws PortalException 654 * @throws SystemException if a system exception occurred 655 */ 656 @Override 657 public void deleteRoleUser(long roleId, long userId) 658 throws com.liferay.portal.kernel.exception.PortalException, 659 com.liferay.portal.kernel.exception.SystemException { 660 _userLocalService.deleteRoleUser(roleId, userId); 661 } 662 663 /** 664 * @throws PortalException 665 * @throws SystemException if a system exception occurred 666 */ 667 @Override 668 public void deleteRoleUser(long roleId, com.liferay.portal.model.User user) 669 throws com.liferay.portal.kernel.exception.PortalException, 670 com.liferay.portal.kernel.exception.SystemException { 671 _userLocalService.deleteRoleUser(roleId, user); 672 } 673 674 /** 675 * @throws SystemException if a system exception occurred 676 */ 677 @Override 678 public void deleteRoleUsers(long roleId, long[] userIds) 679 throws com.liferay.portal.kernel.exception.SystemException { 680 _userLocalService.deleteRoleUsers(roleId, userIds); 681 } 682 683 /** 684 * @throws SystemException if a system exception occurred 685 */ 686 @Override 687 public void deleteRoleUsers(long roleId, 688 java.util.List<com.liferay.portal.model.User> Users) 689 throws com.liferay.portal.kernel.exception.SystemException { 690 _userLocalService.deleteRoleUsers(roleId, Users); 691 } 692 693 /** 694 * @throws SystemException if a system exception occurred 695 */ 696 @Override 697 public java.util.List<com.liferay.portal.model.User> getRoleUsers( 698 long roleId) throws com.liferay.portal.kernel.exception.SystemException { 699 return _userLocalService.getRoleUsers(roleId); 700 } 701 702 /** 703 * @throws SystemException if a system exception occurred 704 */ 705 @Override 706 public java.util.List<com.liferay.portal.model.User> getRoleUsers( 707 long roleId, int start, int end) 708 throws com.liferay.portal.kernel.exception.SystemException { 709 return _userLocalService.getRoleUsers(roleId, start, end); 710 } 711 712 /** 713 * @throws SystemException if a system exception occurred 714 */ 715 @Override 716 public java.util.List<com.liferay.portal.model.User> getRoleUsers( 717 long roleId, int start, int end, 718 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 719 throws com.liferay.portal.kernel.exception.SystemException { 720 return _userLocalService.getRoleUsers(roleId, start, end, 721 orderByComparator); 722 } 723 724 /** 725 * @throws SystemException if a system exception occurred 726 */ 727 @Override 728 public int getRoleUsersCount(long roleId) 729 throws com.liferay.portal.kernel.exception.SystemException { 730 return _userLocalService.getRoleUsersCount(roleId); 731 } 732 733 /** 734 * @throws SystemException if a system exception occurred 735 */ 736 @Override 737 public boolean hasRoleUser(long roleId, long userId) 738 throws com.liferay.portal.kernel.exception.SystemException { 739 return _userLocalService.hasRoleUser(roleId, userId); 740 } 741 742 /** 743 * @throws SystemException if a system exception occurred 744 */ 745 @Override 746 public boolean hasRoleUsers(long roleId) 747 throws com.liferay.portal.kernel.exception.SystemException { 748 return _userLocalService.hasRoleUsers(roleId); 749 } 750 751 /** 752 * @throws PortalException 753 * @throws SystemException if a system exception occurred 754 */ 755 @Override 756 public void setRoleUsers(long roleId, long[] userIds) 757 throws com.liferay.portal.kernel.exception.PortalException, 758 com.liferay.portal.kernel.exception.SystemException { 759 _userLocalService.setRoleUsers(roleId, userIds); 760 } 761 762 /** 763 * @throws SystemException if a system exception occurred 764 */ 765 @Override 766 public void addTeamUser(long teamId, long userId) 767 throws com.liferay.portal.kernel.exception.SystemException { 768 _userLocalService.addTeamUser(teamId, userId); 769 } 770 771 /** 772 * @throws SystemException if a system exception occurred 773 */ 774 @Override 775 public void addTeamUser(long teamId, com.liferay.portal.model.User user) 776 throws com.liferay.portal.kernel.exception.SystemException { 777 _userLocalService.addTeamUser(teamId, user); 778 } 779 780 /** 781 * @throws PortalException 782 * @throws SystemException if a system exception occurred 783 */ 784 @Override 785 public void addTeamUsers(long teamId, long[] userIds) 786 throws com.liferay.portal.kernel.exception.PortalException, 787 com.liferay.portal.kernel.exception.SystemException { 788 _userLocalService.addTeamUsers(teamId, userIds); 789 } 790 791 /** 792 * @throws PortalException 793 * @throws SystemException if a system exception occurred 794 */ 795 @Override 796 public void addTeamUsers(long teamId, 797 java.util.List<com.liferay.portal.model.User> Users) 798 throws com.liferay.portal.kernel.exception.PortalException, 799 com.liferay.portal.kernel.exception.SystemException { 800 _userLocalService.addTeamUsers(teamId, Users); 801 } 802 803 /** 804 * @throws SystemException if a system exception occurred 805 */ 806 @Override 807 public void clearTeamUsers(long teamId) 808 throws com.liferay.portal.kernel.exception.SystemException { 809 _userLocalService.clearTeamUsers(teamId); 810 } 811 812 /** 813 * @throws SystemException if a system exception occurred 814 */ 815 @Override 816 public void deleteTeamUser(long teamId, long userId) 817 throws com.liferay.portal.kernel.exception.SystemException { 818 _userLocalService.deleteTeamUser(teamId, userId); 819 } 820 821 /** 822 * @throws SystemException if a system exception occurred 823 */ 824 @Override 825 public void deleteTeamUser(long teamId, com.liferay.portal.model.User user) 826 throws com.liferay.portal.kernel.exception.SystemException { 827 _userLocalService.deleteTeamUser(teamId, user); 828 } 829 830 /** 831 * @throws SystemException if a system exception occurred 832 */ 833 @Override 834 public void deleteTeamUsers(long teamId, long[] userIds) 835 throws com.liferay.portal.kernel.exception.SystemException { 836 _userLocalService.deleteTeamUsers(teamId, userIds); 837 } 838 839 /** 840 * @throws SystemException if a system exception occurred 841 */ 842 @Override 843 public void deleteTeamUsers(long teamId, 844 java.util.List<com.liferay.portal.model.User> Users) 845 throws com.liferay.portal.kernel.exception.SystemException { 846 _userLocalService.deleteTeamUsers(teamId, Users); 847 } 848 849 /** 850 * @throws SystemException if a system exception occurred 851 */ 852 @Override 853 public java.util.List<com.liferay.portal.model.User> getTeamUsers( 854 long teamId) throws com.liferay.portal.kernel.exception.SystemException { 855 return _userLocalService.getTeamUsers(teamId); 856 } 857 858 /** 859 * @throws SystemException if a system exception occurred 860 */ 861 @Override 862 public java.util.List<com.liferay.portal.model.User> getTeamUsers( 863 long teamId, int start, int end) 864 throws com.liferay.portal.kernel.exception.SystemException { 865 return _userLocalService.getTeamUsers(teamId, start, end); 866 } 867 868 /** 869 * @throws SystemException if a system exception occurred 870 */ 871 @Override 872 public java.util.List<com.liferay.portal.model.User> getTeamUsers( 873 long teamId, int start, int end, 874 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 875 throws com.liferay.portal.kernel.exception.SystemException { 876 return _userLocalService.getTeamUsers(teamId, start, end, 877 orderByComparator); 878 } 879 880 /** 881 * @throws SystemException if a system exception occurred 882 */ 883 @Override 884 public int getTeamUsersCount(long teamId) 885 throws com.liferay.portal.kernel.exception.SystemException { 886 return _userLocalService.getTeamUsersCount(teamId); 887 } 888 889 /** 890 * @throws SystemException if a system exception occurred 891 */ 892 @Override 893 public boolean hasTeamUser(long teamId, long userId) 894 throws com.liferay.portal.kernel.exception.SystemException { 895 return _userLocalService.hasTeamUser(teamId, userId); 896 } 897 898 /** 899 * @throws SystemException if a system exception occurred 900 */ 901 @Override 902 public boolean hasTeamUsers(long teamId) 903 throws com.liferay.portal.kernel.exception.SystemException { 904 return _userLocalService.hasTeamUsers(teamId); 905 } 906 907 /** 908 * @throws SystemException if a system exception occurred 909 */ 910 @Override 911 public void setTeamUsers(long teamId, long[] userIds) 912 throws com.liferay.portal.kernel.exception.SystemException { 913 _userLocalService.setTeamUsers(teamId, userIds); 914 } 915 916 /** 917 * @throws SystemException if a system exception occurred 918 */ 919 @Override 920 public void addUserGroupUser(long userGroupId, long userId) 921 throws com.liferay.portal.kernel.exception.SystemException { 922 _userLocalService.addUserGroupUser(userGroupId, userId); 923 } 924 925 /** 926 * @throws SystemException if a system exception occurred 927 */ 928 @Override 929 public void addUserGroupUser(long userGroupId, 930 com.liferay.portal.model.User user) 931 throws com.liferay.portal.kernel.exception.SystemException { 932 _userLocalService.addUserGroupUser(userGroupId, user); 933 } 934 935 /** 936 * @throws PortalException 937 * @throws SystemException if a system exception occurred 938 */ 939 @Override 940 public void addUserGroupUsers(long userGroupId, long[] userIds) 941 throws com.liferay.portal.kernel.exception.PortalException, 942 com.liferay.portal.kernel.exception.SystemException { 943 _userLocalService.addUserGroupUsers(userGroupId, userIds); 944 } 945 946 /** 947 * @throws PortalException 948 * @throws SystemException if a system exception occurred 949 */ 950 @Override 951 public void addUserGroupUsers(long userGroupId, 952 java.util.List<com.liferay.portal.model.User> Users) 953 throws com.liferay.portal.kernel.exception.PortalException, 954 com.liferay.portal.kernel.exception.SystemException { 955 _userLocalService.addUserGroupUsers(userGroupId, Users); 956 } 957 958 /** 959 * @throws SystemException if a system exception occurred 960 */ 961 @Override 962 public void clearUserGroupUsers(long userGroupId) 963 throws com.liferay.portal.kernel.exception.SystemException { 964 _userLocalService.clearUserGroupUsers(userGroupId); 965 } 966 967 /** 968 * @throws PortalException 969 * @throws SystemException if a system exception occurred 970 */ 971 @Override 972 public void deleteUserGroupUser(long userGroupId, long userId) 973 throws com.liferay.portal.kernel.exception.PortalException, 974 com.liferay.portal.kernel.exception.SystemException { 975 _userLocalService.deleteUserGroupUser(userGroupId, userId); 976 } 977 978 /** 979 * @throws PortalException 980 * @throws SystemException if a system exception occurred 981 */ 982 @Override 983 public void deleteUserGroupUser(long userGroupId, 984 com.liferay.portal.model.User user) 985 throws com.liferay.portal.kernel.exception.PortalException, 986 com.liferay.portal.kernel.exception.SystemException { 987 _userLocalService.deleteUserGroupUser(userGroupId, user); 988 } 989 990 /** 991 * @throws SystemException if a system exception occurred 992 */ 993 @Override 994 public void deleteUserGroupUsers(long userGroupId, long[] userIds) 995 throws com.liferay.portal.kernel.exception.SystemException { 996 _userLocalService.deleteUserGroupUsers(userGroupId, userIds); 997 } 998 999 /** 1000 * @throws SystemException if a system exception occurred 1001 */ 1002 @Override 1003 public void deleteUserGroupUsers(long userGroupId, 1004 java.util.List<com.liferay.portal.model.User> Users) 1005 throws com.liferay.portal.kernel.exception.SystemException { 1006 _userLocalService.deleteUserGroupUsers(userGroupId, Users); 1007 } 1008 1009 /** 1010 * @throws SystemException if a system exception occurred 1011 */ 1012 @Override 1013 public java.util.List<com.liferay.portal.model.User> getUserGroupUsers( 1014 long userGroupId) 1015 throws com.liferay.portal.kernel.exception.SystemException { 1016 return _userLocalService.getUserGroupUsers(userGroupId); 1017 } 1018 1019 /** 1020 * @throws SystemException if a system exception occurred 1021 */ 1022 @Override 1023 public java.util.List<com.liferay.portal.model.User> getUserGroupUsers( 1024 long userGroupId, int start, int end) 1025 throws com.liferay.portal.kernel.exception.SystemException { 1026 return _userLocalService.getUserGroupUsers(userGroupId, start, end); 1027 } 1028 1029 /** 1030 * @throws SystemException if a system exception occurred 1031 */ 1032 @Override 1033 public java.util.List<com.liferay.portal.model.User> getUserGroupUsers( 1034 long userGroupId, int start, int end, 1035 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 1036 throws com.liferay.portal.kernel.exception.SystemException { 1037 return _userLocalService.getUserGroupUsers(userGroupId, start, end, 1038 orderByComparator); 1039 } 1040 1041 /** 1042 * @throws SystemException if a system exception occurred 1043 */ 1044 @Override 1045 public int getUserGroupUsersCount(long userGroupId) 1046 throws com.liferay.portal.kernel.exception.SystemException { 1047 return _userLocalService.getUserGroupUsersCount(userGroupId); 1048 } 1049 1050 /** 1051 * @throws SystemException if a system exception occurred 1052 */ 1053 @Override 1054 public boolean hasUserGroupUser(long userGroupId, long userId) 1055 throws com.liferay.portal.kernel.exception.SystemException { 1056 return _userLocalService.hasUserGroupUser(userGroupId, userId); 1057 } 1058 1059 /** 1060 * @throws SystemException if a system exception occurred 1061 */ 1062 @Override 1063 public boolean hasUserGroupUsers(long userGroupId) 1064 throws com.liferay.portal.kernel.exception.SystemException { 1065 return _userLocalService.hasUserGroupUsers(userGroupId); 1066 } 1067 1068 /** 1069 * @throws PortalException 1070 * @throws SystemException if a system exception occurred 1071 */ 1072 @Override 1073 public void setUserGroupUsers(long userGroupId, long[] userIds) 1074 throws com.liferay.portal.kernel.exception.PortalException, 1075 com.liferay.portal.kernel.exception.SystemException { 1076 _userLocalService.setUserGroupUsers(userGroupId, userIds); 1077 } 1078 1079 /** 1080 * Returns the Spring bean ID for this bean. 1081 * 1082 * @return the Spring bean ID for this bean 1083 */ 1084 @Override 1085 public java.lang.String getBeanIdentifier() { 1086 return _userLocalService.getBeanIdentifier(); 1087 } 1088 1089 /** 1090 * Sets the Spring bean ID for this bean. 1091 * 1092 * @param beanIdentifier the Spring bean ID for this bean 1093 */ 1094 @Override 1095 public void setBeanIdentifier(java.lang.String beanIdentifier) { 1096 _userLocalService.setBeanIdentifier(beanIdentifier); 1097 } 1098 1099 /** 1100 * Adds a default admin user for the company. 1101 * 1102 * @param companyId the primary key of the user's company 1103 * @param screenName the user's screen name 1104 * @param emailAddress the user's email address 1105 * @param locale the user's locale 1106 * @param firstName the user's first name 1107 * @param middleName the user's middle name 1108 * @param lastName the user's last name 1109 * @return the new default admin user 1110 * @throws PortalException n if a portal exception occurred 1111 * @throws SystemException if a system exception occurred 1112 */ 1113 @Override 1114 public com.liferay.portal.model.User addDefaultAdminUser(long companyId, 1115 java.lang.String screenName, java.lang.String emailAddress, 1116 java.util.Locale locale, java.lang.String firstName, 1117 java.lang.String middleName, java.lang.String lastName) 1118 throws com.liferay.portal.kernel.exception.PortalException, 1119 com.liferay.portal.kernel.exception.SystemException { 1120 return _userLocalService.addDefaultAdminUser(companyId, screenName, 1121 emailAddress, locale, firstName, middleName, lastName); 1122 } 1123 1124 /** 1125 * Adds the user to the default groups, unless the user is already in these 1126 * groups. The default groups can be specified in 1127 * <code>portal.properties</code> with the key 1128 * <code>admin.default.group.names</code>. 1129 * 1130 * @param userId the primary key of the user 1131 * @throws PortalException if a user with the primary key could not be found 1132 * @throws SystemException if a system exception occurred 1133 */ 1134 @Override 1135 public void addDefaultGroups(long userId) 1136 throws com.liferay.portal.kernel.exception.PortalException, 1137 com.liferay.portal.kernel.exception.SystemException { 1138 _userLocalService.addDefaultGroups(userId); 1139 } 1140 1141 /** 1142 * Adds the user to the default roles, unless the user already has these 1143 * roles. The default roles can be specified in 1144 * <code>portal.properties</code> with the key 1145 * <code>admin.default.role.names</code>. 1146 * 1147 * @param userId the primary key of the user 1148 * @throws PortalException if a user with the primary key could not be found 1149 * @throws SystemException if a system exception occurred 1150 */ 1151 @Override 1152 public void addDefaultRoles(long userId) 1153 throws com.liferay.portal.kernel.exception.PortalException, 1154 com.liferay.portal.kernel.exception.SystemException { 1155 _userLocalService.addDefaultRoles(userId); 1156 } 1157 1158 /** 1159 * Adds the user to the default user groups, unless the user is already in 1160 * these user groups. The default user groups can be specified in 1161 * <code>portal.properties</code> with the property 1162 * <code>admin.default.user.group.names</code>. 1163 * 1164 * @param userId the primary key of the user 1165 * @throws PortalException if a user with the primary key could not be found 1166 * @throws SystemException if a system exception occurred 1167 */ 1168 @Override 1169 public void addDefaultUserGroups(long userId) 1170 throws com.liferay.portal.kernel.exception.PortalException, 1171 com.liferay.portal.kernel.exception.SystemException { 1172 _userLocalService.addDefaultUserGroups(userId); 1173 } 1174 1175 /** 1176 * Assigns the password policy to the users, removing any other currently 1177 * assigned password policies. 1178 * 1179 * @param passwordPolicyId the primary key of the password policy 1180 * @param userIds the primary keys of the users 1181 * @throws SystemException if a system exception occurred 1182 */ 1183 @Override 1184 public void addPasswordPolicyUsers(long passwordPolicyId, long[] userIds) 1185 throws com.liferay.portal.kernel.exception.SystemException { 1186 _userLocalService.addPasswordPolicyUsers(passwordPolicyId, userIds); 1187 } 1188 1189 /** 1190 * Adds a user. 1191 * 1192 * <p> 1193 * This method handles the creation and bookkeeping of the user including 1194 * its resources, metadata, and internal data structures. It is not 1195 * necessary to make subsequent calls to any methods to setup default 1196 * groups, resources, etc. 1197 * </p> 1198 * 1199 * @param creatorUserId the primary key of the creator 1200 * @param companyId the primary key of the user's company 1201 * @param autoPassword whether a password should be automatically generated 1202 for the user 1203 * @param password1 the user's password 1204 * @param password2 the user's password confirmation 1205 * @param autoScreenName whether a screen name should be automatically 1206 generated for the user 1207 * @param screenName the user's screen name 1208 * @param emailAddress the user's email address 1209 * @param facebookId the user's facebook ID 1210 * @param openId the user's OpenID 1211 * @param locale the user's locale 1212 * @param firstName the user's first name 1213 * @param middleName the user's middle name 1214 * @param lastName the user's last name 1215 * @param prefixId the user's name prefix ID 1216 * @param suffixId the user's name suffix ID 1217 * @param male whether the user is male 1218 * @param birthdayMonth the user's birthday month (0-based, meaning 0 for 1219 January) 1220 * @param birthdayDay the user's birthday day 1221 * @param birthdayYear the user's birthday year 1222 * @param jobTitle the user's job title 1223 * @param groupIds the primary keys of the user's groups 1224 * @param organizationIds the primary keys of the user's organizations 1225 * @param roleIds the primary keys of the roles this user possesses 1226 * @param userGroupIds the primary keys of the user's user groups 1227 * @param sendEmail whether to send the user an email notification about 1228 their new account 1229 * @param serviceContext the service context to be applied (optionally 1230 <code>null</code>). Can set the UUID (with the <code>uuid</code> 1231 attribute), asset category IDs, asset tag names, and expando 1232 bridge attributes for the user. 1233 * @return the new user 1234 * @throws PortalException if the user's information was invalid 1235 * @throws SystemException if a system exception occurred 1236 */ 1237 @Override 1238 public com.liferay.portal.model.User addUser(long creatorUserId, 1239 long companyId, boolean autoPassword, java.lang.String password1, 1240 java.lang.String password2, boolean autoScreenName, 1241 java.lang.String screenName, java.lang.String emailAddress, 1242 long facebookId, java.lang.String openId, java.util.Locale locale, 1243 java.lang.String firstName, java.lang.String middleName, 1244 java.lang.String lastName, int prefixId, int suffixId, boolean male, 1245 int birthdayMonth, int birthdayDay, int birthdayYear, 1246 java.lang.String jobTitle, long[] groupIds, long[] organizationIds, 1247 long[] roleIds, long[] userGroupIds, boolean sendEmail, 1248 com.liferay.portal.service.ServiceContext serviceContext) 1249 throws com.liferay.portal.kernel.exception.PortalException, 1250 com.liferay.portal.kernel.exception.SystemException { 1251 return _userLocalService.addUser(creatorUserId, companyId, 1252 autoPassword, password1, password2, autoScreenName, screenName, 1253 emailAddress, facebookId, openId, locale, firstName, middleName, 1254 lastName, prefixId, suffixId, male, birthdayMonth, birthdayDay, 1255 birthdayYear, jobTitle, groupIds, organizationIds, roleIds, 1256 userGroupIds, sendEmail, serviceContext); 1257 } 1258 1259 /** 1260 * Adds a user with workflow. 1261 * 1262 * <p> 1263 * This method handles the creation and bookkeeping of the user including 1264 * its resources, metadata, and internal data structures. It is not 1265 * necessary to make subsequent calls to any methods to setup default 1266 * groups, resources, etc. 1267 * </p> 1268 * 1269 * @param creatorUserId the primary key of the creator 1270 * @param companyId the primary key of the user's company 1271 * @param autoPassword whether a password should be automatically generated 1272 for the user 1273 * @param password1 the user's password 1274 * @param password2 the user's password confirmation 1275 * @param autoScreenName whether a screen name should be automatically 1276 generated for the user 1277 * @param screenName the user's screen name 1278 * @param emailAddress the user's email address 1279 * @param facebookId the user's facebook ID 1280 * @param openId the user's OpenID 1281 * @param locale the user's locale 1282 * @param firstName the user's first name 1283 * @param middleName the user's middle name 1284 * @param lastName the user's last name 1285 * @param prefixId the user's name prefix ID 1286 * @param suffixId the user's name suffix ID 1287 * @param male whether the user is male 1288 * @param birthdayMonth the user's birthday month (0-based, meaning 0 for 1289 January) 1290 * @param birthdayDay the user's birthday day 1291 * @param birthdayYear the user's birthday year 1292 * @param jobTitle the user's job title 1293 * @param groupIds the primary keys of the user's groups 1294 * @param organizationIds the primary keys of the user's organizations 1295 * @param roleIds the primary keys of the roles this user possesses 1296 * @param userGroupIds the primary keys of the user's user groups 1297 * @param sendEmail whether to send the user an email notification about 1298 their new account 1299 * @param serviceContext the service context to be applied (optionally 1300 <code>null</code>). Can set the UUID (with the <code>uuid</code> 1301 attribute), asset category IDs, asset tag names, and expando 1302 bridge attributes for the user. 1303 * @return the new user 1304 * @throws PortalException if the user's information was invalid 1305 * @throws SystemException if a system exception occurred 1306 */ 1307 @Override 1308 public com.liferay.portal.model.User addUserWithWorkflow( 1309 long creatorUserId, long companyId, boolean autoPassword, 1310 java.lang.String password1, java.lang.String password2, 1311 boolean autoScreenName, java.lang.String screenName, 1312 java.lang.String emailAddress, long facebookId, 1313 java.lang.String openId, java.util.Locale locale, 1314 java.lang.String firstName, java.lang.String middleName, 1315 java.lang.String lastName, int prefixId, int suffixId, boolean male, 1316 int birthdayMonth, int birthdayDay, int birthdayYear, 1317 java.lang.String jobTitle, long[] groupIds, long[] organizationIds, 1318 long[] roleIds, long[] userGroupIds, boolean sendEmail, 1319 com.liferay.portal.service.ServiceContext serviceContext) 1320 throws com.liferay.portal.kernel.exception.PortalException, 1321 com.liferay.portal.kernel.exception.SystemException { 1322 return _userLocalService.addUserWithWorkflow(creatorUserId, companyId, 1323 autoPassword, password1, password2, autoScreenName, screenName, 1324 emailAddress, facebookId, openId, locale, firstName, middleName, 1325 lastName, prefixId, suffixId, male, birthdayMonth, birthdayDay, 1326 birthdayYear, jobTitle, groupIds, organizationIds, roleIds, 1327 userGroupIds, sendEmail, serviceContext); 1328 } 1329 1330 /** 1331 * Attempts to authenticate the user by their email address and password, 1332 * while using the AuthPipeline. 1333 * 1334 * @param companyId the primary key of the user's company 1335 * @param emailAddress the user's email address 1336 * @param password the user's password 1337 * @param headerMap the header map from the authentication request 1338 * @param parameterMap the parameter map from the authentication request 1339 * @param resultsMap the map of authentication results (may be nil). After 1340 a succesful authentication the user's primary key will be placed 1341 under the key <code>userId</code>. 1342 * @return the authentication status. This can be {@link 1343 com.liferay.portal.security.auth.Authenticator#FAILURE} 1344 indicating that the user's credentials are invalid, {@link 1345 com.liferay.portal.security.auth.Authenticator#SUCCESS} 1346 indicating a successful login, or {@link 1347 com.liferay.portal.security.auth.Authenticator#DNE} indicating 1348 that a user with that login does not exist. 1349 * @throws PortalException if <code>emailAddress</code> or 1350 <code>password</code> was <code>null</code> 1351 * @throws SystemException if a system exception occurred 1352 * @see com.liferay.portal.security.auth.AuthPipeline 1353 */ 1354 @Override 1355 public int authenticateByEmailAddress(long companyId, 1356 java.lang.String emailAddress, java.lang.String password, 1357 java.util.Map<java.lang.String, java.lang.String[]> headerMap, 1358 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1359 java.util.Map<java.lang.String, java.lang.Object> resultsMap) 1360 throws com.liferay.portal.kernel.exception.PortalException, 1361 com.liferay.portal.kernel.exception.SystemException { 1362 return _userLocalService.authenticateByEmailAddress(companyId, 1363 emailAddress, password, headerMap, parameterMap, resultsMap); 1364 } 1365 1366 /** 1367 * Attempts to authenticate the user by their screen name and password, 1368 * while using the AuthPipeline. 1369 * 1370 * @param companyId the primary key of the user's company 1371 * @param screenName the user's screen name 1372 * @param password the user's password 1373 * @param headerMap the header map from the authentication request 1374 * @param parameterMap the parameter map from the authentication request 1375 * @param resultsMap the map of authentication results (may be nil). After 1376 a succesful authentication the user's primary key will be placed 1377 under the key <code>userId</code>. 1378 * @return the authentication status. This can be {@link 1379 com.liferay.portal.security.auth.Authenticator#FAILURE} 1380 indicating that the user's credentials are invalid, {@link 1381 com.liferay.portal.security.auth.Authenticator#SUCCESS} 1382 indicating a successful login, or {@link 1383 com.liferay.portal.security.auth.Authenticator#DNE} indicating 1384 that a user with that login does not exist. 1385 * @throws PortalException if <code>screenName</code> or 1386 <code>password</code> was <code>null</code> 1387 * @throws SystemException if a system exception occurred 1388 * @see com.liferay.portal.security.auth.AuthPipeline 1389 */ 1390 @Override 1391 public int authenticateByScreenName(long companyId, 1392 java.lang.String screenName, java.lang.String password, 1393 java.util.Map<java.lang.String, java.lang.String[]> headerMap, 1394 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1395 java.util.Map<java.lang.String, java.lang.Object> resultsMap) 1396 throws com.liferay.portal.kernel.exception.PortalException, 1397 com.liferay.portal.kernel.exception.SystemException { 1398 return _userLocalService.authenticateByScreenName(companyId, 1399 screenName, password, headerMap, parameterMap, resultsMap); 1400 } 1401 1402 /** 1403 * Attempts to authenticate the user by their primary key and password, 1404 * while using the AuthPipeline. 1405 * 1406 * @param companyId the primary key of the user's company 1407 * @param userId the user's primary key 1408 * @param password the user's password 1409 * @param headerMap the header map from the authentication request 1410 * @param parameterMap the parameter map from the authentication request 1411 * @param resultsMap the map of authentication results (may be nil). After 1412 a succesful authentication the user's primary key will be placed 1413 under the key <code>userId</code>. 1414 * @return the authentication status. This can be {@link 1415 com.liferay.portal.security.auth.Authenticator#FAILURE} 1416 indicating that the user's credentials are invalid, {@link 1417 com.liferay.portal.security.auth.Authenticator#SUCCESS} 1418 indicating a successful login, or {@link 1419 com.liferay.portal.security.auth.Authenticator#DNE} indicating 1420 that a user with that login does not exist. 1421 * @throws PortalException if <code>userId</code> or <code>password</code> 1422 was <code>null</code> 1423 * @throws SystemException if a system exception occurred 1424 * @see com.liferay.portal.security.auth.AuthPipeline 1425 */ 1426 @Override 1427 public int authenticateByUserId(long companyId, long userId, 1428 java.lang.String password, 1429 java.util.Map<java.lang.String, java.lang.String[]> headerMap, 1430 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1431 java.util.Map<java.lang.String, java.lang.Object> resultsMap) 1432 throws com.liferay.portal.kernel.exception.PortalException, 1433 com.liferay.portal.kernel.exception.SystemException { 1434 return _userLocalService.authenticateByUserId(companyId, userId, 1435 password, headerMap, parameterMap, resultsMap); 1436 } 1437 1438 /** 1439 * Attempts to authenticate the user using HTTP basic access authentication, 1440 * without using the AuthPipeline. Primarily used for authenticating users 1441 * of <code>tunnel-web</code>. 1442 * 1443 * <p> 1444 * Authentication type specifies what <code>login</code> contains.The valid 1445 * values are: 1446 * </p> 1447 * 1448 * <ul> 1449 * <li> 1450 * <code>CompanyConstants.AUTH_TYPE_EA</code> - <code>login</code> is the 1451 * user's email address 1452 * </li> 1453 * <li> 1454 * <code>CompanyConstants.AUTH_TYPE_SN</code> - <code>login</code> is the 1455 * user's screen name 1456 * </li> 1457 * <li> 1458 * <code>CompanyConstants.AUTH_TYPE_ID</code> - <code>login</code> is the 1459 * user's primary key 1460 * </li> 1461 * </ul> 1462 * 1463 * @param companyId the primary key of the user's company 1464 * @param authType the type of authentication to perform 1465 * @param login either the user's email address, screen name, or primary 1466 key depending on the value of <code>authType</code> 1467 * @param password the user's password 1468 * @return the authentication status. This can be {@link 1469 com.liferay.portal.security.auth.Authenticator#FAILURE} 1470 indicating that the user's credentials are invalid, {@link 1471 com.liferay.portal.security.auth.Authenticator#SUCCESS} 1472 indicating a successful login, or {@link 1473 com.liferay.portal.security.auth.Authenticator#DNE} indicating 1474 that a user with that login does not exist. 1475 * @throws PortalException if a portal exception occurred 1476 * @throws SystemException if a system exception occurred 1477 */ 1478 @Override 1479 public long authenticateForBasic(long companyId, java.lang.String authType, 1480 java.lang.String login, java.lang.String password) 1481 throws com.liferay.portal.kernel.exception.PortalException, 1482 com.liferay.portal.kernel.exception.SystemException { 1483 return _userLocalService.authenticateForBasic(companyId, authType, 1484 login, password); 1485 } 1486 1487 /** 1488 * Attempts to authenticate the user using HTTP digest access 1489 * authentication, without using the AuthPipeline. Primarily used for 1490 * authenticating users of <code>tunnel-web</code>. 1491 * 1492 * @param companyId the primary key of the user's company 1493 * @param username either the user's email address, screen name, or primary 1494 key 1495 * @param realm unused 1496 * @param nonce the number used once 1497 * @param method the request method 1498 * @param uri the request URI 1499 * @param response the authentication response hash 1500 * @return the user's primary key if authentication is succesful; 1501 <code>0</code> otherwise 1502 * @throws PortalException if a portal exception occurred 1503 * @throws SystemException if a system exception occurred 1504 */ 1505 @Override 1506 public long authenticateForDigest(long companyId, 1507 java.lang.String username, java.lang.String realm, 1508 java.lang.String nonce, java.lang.String method, java.lang.String uri, 1509 java.lang.String response) 1510 throws com.liferay.portal.kernel.exception.PortalException, 1511 com.liferay.portal.kernel.exception.SystemException { 1512 return _userLocalService.authenticateForDigest(companyId, username, 1513 realm, nonce, method, uri, response); 1514 } 1515 1516 /** 1517 * Attempts to authenticate the user using JAAS credentials, without using 1518 * the AuthPipeline. 1519 * 1520 * @param userId the primary key of the user 1521 * @param encPassword the encrypted password 1522 * @return <code>true</code> if authentication is successful; 1523 <code>false</code> otherwise 1524 */ 1525 @Override 1526 public boolean authenticateForJAAS(long userId, java.lang.String encPassword) { 1527 return _userLocalService.authenticateForJAAS(userId, encPassword); 1528 } 1529 1530 /** 1531 * Checks if the user is currently locked out based on the password policy, 1532 * and performs maintenance on the user's lockout and failed login data. 1533 * 1534 * @param user the user 1535 * @throws PortalException if the user was determined to still be locked out 1536 * @throws SystemException if a system exception occurred 1537 */ 1538 @Override 1539 public void checkLockout(com.liferay.portal.model.User user) 1540 throws com.liferay.portal.kernel.exception.PortalException, 1541 com.liferay.portal.kernel.exception.SystemException { 1542 _userLocalService.checkLockout(user); 1543 } 1544 1545 /** 1546 * Adds a failed login attempt to the user and updates the user's last 1547 * failed login date. 1548 * 1549 * @param user the user 1550 * @throws SystemException if a system exception occurred 1551 */ 1552 @Override 1553 public void checkLoginFailure(com.liferay.portal.model.User user) 1554 throws com.liferay.portal.kernel.exception.SystemException { 1555 _userLocalService.checkLoginFailure(user); 1556 } 1557 1558 /** 1559 * Adds a failed login attempt to the user with the email address and 1560 * updates the user's last failed login date. 1561 * 1562 * @param companyId the primary key of the user's company 1563 * @param emailAddress the user's email address 1564 * @throws PortalException if a user with the email address could not be 1565 found 1566 * @throws SystemException if a system exception occurred 1567 */ 1568 @Override 1569 public void checkLoginFailureByEmailAddress(long companyId, 1570 java.lang.String emailAddress) 1571 throws com.liferay.portal.kernel.exception.PortalException, 1572 com.liferay.portal.kernel.exception.SystemException { 1573 _userLocalService.checkLoginFailureByEmailAddress(companyId, 1574 emailAddress); 1575 } 1576 1577 /** 1578 * Adds a failed login attempt to the user and updates the user's last 1579 * failed login date. 1580 * 1581 * @param userId the primary key of the user 1582 * @throws PortalException if a user with the primary key could not be found 1583 * @throws SystemException if a system exception occurred 1584 */ 1585 @Override 1586 public void checkLoginFailureById(long userId) 1587 throws com.liferay.portal.kernel.exception.PortalException, 1588 com.liferay.portal.kernel.exception.SystemException { 1589 _userLocalService.checkLoginFailureById(userId); 1590 } 1591 1592 /** 1593 * Adds a failed login attempt to the user with the screen name and updates 1594 * the user's last failed login date. 1595 * 1596 * @param companyId the primary key of the user's company 1597 * @param screenName the user's screen name 1598 * @throws PortalException if a user with the screen name could not be found 1599 * @throws SystemException if a system exception occurred 1600 */ 1601 @Override 1602 public void checkLoginFailureByScreenName(long companyId, 1603 java.lang.String screenName) 1604 throws com.liferay.portal.kernel.exception.PortalException, 1605 com.liferay.portal.kernel.exception.SystemException { 1606 _userLocalService.checkLoginFailureByScreenName(companyId, screenName); 1607 } 1608 1609 /** 1610 * Checks if the user's password is expired based on the password policy, 1611 * and performs maintenance on the user's grace login and password reset 1612 * data. 1613 * 1614 * @param user the user 1615 * @throws PortalException if the user's password has expired and the grace 1616 login limit has been exceeded 1617 * @throws SystemException if a system exception occurred 1618 */ 1619 @Override 1620 public void checkPasswordExpired(com.liferay.portal.model.User user) 1621 throws com.liferay.portal.kernel.exception.PortalException, 1622 com.liferay.portal.kernel.exception.SystemException { 1623 _userLocalService.checkPasswordExpired(user); 1624 } 1625 1626 /** 1627 * Completes the user's registration by generating a password and sending 1628 * the confirmation email. 1629 * 1630 * @param user the user 1631 * @param serviceContext the service context to be applied. You can specify 1632 an unencrypted custom password for the user via attribute 1633 <code>passwordUnencrypted</code>. You automatically generate a 1634 password for the user by setting attribute 1635 <code>autoPassword</code> to <code>true</code>. You can send a 1636 confirmation email to the user by setting attribute 1637 <code>sendEmail</code> to <code>true</code>. 1638 * @throws PortalException if a portal exception occurred 1639 * @throws SystemException if a system exception occurred 1640 */ 1641 @Override 1642 public void completeUserRegistration(com.liferay.portal.model.User user, 1643 com.liferay.portal.service.ServiceContext serviceContext) 1644 throws com.liferay.portal.kernel.exception.PortalException, 1645 com.liferay.portal.kernel.exception.SystemException { 1646 _userLocalService.completeUserRegistration(user, serviceContext); 1647 } 1648 1649 /** 1650 * Decrypts the user's primary key and password from their encrypted forms. 1651 * Used for decrypting a user's credentials from the values stored in an 1652 * automatic login cookie. 1653 * 1654 * @param companyId the primary key of the user's company 1655 * @param name the encrypted primary key of the user 1656 * @param password the encrypted password of the user 1657 * @return the user's primary key and password 1658 * @throws PortalException if a user with the primary key could not be found 1659 or if the user's password was incorrect 1660 * @throws SystemException if a system exception occurred 1661 */ 1662 @Override 1663 public com.liferay.portal.kernel.util.KeyValuePair decryptUserId( 1664 long companyId, java.lang.String name, java.lang.String password) 1665 throws com.liferay.portal.kernel.exception.PortalException, 1666 com.liferay.portal.kernel.exception.SystemException { 1667 return _userLocalService.decryptUserId(companyId, name, password); 1668 } 1669 1670 /** 1671 * Deletes the user's portrait image. 1672 * 1673 * @param userId the primary key of the user 1674 * @throws PortalException if a user with the primary key could not be found 1675 or if the user's portrait could not be found 1676 * @throws SystemException if a system exception occurred 1677 */ 1678 @Override 1679 public void deletePortrait(long userId) 1680 throws com.liferay.portal.kernel.exception.PortalException, 1681 com.liferay.portal.kernel.exception.SystemException { 1682 _userLocalService.deletePortrait(userId); 1683 } 1684 1685 /** 1686 * Encrypts the primary key of the user. Used when encrypting the user's 1687 * credentials for storage in an automatic login cookie. 1688 * 1689 * @param name the primary key of the user 1690 * @return the user's encrypted primary key 1691 * @throws PortalException if a user with the primary key could not be found 1692 * @throws SystemException if a system exception occurred 1693 */ 1694 @Override 1695 public java.lang.String encryptUserId(java.lang.String name) 1696 throws com.liferay.portal.kernel.exception.PortalException, 1697 com.liferay.portal.kernel.exception.SystemException { 1698 return _userLocalService.encryptUserId(name); 1699 } 1700 1701 /** 1702 * Returns the user with the contact ID. 1703 * 1704 * @param contactId the user's contact ID 1705 * @return the user with the contact ID, or <code>null</code> if a user with 1706 the contact ID could not be found 1707 */ 1708 @Override 1709 public com.liferay.portal.model.User fetchUserByContactId(long contactId) 1710 throws com.liferay.portal.kernel.exception.SystemException { 1711 return _userLocalService.fetchUserByContactId(contactId); 1712 } 1713 1714 /** 1715 * Returns the user with the email address. 1716 * 1717 * @param companyId the primary key of the user's company 1718 * @param emailAddress the user's email address 1719 * @return the user with the email address, or <code>null</code> if a user 1720 with the email address could not be found 1721 * @throws SystemException if a system exception occurred 1722 */ 1723 @Override 1724 public com.liferay.portal.model.User fetchUserByEmailAddress( 1725 long companyId, java.lang.String emailAddress) 1726 throws com.liferay.portal.kernel.exception.SystemException { 1727 return _userLocalService.fetchUserByEmailAddress(companyId, emailAddress); 1728 } 1729 1730 /** 1731 * Returns the user with the Facebook ID. 1732 * 1733 * @param companyId the primary key of the user's company 1734 * @param facebookId the user's Facebook ID 1735 * @return the user with the Facebook ID, or <code>null</code> if a user 1736 with the Facebook ID could not be found 1737 * @throws SystemException if a system exception occurred 1738 */ 1739 @Override 1740 public com.liferay.portal.model.User fetchUserByFacebookId(long companyId, 1741 long facebookId) 1742 throws com.liferay.portal.kernel.exception.SystemException { 1743 return _userLocalService.fetchUserByFacebookId(companyId, facebookId); 1744 } 1745 1746 /** 1747 * Returns the user with the primary key. 1748 * 1749 * @param userId the primary key of the user 1750 * @return the user with the primary key, or <code>null</code> if a user 1751 with the primary key could not be found 1752 * @throws SystemException if a system exception occurred 1753 */ 1754 @Override 1755 public com.liferay.portal.model.User fetchUserById(long userId) 1756 throws com.liferay.portal.kernel.exception.SystemException { 1757 return _userLocalService.fetchUserById(userId); 1758 } 1759 1760 /** 1761 * Returns the user with the OpenID. 1762 * 1763 * @param companyId the primary key of the user's company 1764 * @param openId the user's OpenID 1765 * @return the user with the OpenID, or <code>null</code> if a user with the 1766 OpenID could not be found 1767 * @throws SystemException if a system exception occurred 1768 */ 1769 @Override 1770 public com.liferay.portal.model.User fetchUserByOpenId(long companyId, 1771 java.lang.String openId) 1772 throws com.liferay.portal.kernel.exception.SystemException { 1773 return _userLocalService.fetchUserByOpenId(companyId, openId); 1774 } 1775 1776 /** 1777 * Returns the user with the screen name. 1778 * 1779 * @param companyId the primary key of the user's company 1780 * @param screenName the user's screen name 1781 * @return the user with the screen name, or <code>null</code> if a user 1782 with the screen name could not be found 1783 * @throws SystemException if a system exception occurred 1784 */ 1785 @Override 1786 public com.liferay.portal.model.User fetchUserByScreenName(long companyId, 1787 java.lang.String screenName) 1788 throws com.liferay.portal.kernel.exception.SystemException { 1789 return _userLocalService.fetchUserByScreenName(companyId, screenName); 1790 } 1791 1792 /** 1793 * Returns a range of all the users belonging to the company. 1794 * 1795 * <p> 1796 * Useful when paginating results. Returns a maximum of <code>end - 1797 * start</code> instances. <code>start</code> and <code>end</code> are not 1798 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1799 * refers to the first result in the set. Setting both <code>start</code> 1800 * and <code>end</code> to {@link 1801 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1802 * result set. 1803 * </p> 1804 * 1805 * @param companyId the primary key of the company 1806 * @param start the lower bound of the range of users 1807 * @param end the upper bound of the range of users (not inclusive) 1808 * @return the range of users belonging to the company 1809 * @throws SystemException if a system exception occurred 1810 */ 1811 @Override 1812 public java.util.List<com.liferay.portal.model.User> getCompanyUsers( 1813 long companyId, int start, int end) 1814 throws com.liferay.portal.kernel.exception.SystemException { 1815 return _userLocalService.getCompanyUsers(companyId, start, end); 1816 } 1817 1818 /** 1819 * Returns the number of users belonging to the company. 1820 * 1821 * @param companyId the primary key of the company 1822 * @return the number of users belonging to the company 1823 * @throws SystemException if a system exception occurred 1824 */ 1825 @Override 1826 public int getCompanyUsersCount(long companyId) 1827 throws com.liferay.portal.kernel.exception.SystemException { 1828 return _userLocalService.getCompanyUsersCount(companyId); 1829 } 1830 1831 /** 1832 * Returns the default user for the company. 1833 * 1834 * @param companyId the primary key of the company 1835 * @return the default user for the company 1836 * @throws PortalException if a default user for the company could not be 1837 found 1838 * @throws SystemException if a system exception occurred 1839 */ 1840 @Override 1841 public com.liferay.portal.model.User getDefaultUser(long companyId) 1842 throws com.liferay.portal.kernel.exception.PortalException, 1843 com.liferay.portal.kernel.exception.SystemException { 1844 return _userLocalService.getDefaultUser(companyId); 1845 } 1846 1847 /** 1848 * Returns the primary key of the default user for the company. 1849 * 1850 * @param companyId the primary key of the company 1851 * @return the primary key of the default user for the company 1852 * @throws PortalException if a default user for the company could not be 1853 found 1854 * @throws SystemException if a system exception occurred 1855 */ 1856 @Override 1857 public long getDefaultUserId(long companyId) 1858 throws com.liferay.portal.kernel.exception.PortalException, 1859 com.liferay.portal.kernel.exception.SystemException { 1860 return _userLocalService.getDefaultUserId(companyId); 1861 } 1862 1863 /** 1864 * Returns the primary keys of all the users belonging to the group. 1865 * 1866 * @param groupId the primary key of the group 1867 * @return the primary keys of the users belonging to the group 1868 * @throws SystemException if a system exception occurred 1869 */ 1870 @Override 1871 public long[] getGroupUserIds(long groupId) 1872 throws com.liferay.portal.kernel.exception.SystemException { 1873 return _userLocalService.getGroupUserIds(groupId); 1874 } 1875 1876 /** 1877 * Returns the number of users with the status belonging to the group. 1878 * 1879 * @param groupId the primary key of the group 1880 * @param status the workflow status 1881 * @return the number of users with the status belonging to the group 1882 * @throws PortalException if a group with the primary key could not be 1883 found 1884 * @throws SystemException if a system exception occurred 1885 */ 1886 @Override 1887 public int getGroupUsersCount(long groupId, int status) 1888 throws com.liferay.portal.kernel.exception.PortalException, 1889 com.liferay.portal.kernel.exception.SystemException { 1890 return _userLocalService.getGroupUsersCount(groupId, status); 1891 } 1892 1893 @Override 1894 public java.util.List<com.liferay.portal.model.User> getInheritedRoleUsers( 1895 long roleId, int start, int end, 1896 com.liferay.portal.kernel.util.OrderByComparator obc) 1897 throws com.liferay.portal.kernel.exception.PortalException, 1898 com.liferay.portal.kernel.exception.SystemException { 1899 return _userLocalService.getInheritedRoleUsers(roleId, start, end, obc); 1900 } 1901 1902 /** 1903 * Returns all the users who have not had any announcements of the type 1904 * delivered, excluding the default user. 1905 * 1906 * @param type the type of announcement 1907 * @return the users who have not had any annoucements of the type delivered 1908 * @throws SystemException if a system exception occurred 1909 */ 1910 @Override 1911 public java.util.List<com.liferay.portal.model.User> getNoAnnouncementsDeliveries( 1912 java.lang.String type) 1913 throws com.liferay.portal.kernel.exception.SystemException { 1914 return _userLocalService.getNoAnnouncementsDeliveries(type); 1915 } 1916 1917 /** 1918 * Returns all the users who do not have any contacts. 1919 * 1920 * @return the users who do not have any contacts 1921 * @throws SystemException if a system exception occurred 1922 */ 1923 @Override 1924 public java.util.List<com.liferay.portal.model.User> getNoContacts() 1925 throws com.liferay.portal.kernel.exception.SystemException { 1926 return _userLocalService.getNoContacts(); 1927 } 1928 1929 /** 1930 * Returns all the users who do not belong to any groups, excluding the 1931 * default user. 1932 * 1933 * @return the users who do not belong to any groups 1934 * @throws SystemException if a system exception occurred 1935 */ 1936 @Override 1937 public java.util.List<com.liferay.portal.model.User> getNoGroups() 1938 throws com.liferay.portal.kernel.exception.SystemException { 1939 return _userLocalService.getNoGroups(); 1940 } 1941 1942 /** 1943 * Returns the primary keys of all the users belonging to the organization. 1944 * 1945 * @param organizationId the primary key of the organization 1946 * @return the primary keys of the users belonging to the organization 1947 * @throws SystemException if a system exception occurred 1948 */ 1949 @Override 1950 public long[] getOrganizationUserIds(long organizationId) 1951 throws com.liferay.portal.kernel.exception.SystemException { 1952 return _userLocalService.getOrganizationUserIds(organizationId); 1953 } 1954 1955 /** 1956 * Returns the number of users with the status belonging to the 1957 * organization. 1958 * 1959 * @param organizationId the primary key of the organization 1960 * @param status the workflow status 1961 * @return the number of users with the status belonging to the organization 1962 * @throws PortalException if an organization with the primary key could not 1963 be found 1964 * @throws SystemException if a system exception occurred 1965 */ 1966 @Override 1967 public int getOrganizationUsersCount(long organizationId, int status) 1968 throws com.liferay.portal.kernel.exception.PortalException, 1969 com.liferay.portal.kernel.exception.SystemException { 1970 return _userLocalService.getOrganizationUsersCount(organizationId, 1971 status); 1972 } 1973 1974 /** 1975 * Returns the primary keys of all the users belonging to the role. 1976 * 1977 * @param roleId the primary key of the role 1978 * @return the primary keys of the users belonging to the role 1979 * @throws SystemException if a system exception occurred 1980 */ 1981 @Override 1982 public long[] getRoleUserIds(long roleId) 1983 throws com.liferay.portal.kernel.exception.SystemException { 1984 return _userLocalService.getRoleUserIds(roleId); 1985 } 1986 1987 /** 1988 * Returns the number of users with the status belonging to the role. 1989 * 1990 * @param roleId the primary key of the role 1991 * @param status the workflow status 1992 * @return the number of users with the status belonging to the role 1993 * @throws PortalException if an role with the primary key could not be 1994 found 1995 * @throws SystemException if a system exception occurred 1996 */ 1997 @Override 1998 public int getRoleUsersCount(long roleId, int status) 1999 throws com.liferay.portal.kernel.exception.PortalException, 2000 com.liferay.portal.kernel.exception.SystemException { 2001 return _userLocalService.getRoleUsersCount(roleId, status); 2002 } 2003 2004 /** 2005 * Returns an ordered range of all the users with a social relation of the 2006 * type with the user. 2007 * 2008 * <p> 2009 * Useful when paginating results. Returns a maximum of <code>end - 2010 * start</code> instances. <code>start</code> and <code>end</code> are not 2011 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2012 * refers to the first result in the set. Setting both <code>start</code> 2013 * and <code>end</code> to {@link 2014 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 2015 * result set. 2016 * </p> 2017 * 2018 * @param userId the primary key of the user 2019 * @param type the type of social relation. The possible types can be found 2020 in {@link 2021 com.liferay.portlet.social.model.SocialRelationConstants}. 2022 * @param start the lower bound of the range of users 2023 * @param end the upper bound of the range of users (not inclusive) 2024 * @param obc the comparator to order the users by (optionally 2025 <code>null</code>) 2026 * @return the ordered range of users with a social relation of the type 2027 with the user 2028 * @throws PortalException if a user with the primary key could not be found 2029 * @throws SystemException if a system exception occurred 2030 */ 2031 @Override 2032 public java.util.List<com.liferay.portal.model.User> getSocialUsers( 2033 long userId, int type, int start, int end, 2034 com.liferay.portal.kernel.util.OrderByComparator obc) 2035 throws com.liferay.portal.kernel.exception.PortalException, 2036 com.liferay.portal.kernel.exception.SystemException { 2037 return _userLocalService.getSocialUsers(userId, type, start, end, obc); 2038 } 2039 2040 /** 2041 * Returns an ordered range of all the users with a social relation with the 2042 * user. 2043 * 2044 * <p> 2045 * Useful when paginating results. Returns a maximum of <code>end - 2046 * start</code> instances. <code>start</code> and <code>end</code> are not 2047 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2048 * refers to the first result in the set. Setting both <code>start</code> 2049 * and <code>end</code> to {@link 2050 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 2051 * result set. 2052 * </p> 2053 * 2054 * @param userId the primary key of the user 2055 * @param start the lower bound of the range of users 2056 * @param end the upper bound of the range of users (not inclusive) 2057 * @param obc the comparator to order the users by (optionally 2058 <code>null</code>) 2059 * @return the ordered range of users with a social relation with the user 2060 * @throws PortalException if a user with the primary key could not be found 2061 * @throws SystemException if a system exception occurred 2062 */ 2063 @Override 2064 public java.util.List<com.liferay.portal.model.User> getSocialUsers( 2065 long userId, int start, int end, 2066 com.liferay.portal.kernel.util.OrderByComparator obc) 2067 throws com.liferay.portal.kernel.exception.PortalException, 2068 com.liferay.portal.kernel.exception.SystemException { 2069 return _userLocalService.getSocialUsers(userId, start, end, obc); 2070 } 2071 2072 /** 2073 * Returns an ordered range of all the users with a mutual social relation 2074 * of the type with both of the given users. 2075 * 2076 * <p> 2077 * Useful when paginating results. Returns a maximum of <code>end - 2078 * start</code> instances. <code>start</code> and <code>end</code> are not 2079 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2080 * refers to the first result in the set. Setting both <code>start</code> 2081 * and <code>end</code> to {@link 2082 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 2083 * result set. 2084 * </p> 2085 * 2086 * @param userId1 the primary key of the first user 2087 * @param userId2 the primary key of the second user 2088 * @param type the type of social relation. The possible types can be found 2089 in {@link 2090 com.liferay.portlet.social.model.SocialRelationConstants}. 2091 * @param start the lower bound of the range of users 2092 * @param end the upper bound of the range of users (not inclusive) 2093 * @param obc the comparator to order the users by (optionally 2094 <code>null</code>) 2095 * @return the ordered range of users with a mutual social relation of the 2096 type with the user 2097 * @throws PortalException if a user with the primary key could not be found 2098 * @throws SystemException if a system exception occurred 2099 */ 2100 @Override 2101 public java.util.List<com.liferay.portal.model.User> getSocialUsers( 2102 long userId1, long userId2, int type, int start, int end, 2103 com.liferay.portal.kernel.util.OrderByComparator obc) 2104 throws com.liferay.portal.kernel.exception.PortalException, 2105 com.liferay.portal.kernel.exception.SystemException { 2106 return _userLocalService.getSocialUsers(userId1, userId2, type, start, 2107 end, obc); 2108 } 2109 2110 /** 2111 * Returns an ordered range of all the users with a mutual social relation 2112 * with both of the given users. 2113 * 2114 * <p> 2115 * Useful when paginating results. Returns a maximum of <code>end - 2116 * start</code> instances. <code>start</code> and <code>end</code> are not 2117 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2118 * refers to the first result in the set. Setting both <code>start</code> 2119 * and <code>end</code> to {@link 2120 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 2121 * result set. 2122 * </p> 2123 * 2124 * @param userId1 the primary key of the first user 2125 * @param userId2 the primary key of the second user 2126 * @param start the lower bound of the range of users 2127 * @param end the upper bound of the range of users (not inclusive) 2128 * @param obc the comparator to order the users by (optionally 2129 <code>null</code>) 2130 * @return the ordered range of users with a mutual social relation with the 2131 user 2132 * @throws PortalException if a user with the primary key could not be found 2133 * @throws SystemException if a system exception occurred 2134 */ 2135 @Override 2136 public java.util.List<com.liferay.portal.model.User> getSocialUsers( 2137 long userId1, long userId2, int start, int end, 2138 com.liferay.portal.kernel.util.OrderByComparator obc) 2139 throws com.liferay.portal.kernel.exception.PortalException, 2140 com.liferay.portal.kernel.exception.SystemException { 2141 return _userLocalService.getSocialUsers(userId1, userId2, start, end, 2142 obc); 2143 } 2144 2145 /** 2146 * Returns the number of users with a social relation with the user. 2147 * 2148 * @param userId the primary key of the user 2149 * @return the number of users with a social relation with the user 2150 * @throws PortalException if a user with the primary key could not be found 2151 * @throws SystemException if a system exception occurred 2152 */ 2153 @Override 2154 public int getSocialUsersCount(long userId) 2155 throws com.liferay.portal.kernel.exception.PortalException, 2156 com.liferay.portal.kernel.exception.SystemException { 2157 return _userLocalService.getSocialUsersCount(userId); 2158 } 2159 2160 /** 2161 * Returns the number of users with a social relation of the type with the 2162 * user. 2163 * 2164 * @param userId the primary key of the user 2165 * @param type the type of social relation. The possible types can be found 2166 in {@link 2167 com.liferay.portlet.social.model.SocialRelationConstants}. 2168 * @return the number of users with a social relation of the type with the 2169 user 2170 * @throws PortalException if a user with the primary key could not be found 2171 * @throws SystemException if a system exception occurred 2172 */ 2173 @Override 2174 public int getSocialUsersCount(long userId, int type) 2175 throws com.liferay.portal.kernel.exception.PortalException, 2176 com.liferay.portal.kernel.exception.SystemException { 2177 return _userLocalService.getSocialUsersCount(userId, type); 2178 } 2179 2180 /** 2181 * Returns the number of users with a mutual social relation with both of 2182 * the given users. 2183 * 2184 * @param userId1 the primary key of the first user 2185 * @param userId2 the primary key of the second user 2186 * @return the number of users with a mutual social relation with the user 2187 * @throws PortalException if a user with the primary key could not be found 2188 * @throws SystemException if a system exception occurred 2189 */ 2190 @Override 2191 public int getSocialUsersCount(long userId1, long userId2) 2192 throws com.liferay.portal.kernel.exception.PortalException, 2193 com.liferay.portal.kernel.exception.SystemException { 2194 return _userLocalService.getSocialUsersCount(userId1, userId2); 2195 } 2196 2197 /** 2198 * Returns the number of users with a mutual social relation of the type 2199 * with both of the given users. 2200 * 2201 * @param userId1 the primary key of the first user 2202 * @param userId2 the primary key of the second user 2203 * @param type the type of social relation. The possible types can be found 2204 in {@link 2205 com.liferay.portlet.social.model.SocialRelationConstants}. 2206 * @return the number of users with a mutual social relation of the type 2207 with the user 2208 * @throws PortalException if a user with the primary key could not be found 2209 * @throws SystemException if a system exception occurred 2210 */ 2211 @Override 2212 public int getSocialUsersCount(long userId1, long userId2, int type) 2213 throws com.liferay.portal.kernel.exception.PortalException, 2214 com.liferay.portal.kernel.exception.SystemException { 2215 return _userLocalService.getSocialUsersCount(userId1, userId2, type); 2216 } 2217 2218 /** 2219 * Returns the user with the contact ID. 2220 * 2221 * @param contactId the user's contact ID 2222 * @return the user with the contact ID 2223 * @throws PortalException if a user with the contact ID could not be found 2224 * @throws SystemException if a system exception occurred 2225 */ 2226 @Override 2227 public com.liferay.portal.model.User getUserByContactId(long contactId) 2228 throws com.liferay.portal.kernel.exception.PortalException, 2229 com.liferay.portal.kernel.exception.SystemException { 2230 return _userLocalService.getUserByContactId(contactId); 2231 } 2232 2233 /** 2234 * Returns the user with the email address. 2235 * 2236 * @param companyId the primary key of the user's company 2237 * @param emailAddress the user's email address 2238 * @return the user with the email address 2239 * @throws PortalException if a user with the email address could not be 2240 found 2241 * @throws SystemException if a system exception occurred 2242 */ 2243 @Override 2244 public com.liferay.portal.model.User getUserByEmailAddress(long companyId, 2245 java.lang.String emailAddress) 2246 throws com.liferay.portal.kernel.exception.PortalException, 2247 com.liferay.portal.kernel.exception.SystemException { 2248 return _userLocalService.getUserByEmailAddress(companyId, emailAddress); 2249 } 2250 2251 /** 2252 * Returns the user with the Facebook ID. 2253 * 2254 * @param companyId the primary key of the user's company 2255 * @param facebookId the user's Facebook ID 2256 * @return the user with the Facebook ID 2257 * @throws PortalException if a user with the Facebook ID could not be found 2258 * @throws SystemException if a system exception occurred 2259 */ 2260 @Override 2261 public com.liferay.portal.model.User getUserByFacebookId(long companyId, 2262 long facebookId) 2263 throws com.liferay.portal.kernel.exception.PortalException, 2264 com.liferay.portal.kernel.exception.SystemException { 2265 return _userLocalService.getUserByFacebookId(companyId, facebookId); 2266 } 2267 2268 /** 2269 * Returns the user with the primary key. 2270 * 2271 * @param userId the primary key of the user 2272 * @return the user with the primary key 2273 * @throws PortalException if a user with the primary key could not be found 2274 * @throws SystemException if a system exception occurred 2275 */ 2276 @Override 2277 public com.liferay.portal.model.User getUserById(long userId) 2278 throws com.liferay.portal.kernel.exception.PortalException, 2279 com.liferay.portal.kernel.exception.SystemException { 2280 return _userLocalService.getUserById(userId); 2281 } 2282 2283 /** 2284 * Returns the user with the primary key from the company. 2285 * 2286 * @param companyId the primary key of the user's company 2287 * @param userId the primary key of the user 2288 * @return the user with the primary key 2289 * @throws PortalException if a user with the primary key from the company 2290 could not be found 2291 * @throws SystemException if a system exception occurred 2292 */ 2293 @Override 2294 public com.liferay.portal.model.User getUserById(long companyId, long userId) 2295 throws com.liferay.portal.kernel.exception.PortalException, 2296 com.liferay.portal.kernel.exception.SystemException { 2297 return _userLocalService.getUserById(companyId, userId); 2298 } 2299 2300 /** 2301 * Returns the user with the OpenID. 2302 * 2303 * @param companyId the primary key of the user's company 2304 * @param openId the user's OpenID 2305 * @return the user with the OpenID 2306 * @throws PortalException if a user with the OpenID could not be found 2307 * @throws SystemException if a system exception occurred 2308 */ 2309 @Override 2310 public com.liferay.portal.model.User getUserByOpenId(long companyId, 2311 java.lang.String openId) 2312 throws com.liferay.portal.kernel.exception.PortalException, 2313 com.liferay.portal.kernel.exception.SystemException { 2314 return _userLocalService.getUserByOpenId(companyId, openId); 2315 } 2316 2317 /** 2318 * Returns the user with the portrait ID. 2319 * 2320 * @param portraitId the user's portrait ID 2321 * @return the user with the portrait ID 2322 * @throws PortalException if a user with the portrait ID could not be found 2323 * @throws SystemException if a system exception occurred 2324 */ 2325 @Override 2326 public com.liferay.portal.model.User getUserByPortraitId(long portraitId) 2327 throws com.liferay.portal.kernel.exception.PortalException, 2328 com.liferay.portal.kernel.exception.SystemException { 2329 return _userLocalService.getUserByPortraitId(portraitId); 2330 } 2331 2332 /** 2333 * Returns the user with the screen name. 2334 * 2335 * @param companyId the primary key of the user's company 2336 * @param screenName the user's screen name 2337 * @return the user with the screen name 2338 * @throws PortalException if a user with the screen name could not be found 2339 * @throws SystemException if a system exception occurred 2340 */ 2341 @Override 2342 public com.liferay.portal.model.User getUserByScreenName(long companyId, 2343 java.lang.String screenName) 2344 throws com.liferay.portal.kernel.exception.PortalException, 2345 com.liferay.portal.kernel.exception.SystemException { 2346 return _userLocalService.getUserByScreenName(companyId, screenName); 2347 } 2348 2349 /** 2350 * Returns the user with the UUID. 2351 * 2352 * @param uuid the user's UUID 2353 * @return the user with the UUID 2354 * @throws PortalException if a user with the UUID could not be found 2355 * @throws SystemException if a system exception occurred 2356 * @deprecated As of 6.2.0, replaced by {@link 2357 #getUserByUuidAndCompanyId(String, long)} 2358 */ 2359 @Override 2360 public com.liferay.portal.model.User getUserByUuid(java.lang.String uuid) 2361 throws com.liferay.portal.kernel.exception.PortalException, 2362 com.liferay.portal.kernel.exception.SystemException { 2363 return _userLocalService.getUserByUuid(uuid); 2364 } 2365 2366 /** 2367 * Returns the number of users with the status belonging to the user group. 2368 * 2369 * @param userGroupId the primary key of the user group 2370 * @param status the workflow status 2371 * @return the number of users with the status belonging to the user group 2372 * @throws PortalException if a user group with the primary key could not be 2373 found 2374 * @throws SystemException if a system exception occurred 2375 */ 2376 @Override 2377 public int getUserGroupUsersCount(long userGroupId, int status) 2378 throws com.liferay.portal.kernel.exception.PortalException, 2379 com.liferay.portal.kernel.exception.SystemException { 2380 return _userLocalService.getUserGroupUsersCount(userGroupId, status); 2381 } 2382 2383 /** 2384 * Returns the primary key of the user with the email address. 2385 * 2386 * @param companyId the primary key of the user's company 2387 * @param emailAddress the user's email address 2388 * @return the primary key of the user with the email address 2389 * @throws PortalException if a user with the email address could not be 2390 found 2391 * @throws SystemException if a system exception occurred 2392 */ 2393 @Override 2394 public long getUserIdByEmailAddress(long companyId, 2395 java.lang.String emailAddress) 2396 throws com.liferay.portal.kernel.exception.PortalException, 2397 com.liferay.portal.kernel.exception.SystemException { 2398 return _userLocalService.getUserIdByEmailAddress(companyId, emailAddress); 2399 } 2400 2401 /** 2402 * Returns the primary key of the user with the screen name. 2403 * 2404 * @param companyId the primary key of the user's company 2405 * @param screenName the user's screen name 2406 * @return the primary key of the user with the screen name 2407 * @throws PortalException if a user with the screen name could not be found 2408 * @throws SystemException if a system exception occurred 2409 */ 2410 @Override 2411 public long getUserIdByScreenName(long companyId, 2412 java.lang.String screenName) 2413 throws com.liferay.portal.kernel.exception.PortalException, 2414 com.liferay.portal.kernel.exception.SystemException { 2415 return _userLocalService.getUserIdByScreenName(companyId, screenName); 2416 } 2417 2418 /** 2419 * Returns <code>true</code> if the password policy has been assigned to the 2420 * user. 2421 * 2422 * @param passwordPolicyId the primary key of the password policy 2423 * @param userId the primary key of the user 2424 * @return <code>true</code> if the password policy is assigned to the user; 2425 <code>false</code> otherwise 2426 * @throws SystemException if a system exception occurred 2427 */ 2428 @Override 2429 public boolean hasPasswordPolicyUser(long passwordPolicyId, long userId) 2430 throws com.liferay.portal.kernel.exception.SystemException { 2431 return _userLocalService.hasPasswordPolicyUser(passwordPolicyId, userId); 2432 } 2433 2434 /** 2435 * Returns <code>true</code> if the user has the role with the name, 2436 * optionally through inheritance. 2437 * 2438 * @param companyId the primary key of the role's company 2439 * @param name the name of the role (must be a regular role, not an 2440 organization, site or provider role) 2441 * @param userId the primary key of the user 2442 * @param inherited whether to include roles inherited from organizations, 2443 sites, etc. 2444 * @return <code>true</code> if the user has the role; <code>false</code> 2445 otherwise 2446 * @throws PortalException if a role with the name could not be found 2447 * @throws SystemException if a system exception occurred 2448 */ 2449 @Override 2450 public boolean hasRoleUser(long companyId, java.lang.String name, 2451 long userId, boolean inherited) 2452 throws com.liferay.portal.kernel.exception.PortalException, 2453 com.liferay.portal.kernel.exception.SystemException { 2454 return _userLocalService.hasRoleUser(companyId, name, userId, inherited); 2455 } 2456 2457 /** 2458 * Returns <code>true</code> if the user's password is expired. 2459 * 2460 * @param user the user 2461 * @return <code>true</code> if the user's password is expired; 2462 <code>false</code> otherwise 2463 * @throws PortalException if the password policy for the user could not be 2464 found 2465 * @throws SystemException if a system exception occurred 2466 */ 2467 @Override 2468 public boolean isPasswordExpired(com.liferay.portal.model.User user) 2469 throws com.liferay.portal.kernel.exception.PortalException, 2470 com.liferay.portal.kernel.exception.SystemException { 2471 return _userLocalService.isPasswordExpired(user); 2472 } 2473 2474 /** 2475 * Returns <code>true</code> if the password policy is configured to warn 2476 * the user that his password is expiring and the remaining time until 2477 * expiration is equal or less than the configured warning time. 2478 * 2479 * @param user the user 2480 * @return <code>true</code> if the user's password is expiring soon; 2481 <code>false</code> otherwise 2482 * @throws PortalException if the password policy for the user could not be 2483 found 2484 * @throws SystemException if a system exception occurred 2485 */ 2486 @Override 2487 public boolean isPasswordExpiringSoon(com.liferay.portal.model.User user) 2488 throws com.liferay.portal.kernel.exception.PortalException, 2489 com.liferay.portal.kernel.exception.SystemException { 2490 return _userLocalService.isPasswordExpiringSoon(user); 2491 } 2492 2493 /** 2494 * Returns the default user for the company. 2495 * 2496 * @param companyId the primary key of the company 2497 * @return the default user for the company 2498 * @throws PortalException if the user could not be found 2499 * @throws SystemException if a system exception occurred 2500 */ 2501 @Override 2502 public com.liferay.portal.model.User loadGetDefaultUser(long companyId) 2503 throws com.liferay.portal.kernel.exception.PortalException, 2504 com.liferay.portal.kernel.exception.SystemException { 2505 return _userLocalService.loadGetDefaultUser(companyId); 2506 } 2507 2508 /** 2509 * Returns an ordered range of all the users who match the keywords and 2510 * status, without using the indexer. It is preferable to use the indexed 2511 * version {@link #search(long, String, int, LinkedHashMap, int, int, Sort)} 2512 * instead of this method wherever possible for performance reasons. 2513 * 2514 * <p> 2515 * Useful when paginating results. Returns a maximum of <code>end - 2516 * start</code> instances. <code>start</code> and <code>end</code> are not 2517 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2518 * refers to the first result in the set. Setting both <code>start</code> 2519 * and <code>end</code> to {@link 2520 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 2521 * result set. 2522 * </p> 2523 * 2524 * @param companyId the primary key of the user's company 2525 * @param keywords the keywords (space separated), which may occur in the 2526 user's first name, middle name, last name, screen name, or email 2527 address 2528 * @param status the workflow status 2529 * @param params the finder parameters (optionally <code>null</code>). For 2530 more information see {@link 2531 com.liferay.portal.service.persistence.UserFinder}. 2532 * @param start the lower bound of the range of users 2533 * @param end the upper bound of the range of users (not inclusive) 2534 * @param obc the comparator to order the users by (optionally 2535 <code>null</code>) 2536 * @return the matching users 2537 * @throws SystemException if a system exception occurred 2538 * @see com.liferay.portal.service.persistence.UserFinder 2539 */ 2540 @Override 2541 public java.util.List<com.liferay.portal.model.User> search( 2542 long companyId, java.lang.String keywords, int status, 2543 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2544 int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) 2545 throws com.liferay.portal.kernel.exception.SystemException { 2546 return _userLocalService.search(companyId, keywords, status, params, 2547 start, end, obc); 2548 } 2549 2550 /** 2551 * Returns an ordered range of all the users who match the keywords and 2552 * status, using the indexer. It is preferable to use this method instead of 2553 * the non-indexed version whenever possible for performance reasons. 2554 * 2555 * <p> 2556 * Useful when paginating results. Returns a maximum of <code>end - 2557 * start</code> instances. <code>start</code> and <code>end</code> are not 2558 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2559 * refers to the first result in the set. Setting both <code>start</code> 2560 * and <code>end</code> to {@link 2561 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 2562 * result set. 2563 * </p> 2564 * 2565 * @param companyId the primary key of the user's company 2566 * @param keywords the keywords (space separated), which may occur in the 2567 user's first name, middle name, last name, screen name, or email 2568 address 2569 * @param status the workflow status 2570 * @param params the indexer parameters (optionally <code>null</code>). For 2571 more information see {@link 2572 com.liferay.portlet.usersadmin.util.UserIndexer}. 2573 * @param start the lower bound of the range of users 2574 * @param end the upper bound of the range of users (not inclusive) 2575 * @param sort the field and direction to sort by (optionally 2576 <code>null</code>) 2577 * @return the matching users 2578 * @throws SystemException if a system exception occurred 2579 * @see com.liferay.portlet.usersadmin.util.UserIndexer 2580 */ 2581 @Override 2582 public com.liferay.portal.kernel.search.Hits search(long companyId, 2583 java.lang.String keywords, int status, 2584 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2585 int start, int end, com.liferay.portal.kernel.search.Sort sort) 2586 throws com.liferay.portal.kernel.exception.SystemException { 2587 return _userLocalService.search(companyId, keywords, status, params, 2588 start, end, sort); 2589 } 2590 2591 /** 2592 * Returns an ordered range of all the users with the status, and whose 2593 * first name, middle name, last name, screen name, and email address match 2594 * the keywords specified for them, without using the indexer. It is 2595 * preferable to use the indexed version {@link #search(long, String, 2596 * String, String, String, String, int, LinkedHashMap, boolean, int, int, 2597 * Sort)} instead of this method wherever possible for performance reasons. 2598 * 2599 * <p> 2600 * Useful when paginating results. Returns a maximum of <code>end - 2601 * start</code> instances. <code>start</code> and <code>end</code> are not 2602 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2603 * refers to the first result in the set. Setting both <code>start</code> 2604 * and <code>end</code> to {@link 2605 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 2606 * result set. 2607 * </p> 2608 * 2609 * @param companyId the primary key of the user's company 2610 * @param firstName the first name keywords (space separated) 2611 * @param middleName the middle name keywords 2612 * @param lastName the last name keywords 2613 * @param screenName the screen name keywords 2614 * @param emailAddress the email address keywords 2615 * @param status the workflow status 2616 * @param params the finder parameters (optionally <code>null</code>). For 2617 more information see {@link 2618 com.liferay.portal.service.persistence.UserFinder}. 2619 * @param andSearch whether every field must match its keywords, or just 2620 one field. For example, "users with the first name 'bob' and 2621 last name 'smith'" vs "users with the first name 'bob' 2622 or the last name 'smith'". 2623 * @param start the lower bound of the range of users 2624 * @param end the upper bound of the range of users (not inclusive) 2625 * @param obc the comparator to order the users by (optionally 2626 <code>null</code>) 2627 * @return the matching users 2628 * @throws SystemException if a system exception occurred 2629 * @see com.liferay.portal.service.persistence.UserFinder 2630 */ 2631 @Override 2632 public java.util.List<com.liferay.portal.model.User> search( 2633 long companyId, java.lang.String firstName, 2634 java.lang.String middleName, java.lang.String lastName, 2635 java.lang.String screenName, java.lang.String emailAddress, int status, 2636 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2637 boolean andSearch, int start, int end, 2638 com.liferay.portal.kernel.util.OrderByComparator obc) 2639 throws com.liferay.portal.kernel.exception.SystemException { 2640 return _userLocalService.search(companyId, firstName, middleName, 2641 lastName, screenName, emailAddress, status, params, andSearch, 2642 start, end, obc); 2643 } 2644 2645 /** 2646 * Returns an ordered range of all the users with the status, and whose 2647 * first name, middle name, last name, screen name, and email address match 2648 * the keywords specified for them, using the indexer. It is preferable to 2649 * use this method instead of the non-indexed version whenever possible for 2650 * performance reasons. 2651 * 2652 * <p> 2653 * Useful when paginating results. Returns a maximum of <code>end - 2654 * start</code> instances. <code>start</code> and <code>end</code> are not 2655 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2656 * refers to the first result in the set. Setting both <code>start</code> 2657 * and <code>end</code> to {@link 2658 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 2659 * result set. 2660 * </p> 2661 * 2662 * @param companyId the primary key of the user's company 2663 * @param firstName the first name keywords (space separated) 2664 * @param middleName the middle name keywords 2665 * @param lastName the last name keywords 2666 * @param screenName the screen name keywords 2667 * @param emailAddress the email address keywords 2668 * @param status the workflow status 2669 * @param params the indexer parameters (optionally <code>null</code>). For 2670 more information see {@link 2671 com.liferay.portlet.usersadmin.util.UserIndexer}. 2672 * @param andSearch whether every field must match its keywords, or just 2673 one field. For example, "users with the first name 'bob' and 2674 last name 'smith'" vs "users with the first name 'bob' 2675 or the last name 'smith'". 2676 * @param start the lower bound of the range of users 2677 * @param end the upper bound of the range of users (not inclusive) 2678 * @param sort the field and direction to sort by (optionally 2679 <code>null</code>) 2680 * @return the matching users 2681 * @throws SystemException if a system exception occurred 2682 * @see com.liferay.portlet.usersadmin.util.UserIndexer 2683 */ 2684 @Override 2685 public com.liferay.portal.kernel.search.Hits search(long companyId, 2686 java.lang.String firstName, java.lang.String middleName, 2687 java.lang.String lastName, java.lang.String screenName, 2688 java.lang.String emailAddress, int status, 2689 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2690 boolean andSearch, int start, int end, 2691 com.liferay.portal.kernel.search.Sort sort) 2692 throws com.liferay.portal.kernel.exception.SystemException { 2693 return _userLocalService.search(companyId, firstName, middleName, 2694 lastName, screenName, emailAddress, status, params, andSearch, 2695 start, end, sort); 2696 } 2697 2698 /** 2699 * Returns the number of users who match the keywords and status. 2700 * 2701 * @param companyId the primary key of the user's company 2702 * @param keywords the keywords (space separated), which may occur in the 2703 user's first name, middle name, last name, screen name, or email 2704 address 2705 * @param status the workflow status 2706 * @param params the finder parameters (optionally <code>null</code>). For 2707 more information see {@link 2708 com.liferay.portal.service.persistence.UserFinder}. 2709 * @return the number matching users 2710 * @throws SystemException if a system exception occurred 2711 */ 2712 @Override 2713 public int searchCount(long companyId, java.lang.String keywords, 2714 int status, 2715 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params) 2716 throws com.liferay.portal.kernel.exception.SystemException { 2717 return _userLocalService.searchCount(companyId, keywords, status, params); 2718 } 2719 2720 /** 2721 * Returns the number of users with the status, and whose first name, middle 2722 * name, last name, screen name, and email address match the keywords 2723 * specified for them. 2724 * 2725 * @param companyId the primary key of the user's company 2726 * @param firstName the first name keywords (space separated) 2727 * @param middleName the middle name keywords 2728 * @param lastName the last name keywords 2729 * @param screenName the screen name keywords 2730 * @param emailAddress the email address keywords 2731 * @param status the workflow status 2732 * @param params the finder parameters (optionally <code>null</code>). For 2733 more information see {@link 2734 com.liferay.portal.service.persistence.UserFinder}. 2735 * @param andSearch whether every field must match its keywords, or just 2736 one field. For example, "users with the first name 'bob' and 2737 last name 'smith'" vs "users with the first name 'bob' 2738 or the last name 'smith'". 2739 * @return the number of matching users 2740 * @throws SystemException if a system exception occurred 2741 */ 2742 @Override 2743 public int searchCount(long companyId, java.lang.String firstName, 2744 java.lang.String middleName, java.lang.String lastName, 2745 java.lang.String screenName, java.lang.String emailAddress, int status, 2746 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2747 boolean andSearch) 2748 throws com.liferay.portal.kernel.exception.SystemException { 2749 return _userLocalService.searchCount(companyId, firstName, middleName, 2750 lastName, screenName, emailAddress, status, params, andSearch); 2751 } 2752 2753 /** 2754 * Sends an email address verification to the user. 2755 * 2756 * @param user the verification email recipient 2757 * @param emailAddress the recipient's email address 2758 * @param serviceContext the service context to be applied. Must set the 2759 portal URL, main path, primary key of the layout, remote address, 2760 remote host, and agent for the user. 2761 * @throws PortalException if a portal exception occurred 2762 * @throws SystemException if a system exception occurred 2763 */ 2764 @Override 2765 public void sendEmailAddressVerification( 2766 com.liferay.portal.model.User user, java.lang.String emailAddress, 2767 com.liferay.portal.service.ServiceContext serviceContext) 2768 throws com.liferay.portal.kernel.exception.PortalException, 2769 com.liferay.portal.kernel.exception.SystemException { 2770 _userLocalService.sendEmailAddressVerification(user, emailAddress, 2771 serviceContext); 2772 } 2773 2774 /** 2775 * Sends the password email to the user with the email address. The content 2776 * of this email can be specified in <code>portal.properties</code> with the 2777 * <code>admin.email.password</code> keys. 2778 * 2779 * @param companyId the primary key of the user's company 2780 * @param emailAddress the user's email address 2781 * @param fromName the name of the individual that the email should be from 2782 * @param fromAddress the address of the individual that the email should 2783 be from 2784 * @param subject the email subject. If <code>null</code>, the subject 2785 specified in <code>portal.properties</code> will be used. 2786 * @param body the email body. If <code>null</code>, the body specified in 2787 <code>portal.properties</code> will be used. 2788 * @param serviceContext the service context to be applied 2789 * @throws PortalException if a user with the email address could not be 2790 found 2791 * @throws SystemException if a system exception occurred 2792 */ 2793 @Override 2794 public void sendPassword(long companyId, java.lang.String emailAddress, 2795 java.lang.String fromName, java.lang.String fromAddress, 2796 java.lang.String subject, java.lang.String body, 2797 com.liferay.portal.service.ServiceContext serviceContext) 2798 throws com.liferay.portal.kernel.exception.PortalException, 2799 com.liferay.portal.kernel.exception.SystemException { 2800 _userLocalService.sendPassword(companyId, emailAddress, fromName, 2801 fromAddress, subject, body, serviceContext); 2802 } 2803 2804 /** 2805 * Removes the users from the teams of a group. 2806 * 2807 * @param groupId the primary key of the group 2808 * @param userIds the primary keys of the users 2809 * @throws PortalException if a portal exception occurred 2810 * @throws SystemException if a system exception occurred 2811 */ 2812 @Override 2813 public void unsetGroupTeamsUsers(long groupId, long[] userIds) 2814 throws com.liferay.portal.kernel.exception.PortalException, 2815 com.liferay.portal.kernel.exception.SystemException { 2816 _userLocalService.unsetGroupTeamsUsers(groupId, userIds); 2817 } 2818 2819 /** 2820 * Removes the users from the group. 2821 * 2822 * @param groupId the primary key of the group 2823 * @param userIds the primary keys of the users 2824 * @param serviceContext the service context to be applied (optionally 2825 <code>null</code>) 2826 * @throws PortalException if a portal exception occurred 2827 * @throws SystemException if a system exception occurred 2828 */ 2829 @Override 2830 public void unsetGroupUsers(long groupId, long[] userIds, 2831 com.liferay.portal.service.ServiceContext serviceContext) 2832 throws com.liferay.portal.kernel.exception.PortalException, 2833 com.liferay.portal.kernel.exception.SystemException { 2834 _userLocalService.unsetGroupUsers(groupId, userIds, serviceContext); 2835 } 2836 2837 /** 2838 * Removes the users from the organization. 2839 * 2840 * @param organizationId the primary key of the organization 2841 * @param userIds the primary keys of the users 2842 * @throws PortalException if a portal exception occurred 2843 * @throws SystemException if a system exception occurred 2844 */ 2845 @Override 2846 public void unsetOrganizationUsers(long organizationId, long[] userIds) 2847 throws com.liferay.portal.kernel.exception.PortalException, 2848 com.liferay.portal.kernel.exception.SystemException { 2849 _userLocalService.unsetOrganizationUsers(organizationId, userIds); 2850 } 2851 2852 /** 2853 * Removes the users from the password policy. 2854 * 2855 * @param passwordPolicyId the primary key of the password policy 2856 * @param userIds the primary keys of the users 2857 * @throws SystemException if a system exception occurred 2858 */ 2859 @Override 2860 public void unsetPasswordPolicyUsers(long passwordPolicyId, long[] userIds) 2861 throws com.liferay.portal.kernel.exception.SystemException { 2862 _userLocalService.unsetPasswordPolicyUsers(passwordPolicyId, userIds); 2863 } 2864 2865 /** 2866 * Removes the users from the role. 2867 * 2868 * @param roleId the primary key of the role 2869 * @param users the users 2870 * @throws PortalException if a portal exception occurred 2871 * @throws SystemException if a system exception occurred 2872 */ 2873 @Override 2874 public void unsetRoleUsers(long roleId, 2875 java.util.List<com.liferay.portal.model.User> users) 2876 throws com.liferay.portal.kernel.exception.PortalException, 2877 com.liferay.portal.kernel.exception.SystemException { 2878 _userLocalService.unsetRoleUsers(roleId, users); 2879 } 2880 2881 /** 2882 * Removes the users from the role. 2883 * 2884 * @param roleId the primary key of the role 2885 * @param userIds the primary keys of the users 2886 * @throws PortalException if a portal exception occurred 2887 * @throws SystemException if a system exception occurred 2888 */ 2889 @Override 2890 public void unsetRoleUsers(long roleId, long[] userIds) 2891 throws com.liferay.portal.kernel.exception.PortalException, 2892 com.liferay.portal.kernel.exception.SystemException { 2893 _userLocalService.unsetRoleUsers(roleId, userIds); 2894 } 2895 2896 /** 2897 * Removes the users from the team. 2898 * 2899 * @param teamId the primary key of the team 2900 * @param userIds the primary keys of the users 2901 * @throws PortalException if a portal exception occurred 2902 * @throws SystemException if a system exception occurred 2903 */ 2904 @Override 2905 public void unsetTeamUsers(long teamId, long[] userIds) 2906 throws com.liferay.portal.kernel.exception.PortalException, 2907 com.liferay.portal.kernel.exception.SystemException { 2908 _userLocalService.unsetTeamUsers(teamId, userIds); 2909 } 2910 2911 /** 2912 * Removes the users from the user group. 2913 * 2914 * @param userGroupId the primary key of the user group 2915 * @param userIds the primary keys of the users 2916 * @throws PortalException if a portal exception occurred 2917 * @throws SystemException if a system exception occurred 2918 */ 2919 @Override 2920 public void unsetUserGroupUsers(long userGroupId, long[] userIds) 2921 throws com.liferay.portal.kernel.exception.PortalException, 2922 com.liferay.portal.kernel.exception.SystemException { 2923 _userLocalService.unsetUserGroupUsers(userGroupId, userIds); 2924 } 2925 2926 /** 2927 * Updates whether the user has agreed to the terms of use. 2928 * 2929 * @param userId the primary key of the user 2930 * @param agreedToTermsOfUse whether the user has agreet to the terms of 2931 use 2932 * @return the user 2933 * @throws PortalException if a user with the primary key could not be found 2934 * @throws SystemException if a system exception occurred 2935 */ 2936 @Override 2937 public com.liferay.portal.model.User updateAgreedToTermsOfUse(long userId, 2938 boolean agreedToTermsOfUse) 2939 throws com.liferay.portal.kernel.exception.PortalException, 2940 com.liferay.portal.kernel.exception.SystemException { 2941 return _userLocalService.updateAgreedToTermsOfUse(userId, 2942 agreedToTermsOfUse); 2943 } 2944 2945 /** 2946 * Updates the user's asset with the new asset categories and tag names, 2947 * removing and adding asset categories and tag names as necessary. 2948 * 2949 * @param userId the primary key of the user 2950 * @param user ID the primary key of the user 2951 * @param assetCategoryIds the primary key's of the new asset categories 2952 * @param assetTagNames the new asset tag names 2953 * @throws PortalException if a user with the primary key could not be found 2954 * @throws SystemException if a system exception occurred 2955 */ 2956 @Override 2957 public void updateAsset(long userId, com.liferay.portal.model.User user, 2958 long[] assetCategoryIds, java.lang.String[] assetTagNames) 2959 throws com.liferay.portal.kernel.exception.PortalException, 2960 com.liferay.portal.kernel.exception.SystemException { 2961 _userLocalService.updateAsset(userId, user, assetCategoryIds, 2962 assetTagNames); 2963 } 2964 2965 /** 2966 * Updates the user's creation date. 2967 * 2968 * @param userId the primary key of the user 2969 * @param createDate the new creation date 2970 * @return the user 2971 * @throws PortalException if a user with the primary key could not be found 2972 * @throws SystemException if a system exception occurred 2973 */ 2974 @Override 2975 public com.liferay.portal.model.User updateCreateDate(long userId, 2976 java.util.Date createDate) 2977 throws com.liferay.portal.kernel.exception.PortalException, 2978 com.liferay.portal.kernel.exception.SystemException { 2979 return _userLocalService.updateCreateDate(userId, createDate); 2980 } 2981 2982 /** 2983 * Updates the user's email address. 2984 * 2985 * @param userId the primary key of the user 2986 * @param password the user's password 2987 * @param emailAddress1 the user's new email address 2988 * @param emailAddress2 the user's new email address confirmation 2989 * @return the user 2990 * @throws PortalException if a user with the primary key could not be found 2991 * @throws SystemException if a system exception occurred 2992 */ 2993 @Override 2994 public com.liferay.portal.model.User updateEmailAddress(long userId, 2995 java.lang.String password, java.lang.String emailAddress1, 2996 java.lang.String emailAddress2) 2997 throws com.liferay.portal.kernel.exception.PortalException, 2998 com.liferay.portal.kernel.exception.SystemException { 2999 return _userLocalService.updateEmailAddress(userId, password, 3000 emailAddress1, emailAddress2); 3001 } 3002 3003 /** 3004 * Updates the user's email address or sends verification email. 3005 * 3006 * @param userId the primary key of the user 3007 * @param password the user's password 3008 * @param emailAddress1 the user's new email address 3009 * @param emailAddress2 the user's new email address confirmation 3010 * @param serviceContext the service context to be applied. Must set the 3011 portal URL, main path, primary key of the layout, remote address, 3012 remote host, and agent for the user. 3013 * @return the user 3014 * @throws PortalException if a user with the primary key could not be found 3015 * @throws SystemException if a system exception occurred 3016 */ 3017 @Override 3018 public com.liferay.portal.model.User updateEmailAddress(long userId, 3019 java.lang.String password, java.lang.String emailAddress1, 3020 java.lang.String emailAddress2, 3021 com.liferay.portal.service.ServiceContext serviceContext) 3022 throws com.liferay.portal.kernel.exception.PortalException, 3023 com.liferay.portal.kernel.exception.SystemException { 3024 return _userLocalService.updateEmailAddress(userId, password, 3025 emailAddress1, emailAddress2, serviceContext); 3026 } 3027 3028 /** 3029 * Updates whether the user has verified email address. 3030 * 3031 * @param userId the primary key of the user 3032 * @param emailAddressVerified whether the user has verified email address 3033 * @return the user 3034 * @throws PortalException if a user with the primary key could not be found 3035 * @throws SystemException if a system exception occurred 3036 */ 3037 @Override 3038 public com.liferay.portal.model.User updateEmailAddressVerified( 3039 long userId, boolean emailAddressVerified) 3040 throws com.liferay.portal.kernel.exception.PortalException, 3041 com.liferay.portal.kernel.exception.SystemException { 3042 return _userLocalService.updateEmailAddressVerified(userId, 3043 emailAddressVerified); 3044 } 3045 3046 /** 3047 * Updates the user's Facebook ID. 3048 * 3049 * @param userId the primary key of the user 3050 * @param facebookId the user's new Facebook ID 3051 * @return the user 3052 * @throws PortalException if a user with the primary key could not be found 3053 * @throws SystemException if a system exception occurred 3054 */ 3055 @Override 3056 public com.liferay.portal.model.User updateFacebookId(long userId, 3057 long facebookId) 3058 throws com.liferay.portal.kernel.exception.PortalException, 3059 com.liferay.portal.kernel.exception.SystemException { 3060 return _userLocalService.updateFacebookId(userId, facebookId); 3061 } 3062 3063 /** 3064 * Sets the groups the user is in, removing and adding groups as necessary. 3065 * 3066 * @param userId the primary key of the user 3067 * @param newGroupIds the primary keys of the groups 3068 * @param serviceContext the service context to be applied (optionally 3069 <code>null</code>) 3070 * @throws PortalException if a portal exception occurred 3071 * @throws SystemException if a system exception occurred 3072 */ 3073 @Override 3074 public void updateGroups(long userId, long[] newGroupIds, 3075 com.liferay.portal.service.ServiceContext serviceContext) 3076 throws com.liferay.portal.kernel.exception.PortalException, 3077 com.liferay.portal.kernel.exception.SystemException { 3078 _userLocalService.updateGroups(userId, newGroupIds, serviceContext); 3079 } 3080 3081 /** 3082 * Updates a user account that was automatically created when a guest user 3083 * participated in an action (e.g. posting a comment) and only provided his 3084 * name and email address. 3085 * 3086 * @param creatorUserId the primary key of the creator 3087 * @param companyId the primary key of the user's company 3088 * @param autoPassword whether a password should be automatically generated 3089 for the user 3090 * @param password1 the user's password 3091 * @param password2 the user's password confirmation 3092 * @param autoScreenName whether a screen name should be automatically 3093 generated for the user 3094 * @param screenName the user's screen name 3095 * @param emailAddress the user's email address 3096 * @param facebookId the user's facebook ID 3097 * @param openId the user's OpenID 3098 * @param locale the user's locale 3099 * @param firstName the user's first name 3100 * @param middleName the user's middle name 3101 * @param lastName the user's last name 3102 * @param prefixId the user's name prefix ID 3103 * @param suffixId the user's name suffix ID 3104 * @param male whether the user is male 3105 * @param birthdayMonth the user's birthday month (0-based, meaning 0 for 3106 January) 3107 * @param birthdayDay the user's birthday day 3108 * @param birthdayYear the user's birthday year 3109 * @param jobTitle the user's job title 3110 * @param updateUserInformation whether to update the user's information 3111 * @param sendEmail whether to send the user an email notification about 3112 their new account 3113 * @param serviceContext the service context to be applied (optionally 3114 <code>null</code>). Can set expando bridge attributes for the 3115 user. 3116 * @return the user 3117 * @throws PortalException if the user's information was invalid 3118 * @throws SystemException if a system exception occurred 3119 */ 3120 @Override 3121 public com.liferay.portal.model.User updateIncompleteUser( 3122 long creatorUserId, long companyId, boolean autoPassword, 3123 java.lang.String password1, java.lang.String password2, 3124 boolean autoScreenName, java.lang.String screenName, 3125 java.lang.String emailAddress, long facebookId, 3126 java.lang.String openId, java.util.Locale locale, 3127 java.lang.String firstName, java.lang.String middleName, 3128 java.lang.String lastName, int prefixId, int suffixId, boolean male, 3129 int birthdayMonth, int birthdayDay, int birthdayYear, 3130 java.lang.String jobTitle, boolean updateUserInformation, 3131 boolean sendEmail, 3132 com.liferay.portal.service.ServiceContext serviceContext) 3133 throws com.liferay.portal.kernel.exception.PortalException, 3134 com.liferay.portal.kernel.exception.SystemException { 3135 return _userLocalService.updateIncompleteUser(creatorUserId, companyId, 3136 autoPassword, password1, password2, autoScreenName, screenName, 3137 emailAddress, facebookId, openId, locale, firstName, middleName, 3138 lastName, prefixId, suffixId, male, birthdayMonth, birthdayDay, 3139 birthdayYear, jobTitle, updateUserInformation, sendEmail, 3140 serviceContext); 3141 } 3142 3143 /** 3144 * Updates the user's job title. 3145 * 3146 * @param userId the primary key of the user 3147 * @param jobTitle the user's job title 3148 * @return the user 3149 * @throws PortalException if a user with the primary key could not be found 3150 or if a contact could not be found matching the user's contact ID 3151 * @throws SystemException if a system exception occurred 3152 */ 3153 @Override 3154 public com.liferay.portal.model.User updateJobTitle(long userId, 3155 java.lang.String jobTitle) 3156 throws com.liferay.portal.kernel.exception.PortalException, 3157 com.liferay.portal.kernel.exception.SystemException { 3158 return _userLocalService.updateJobTitle(userId, jobTitle); 3159 } 3160 3161 /** 3162 * Updates the user's last login with the current time and the IP address. 3163 * 3164 * @param userId the primary key of the user 3165 * @param loginIP the IP address the user logged in from 3166 * @return the user 3167 * @throws PortalException if a user with the primary key could not be found 3168 * @throws SystemException if a system exception occurred 3169 */ 3170 @Override 3171 public com.liferay.portal.model.User updateLastLogin(long userId, 3172 java.lang.String loginIP) 3173 throws com.liferay.portal.kernel.exception.PortalException, 3174 com.liferay.portal.kernel.exception.SystemException { 3175 return _userLocalService.updateLastLogin(userId, loginIP); 3176 } 3177 3178 /** 3179 * Updates whether the user is locked out from logging in. 3180 * 3181 * @param user the user 3182 * @param lockout whether the user is locked out 3183 * @return the user 3184 * @throws PortalException if a portal exception occurred 3185 * @throws SystemException if a system exception occurred 3186 */ 3187 @Override 3188 public com.liferay.portal.model.User updateLockout( 3189 com.liferay.portal.model.User user, boolean lockout) 3190 throws com.liferay.portal.kernel.exception.PortalException, 3191 com.liferay.portal.kernel.exception.SystemException { 3192 return _userLocalService.updateLockout(user, lockout); 3193 } 3194 3195 /** 3196 * Updates whether the user is locked out from logging in. 3197 * 3198 * @param companyId the primary key of the user's company 3199 * @param emailAddress the user's email address 3200 * @param lockout whether the user is locked out 3201 * @return the user 3202 * @throws PortalException if a user with the email address could not be 3203 found 3204 * @throws SystemException if a system exception occurred 3205 */ 3206 @Override 3207 public com.liferay.portal.model.User updateLockoutByEmailAddress( 3208 long companyId, java.lang.String emailAddress, boolean lockout) 3209 throws com.liferay.portal.kernel.exception.PortalException, 3210 com.liferay.portal.kernel.exception.SystemException { 3211 return _userLocalService.updateLockoutByEmailAddress(companyId, 3212 emailAddress, lockout); 3213 } 3214 3215 /** 3216 * Updates whether the user is locked out from logging in. 3217 * 3218 * @param userId the primary key of the user 3219 * @param lockout whether the user is locked out 3220 * @return the user 3221 * @throws PortalException if a user with the primary key could not be found 3222 * @throws SystemException if a system exception occurred 3223 */ 3224 @Override 3225 public com.liferay.portal.model.User updateLockoutById(long userId, 3226 boolean lockout) 3227 throws com.liferay.portal.kernel.exception.PortalException, 3228 com.liferay.portal.kernel.exception.SystemException { 3229 return _userLocalService.updateLockoutById(userId, lockout); 3230 } 3231 3232 /** 3233 * Updates whether the user is locked out from logging in. 3234 * 3235 * @param companyId the primary key of the user's company 3236 * @param screenName the user's screen name 3237 * @param lockout whether the user is locked out 3238 * @return the user 3239 * @throws PortalException if a user with the screen name could not be found 3240 * @throws SystemException if a system exception occurred 3241 */ 3242 @Override 3243 public com.liferay.portal.model.User updateLockoutByScreenName( 3244 long companyId, java.lang.String screenName, boolean lockout) 3245 throws com.liferay.portal.kernel.exception.PortalException, 3246 com.liferay.portal.kernel.exception.SystemException { 3247 return _userLocalService.updateLockoutByScreenName(companyId, 3248 screenName, lockout); 3249 } 3250 3251 /** 3252 * Updates the user's modified date. 3253 * 3254 * @param userId the primary key of the user 3255 * @param modifiedDate the new modified date 3256 * @return the user 3257 * @throws PortalException if a user with the primary key could not be found 3258 * @throws SystemException if a system exception occurred 3259 */ 3260 @Override 3261 public com.liferay.portal.model.User updateModifiedDate(long userId, 3262 java.util.Date modifiedDate) 3263 throws com.liferay.portal.kernel.exception.PortalException, 3264 com.liferay.portal.kernel.exception.SystemException { 3265 return _userLocalService.updateModifiedDate(userId, modifiedDate); 3266 } 3267 3268 /** 3269 * Updates the user's OpenID. 3270 * 3271 * @param userId the primary key of the user 3272 * @param openId the new OpenID 3273 * @return the user 3274 * @throws PortalException if a user with the primary key could not be found 3275 * @throws SystemException if a system exception occurred 3276 */ 3277 @Override 3278 public com.liferay.portal.model.User updateOpenId(long userId, 3279 java.lang.String openId) 3280 throws com.liferay.portal.kernel.exception.PortalException, 3281 com.liferay.portal.kernel.exception.SystemException { 3282 return _userLocalService.updateOpenId(userId, openId); 3283 } 3284 3285 /** 3286 * Sets the organizations that the user is in, removing and adding 3287 * organizations as necessary. 3288 * 3289 * @param userId the primary key of the user 3290 * @param newOrganizationIds the primary keys of the organizations 3291 * @param serviceContext the service context to be applied. Must set 3292 whether user indexing is enabled. 3293 * @throws PortalException if a user with the primary key could not be found 3294 * @throws SystemException if a system exception occurred 3295 */ 3296 @Override 3297 public void updateOrganizations(long userId, long[] newOrganizationIds, 3298 com.liferay.portal.service.ServiceContext serviceContext) 3299 throws com.liferay.portal.kernel.exception.PortalException, 3300 com.liferay.portal.kernel.exception.SystemException { 3301 _userLocalService.updateOrganizations(userId, newOrganizationIds, 3302 serviceContext); 3303 } 3304 3305 /** 3306 * Updates the user's password without tracking or validation of the change. 3307 * 3308 * @param userId the primary key of the user 3309 * @param password1 the user's new password 3310 * @param password2 the user's new password confirmation 3311 * @param passwordReset whether the user should be asked to reset their 3312 password the next time they log in 3313 * @return the user 3314 * @throws PortalException if a user with the primary key could not be found 3315 * @throws SystemException if a system exception occurred 3316 */ 3317 @Override 3318 public com.liferay.portal.model.User updatePassword(long userId, 3319 java.lang.String password1, java.lang.String password2, 3320 boolean passwordReset) 3321 throws com.liferay.portal.kernel.exception.PortalException, 3322 com.liferay.portal.kernel.exception.SystemException { 3323 return _userLocalService.updatePassword(userId, password1, password2, 3324 passwordReset); 3325 } 3326 3327 /** 3328 * Updates the user's password, optionally with tracking and validation of 3329 * the change. 3330 * 3331 * @param userId the primary key of the user 3332 * @param password1 the user's new password 3333 * @param password2 the user's new password confirmation 3334 * @param passwordReset whether the user should be asked to reset their 3335 password the next time they login 3336 * @param silentUpdate whether the password should be updated without being 3337 tracked, or validated. Primarily used for password imports. 3338 * @return the user 3339 * @throws PortalException if a user with the primary key could not be found 3340 * @throws SystemException if a system exception occurred 3341 */ 3342 @Override 3343 public com.liferay.portal.model.User updatePassword(long userId, 3344 java.lang.String password1, java.lang.String password2, 3345 boolean passwordReset, boolean silentUpdate) 3346 throws com.liferay.portal.kernel.exception.PortalException, 3347 com.liferay.portal.kernel.exception.SystemException { 3348 return _userLocalService.updatePassword(userId, password1, password2, 3349 passwordReset, silentUpdate); 3350 } 3351 3352 /** 3353 * Updates the user's password with manually input information. This method 3354 * should only be used when performing maintenance. 3355 * 3356 * @param userId the primary key of the user 3357 * @param password the user's new password 3358 * @param passwordEncrypted the user's new encrypted password 3359 * @param passwordReset whether the user should be asked to reset their 3360 password the next time they login 3361 * @param passwordModifiedDate the new password modified date 3362 * @return the user 3363 * @throws PortalException if a user with the primary key could not be found 3364 * @throws SystemException if a system exception occurred 3365 */ 3366 @Override 3367 public com.liferay.portal.model.User updatePasswordManually(long userId, 3368 java.lang.String password, boolean passwordEncrypted, 3369 boolean passwordReset, java.util.Date passwordModifiedDate) 3370 throws com.liferay.portal.kernel.exception.PortalException, 3371 com.liferay.portal.kernel.exception.SystemException { 3372 return _userLocalService.updatePasswordManually(userId, password, 3373 passwordEncrypted, passwordReset, passwordModifiedDate); 3374 } 3375 3376 /** 3377 * Updates whether the user should be asked to reset their password the next 3378 * time they login. 3379 * 3380 * @param userId the primary key of the user 3381 * @param passwordReset whether the user should be asked to reset their 3382 password the next time they login 3383 * @return the user 3384 * @throws PortalException if a user with the primary key could not be found 3385 * @throws SystemException if a system exception occurred 3386 */ 3387 @Override 3388 public com.liferay.portal.model.User updatePasswordReset(long userId, 3389 boolean passwordReset) 3390 throws com.liferay.portal.kernel.exception.PortalException, 3391 com.liferay.portal.kernel.exception.SystemException { 3392 return _userLocalService.updatePasswordReset(userId, passwordReset); 3393 } 3394 3395 /** 3396 * Updates the user's portrait image. 3397 * 3398 * @param userId the primary key of the user 3399 * @param bytes the new portrait image data 3400 * @return the user 3401 * @throws PortalException if a user with the primary key could not be found 3402 or if the new portrait was invalid 3403 * @throws SystemException if a system exception occurred 3404 */ 3405 @Override 3406 public com.liferay.portal.model.User updatePortrait(long userId, 3407 byte[] bytes) 3408 throws com.liferay.portal.kernel.exception.PortalException, 3409 com.liferay.portal.kernel.exception.SystemException { 3410 return _userLocalService.updatePortrait(userId, bytes); 3411 } 3412 3413 /** 3414 * Updates the user's password reset question and answer. 3415 * 3416 * @param userId the primary key of the user 3417 * @param question the user's new password reset question 3418 * @param answer the user's new password reset answer 3419 * @return the user 3420 * @throws PortalException if a user with the primary key could not be found 3421 or if the new question or answer were invalid 3422 * @throws SystemException if a system exception occurred 3423 */ 3424 @Override 3425 public com.liferay.portal.model.User updateReminderQuery(long userId, 3426 java.lang.String question, java.lang.String answer) 3427 throws com.liferay.portal.kernel.exception.PortalException, 3428 com.liferay.portal.kernel.exception.SystemException { 3429 return _userLocalService.updateReminderQuery(userId, question, answer); 3430 } 3431 3432 /** 3433 * Updates the user's screen name. 3434 * 3435 * @param userId the primary key of the user 3436 * @param screenName the user's new screen name 3437 * @return the user 3438 * @throws PortalException if a user with the primary key could not be found 3439 or if the new screen name was invalid 3440 * @throws SystemException if a system exception occurred 3441 */ 3442 @Override 3443 public com.liferay.portal.model.User updateScreenName(long userId, 3444 java.lang.String screenName) 3445 throws com.liferay.portal.kernel.exception.PortalException, 3446 com.liferay.portal.kernel.exception.SystemException { 3447 return _userLocalService.updateScreenName(userId, screenName); 3448 } 3449 3450 /** 3451 * Updates the user's workflow status. 3452 * 3453 * @param userId the primary key of the user 3454 * @param status the user's new workflow status 3455 * @return the user 3456 * @throws PortalException if a user with the primary key could not be 3457 found 3458 * @throws SystemException if a system exception occurred 3459 * @deprecated As of 7.0.0, replaced by {@link #updateStatus(long, int, 3460 ServiceContext)} 3461 */ 3462 @Override 3463 public com.liferay.portal.model.User updateStatus(long userId, int status) 3464 throws com.liferay.portal.kernel.exception.PortalException, 3465 com.liferay.portal.kernel.exception.SystemException { 3466 return _userLocalService.updateStatus(userId, status); 3467 } 3468 3469 /** 3470 * Updates the user's workflow status. 3471 * 3472 * @param userId the primary key of the user 3473 * @param status the user's new workflow status 3474 * @param serviceContext the service context to be applied. You can specify 3475 an unencrypted custom password (used by an LDAP listener) for the 3476 user via attribute <code>passwordUnencrypted</code>. 3477 * @return the user 3478 * @throws PortalException if a user with the primary key could not be found 3479 * @throws SystemException if a system exception occurred 3480 */ 3481 @Override 3482 public com.liferay.portal.model.User updateStatus(long userId, int status, 3483 com.liferay.portal.service.ServiceContext serviceContext) 3484 throws com.liferay.portal.kernel.exception.PortalException, 3485 com.liferay.portal.kernel.exception.SystemException { 3486 return _userLocalService.updateStatus(userId, status, serviceContext); 3487 } 3488 3489 /** 3490 * Updates the user. 3491 * 3492 * @param userId the primary key of the user 3493 * @param oldPassword the user's old password 3494 * @param newPassword1 the user's new password (optionally 3495 <code>null</code>) 3496 * @param newPassword2 the user's new password confirmation (optionally 3497 <code>null</code>) 3498 * @param passwordReset whether the user should be asked to reset their 3499 password the next time they login 3500 * @param reminderQueryQuestion the user's new password reset question 3501 * @param reminderQueryAnswer the user's new password reset answer 3502 * @param screenName the user's new screen name 3503 * @param emailAddress the user's new email address 3504 * @param facebookId the user's new Facebook ID 3505 * @param openId the user's new OpenID 3506 * @param languageId the user's new language ID 3507 * @param timeZoneId the user's new time zone ID 3508 * @param greeting the user's new greeting 3509 * @param comments the user's new comments 3510 * @param firstName the user's new first name 3511 * @param middleName the user's new middle name 3512 * @param lastName the user's new last name 3513 * @param prefixId the user's new name prefix ID 3514 * @param suffixId the user's new name suffix ID 3515 * @param male whether user is male 3516 * @param birthdayMonth the user's new birthday month (0-based, meaning 0 3517 for January) 3518 * @param birthdayDay the user's new birthday day 3519 * @param birthdayYear the user's birthday year 3520 * @param smsSn the user's new SMS screen name 3521 * @param aimSn the user's new AIM screen name 3522 * @param facebookSn the user's new Facebook screen name 3523 * @param icqSn the user's new ICQ screen name 3524 * @param jabberSn the user's new Jabber screen name 3525 * @param msnSn the user's new MSN screen name 3526 * @param mySpaceSn the user's new MySpace screen name 3527 * @param skypeSn the user's new Skype screen name 3528 * @param twitterSn the user's new Twitter screen name 3529 * @param ymSn the user's new Yahoo! Messenger screen name 3530 * @param jobTitle the user's new job title 3531 * @param groupIds the primary keys of the user's groups 3532 * @param organizationIds the primary keys of the user's organizations 3533 * @param roleIds the primary keys of the user's roles 3534 * @param userGroupRoles the user user's group roles 3535 * @param userGroupIds the primary keys of the user's user groups 3536 * @param serviceContext the service context to be applied (optionally 3537 <code>null</code>). Can set the UUID (with the <code>uuid</code> 3538 attribute), asset category IDs, asset tag names, and expando 3539 bridge attributes for the user. 3540 * @return the user 3541 * @throws PortalException if a user with the primary key could not be found 3542 or if the new information was invalid 3543 * @throws SystemException if a system exception occurred 3544 */ 3545 @Override 3546 public com.liferay.portal.model.User updateUser(long userId, 3547 java.lang.String oldPassword, java.lang.String newPassword1, 3548 java.lang.String newPassword2, boolean passwordReset, 3549 java.lang.String reminderQueryQuestion, 3550 java.lang.String reminderQueryAnswer, java.lang.String screenName, 3551 java.lang.String emailAddress, long facebookId, 3552 java.lang.String openId, java.lang.String languageId, 3553 java.lang.String timeZoneId, java.lang.String greeting, 3554 java.lang.String comments, java.lang.String firstName, 3555 java.lang.String middleName, java.lang.String lastName, int prefixId, 3556 int suffixId, boolean male, int birthdayMonth, int birthdayDay, 3557 int birthdayYear, java.lang.String smsSn, java.lang.String aimSn, 3558 java.lang.String facebookSn, java.lang.String icqSn, 3559 java.lang.String jabberSn, java.lang.String msnSn, 3560 java.lang.String mySpaceSn, java.lang.String skypeSn, 3561 java.lang.String twitterSn, java.lang.String ymSn, 3562 java.lang.String jobTitle, long[] groupIds, long[] organizationIds, 3563 long[] roleIds, 3564 java.util.List<com.liferay.portal.model.UserGroupRole> userGroupRoles, 3565 long[] userGroupIds, 3566 com.liferay.portal.service.ServiceContext serviceContext) 3567 throws com.liferay.portal.kernel.exception.PortalException, 3568 com.liferay.portal.kernel.exception.SystemException { 3569 return _userLocalService.updateUser(userId, oldPassword, newPassword1, 3570 newPassword2, passwordReset, reminderQueryQuestion, 3571 reminderQueryAnswer, screenName, emailAddress, facebookId, openId, 3572 languageId, timeZoneId, greeting, comments, firstName, middleName, 3573 lastName, prefixId, suffixId, male, birthdayMonth, birthdayDay, 3574 birthdayYear, smsSn, aimSn, facebookSn, icqSn, jabberSn, msnSn, 3575 mySpaceSn, skypeSn, twitterSn, ymSn, jobTitle, groupIds, 3576 organizationIds, roleIds, userGroupRoles, userGroupIds, 3577 serviceContext); 3578 } 3579 3580 /** 3581 * Verifies the email address of the ticket. 3582 * 3583 * @param ticketKey the ticket key 3584 * @throws PortalException if a ticket matching the ticket key could not be 3585 found, if the ticket has expired, if the ticket is an email 3586 address ticket, or if the email address is invalid 3587 * @throws SystemException if a system exception occurred 3588 */ 3589 @Override 3590 public void verifyEmailAddress(java.lang.String ticketKey) 3591 throws com.liferay.portal.kernel.exception.PortalException, 3592 com.liferay.portal.kernel.exception.SystemException { 3593 _userLocalService.verifyEmailAddress(ticketKey); 3594 } 3595 3596 /** 3597 * @deprecated As of 6.1.0, replaced by {@link #getWrappedService} 3598 */ 3599 public UserLocalService getWrappedUserLocalService() { 3600 return _userLocalService; 3601 } 3602 3603 /** 3604 * @deprecated As of 6.1.0, replaced by {@link #setWrappedService} 3605 */ 3606 public void setWrappedUserLocalService(UserLocalService userLocalService) { 3607 _userLocalService = userLocalService; 3608 } 3609 3610 @Override 3611 public UserLocalService getWrappedService() { 3612 return _userLocalService; 3613 } 3614 3615 @Override 3616 public void setWrappedService(UserLocalService userLocalService) { 3617 _userLocalService = userLocalService; 3618 } 3619 3620 private UserLocalService _userLocalService; 3621 }