001 /** 002 * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved. 003 * 004 * This library is free software; you can redistribute it and/or modify it under 005 * the terms of the GNU Lesser General Public License as published by the Free 006 * Software Foundation; either version 2.1 of the License, or (at your option) 007 * any later version. 008 * 009 * This library is distributed in the hope that it will be useful, but WITHOUT 010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 011 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 012 * details. 013 */ 014 015 package com.liferay.portal.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 email address. 1703 * 1704 * @param companyId the primary key of the user's company 1705 * @param emailAddress the user's email address 1706 * @return the user with the email address, or <code>null</code> if a user 1707 with the email address could not be found 1708 * @throws SystemException if a system exception occurred 1709 */ 1710 @Override 1711 public com.liferay.portal.model.User fetchUserByEmailAddress( 1712 long companyId, java.lang.String emailAddress) 1713 throws com.liferay.portal.kernel.exception.SystemException { 1714 return _userLocalService.fetchUserByEmailAddress(companyId, emailAddress); 1715 } 1716 1717 /** 1718 * Returns the user with the Facebook ID. 1719 * 1720 * @param companyId the primary key of the user's company 1721 * @param facebookId the user's Facebook ID 1722 * @return the user with the Facebook ID, or <code>null</code> if a user 1723 with the Facebook ID could not be found 1724 * @throws SystemException if a system exception occurred 1725 */ 1726 @Override 1727 public com.liferay.portal.model.User fetchUserByFacebookId(long companyId, 1728 long facebookId) 1729 throws com.liferay.portal.kernel.exception.SystemException { 1730 return _userLocalService.fetchUserByFacebookId(companyId, facebookId); 1731 } 1732 1733 /** 1734 * Returns the user with the primary key. 1735 * 1736 * @param userId the primary key of the user 1737 * @return the user with the primary key, or <code>null</code> if a user 1738 with the primary key could not be found 1739 * @throws SystemException if a system exception occurred 1740 */ 1741 @Override 1742 public com.liferay.portal.model.User fetchUserById(long userId) 1743 throws com.liferay.portal.kernel.exception.SystemException { 1744 return _userLocalService.fetchUserById(userId); 1745 } 1746 1747 /** 1748 * Returns the user with the OpenID. 1749 * 1750 * @param companyId the primary key of the user's company 1751 * @param openId the user's OpenID 1752 * @return the user with the OpenID, or <code>null</code> if a user with the 1753 OpenID could not be found 1754 * @throws SystemException if a system exception occurred 1755 */ 1756 @Override 1757 public com.liferay.portal.model.User fetchUserByOpenId(long companyId, 1758 java.lang.String openId) 1759 throws com.liferay.portal.kernel.exception.SystemException { 1760 return _userLocalService.fetchUserByOpenId(companyId, openId); 1761 } 1762 1763 /** 1764 * Returns the user with the screen name. 1765 * 1766 * @param companyId the primary key of the user's company 1767 * @param screenName the user's screen name 1768 * @return the user with the screen name, or <code>null</code> if a user 1769 with the screen name could not be found 1770 * @throws SystemException if a system exception occurred 1771 */ 1772 @Override 1773 public com.liferay.portal.model.User fetchUserByScreenName(long companyId, 1774 java.lang.String screenName) 1775 throws com.liferay.portal.kernel.exception.SystemException { 1776 return _userLocalService.fetchUserByScreenName(companyId, screenName); 1777 } 1778 1779 /** 1780 * Returns a range of all the users belonging to the company. 1781 * 1782 * <p> 1783 * Useful when paginating results. Returns a maximum of <code>end - 1784 * start</code> instances. <code>start</code> and <code>end</code> are not 1785 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1786 * refers to the first result in the set. Setting both <code>start</code> 1787 * and <code>end</code> to {@link 1788 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1789 * result set. 1790 * </p> 1791 * 1792 * @param companyId the primary key of the company 1793 * @param start the lower bound of the range of users 1794 * @param end the upper bound of the range of users (not inclusive) 1795 * @return the range of users belonging to the company 1796 * @throws SystemException if a system exception occurred 1797 */ 1798 @Override 1799 public java.util.List<com.liferay.portal.model.User> getCompanyUsers( 1800 long companyId, int start, int end) 1801 throws com.liferay.portal.kernel.exception.SystemException { 1802 return _userLocalService.getCompanyUsers(companyId, start, end); 1803 } 1804 1805 /** 1806 * Returns the number of users belonging to the company. 1807 * 1808 * @param companyId the primary key of the company 1809 * @return the number of users belonging to the company 1810 * @throws SystemException if a system exception occurred 1811 */ 1812 @Override 1813 public int getCompanyUsersCount(long companyId) 1814 throws com.liferay.portal.kernel.exception.SystemException { 1815 return _userLocalService.getCompanyUsersCount(companyId); 1816 } 1817 1818 /** 1819 * Returns the default user for the company. 1820 * 1821 * @param companyId the primary key of the company 1822 * @return the default user for the company 1823 * @throws PortalException if a default user for the company could not be 1824 found 1825 * @throws SystemException if a system exception occurred 1826 */ 1827 @Override 1828 public com.liferay.portal.model.User getDefaultUser(long companyId) 1829 throws com.liferay.portal.kernel.exception.PortalException, 1830 com.liferay.portal.kernel.exception.SystemException { 1831 return _userLocalService.getDefaultUser(companyId); 1832 } 1833 1834 /** 1835 * Returns the primary key of the default user for the company. 1836 * 1837 * @param companyId the primary key of the company 1838 * @return the primary key of the default user for the company 1839 * @throws PortalException if a default user for the company could not be 1840 found 1841 * @throws SystemException if a system exception occurred 1842 */ 1843 @Override 1844 public long getDefaultUserId(long companyId) 1845 throws com.liferay.portal.kernel.exception.PortalException, 1846 com.liferay.portal.kernel.exception.SystemException { 1847 return _userLocalService.getDefaultUserId(companyId); 1848 } 1849 1850 /** 1851 * Returns the primary keys of all the users belonging to the group. 1852 * 1853 * @param groupId the primary key of the group 1854 * @return the primary keys of the users belonging to the group 1855 * @throws SystemException if a system exception occurred 1856 */ 1857 @Override 1858 public long[] getGroupUserIds(long groupId) 1859 throws com.liferay.portal.kernel.exception.SystemException { 1860 return _userLocalService.getGroupUserIds(groupId); 1861 } 1862 1863 /** 1864 * Returns the number of users with the status belonging to the group. 1865 * 1866 * @param groupId the primary key of the group 1867 * @param status the workflow status 1868 * @return the number of users with the status belonging to the group 1869 * @throws PortalException if a group with the primary key could not be 1870 found 1871 * @throws SystemException if a system exception occurred 1872 */ 1873 @Override 1874 public int getGroupUsersCount(long groupId, int status) 1875 throws com.liferay.portal.kernel.exception.PortalException, 1876 com.liferay.portal.kernel.exception.SystemException { 1877 return _userLocalService.getGroupUsersCount(groupId, status); 1878 } 1879 1880 @Override 1881 public java.util.List<com.liferay.portal.model.User> getInheritedRoleUsers( 1882 long roleId, int start, int end, 1883 com.liferay.portal.kernel.util.OrderByComparator obc) 1884 throws com.liferay.portal.kernel.exception.PortalException, 1885 com.liferay.portal.kernel.exception.SystemException { 1886 return _userLocalService.getInheritedRoleUsers(roleId, start, end, obc); 1887 } 1888 1889 /** 1890 * Returns all the users who have not had any announcements of the type 1891 * delivered, excluding the default user. 1892 * 1893 * @param type the type of announcement 1894 * @return the users who have not had any annoucements of the type delivered 1895 * @throws SystemException if a system exception occurred 1896 */ 1897 @Override 1898 public java.util.List<com.liferay.portal.model.User> getNoAnnouncementsDeliveries( 1899 java.lang.String type) 1900 throws com.liferay.portal.kernel.exception.SystemException { 1901 return _userLocalService.getNoAnnouncementsDeliveries(type); 1902 } 1903 1904 /** 1905 * Returns all the users who do not have any contacts. 1906 * 1907 * @return the users who do not have any contacts 1908 * @throws SystemException if a system exception occurred 1909 */ 1910 @Override 1911 public java.util.List<com.liferay.portal.model.User> getNoContacts() 1912 throws com.liferay.portal.kernel.exception.SystemException { 1913 return _userLocalService.getNoContacts(); 1914 } 1915 1916 /** 1917 * Returns all the users who do not belong to any groups, excluding the 1918 * default user. 1919 * 1920 * @return the users who do not belong to any groups 1921 * @throws SystemException if a system exception occurred 1922 */ 1923 @Override 1924 public java.util.List<com.liferay.portal.model.User> getNoGroups() 1925 throws com.liferay.portal.kernel.exception.SystemException { 1926 return _userLocalService.getNoGroups(); 1927 } 1928 1929 /** 1930 * Returns the primary keys of all the users belonging to the organization. 1931 * 1932 * @param organizationId the primary key of the organization 1933 * @return the primary keys of the users belonging to the organization 1934 * @throws SystemException if a system exception occurred 1935 */ 1936 @Override 1937 public long[] getOrganizationUserIds(long organizationId) 1938 throws com.liferay.portal.kernel.exception.SystemException { 1939 return _userLocalService.getOrganizationUserIds(organizationId); 1940 } 1941 1942 /** 1943 * Returns the number of users with the status belonging to the 1944 * organization. 1945 * 1946 * @param organizationId the primary key of the organization 1947 * @param status the workflow status 1948 * @return the number of users with the status belonging to the organization 1949 * @throws PortalException if an organization with the primary key could not 1950 be found 1951 * @throws SystemException if a system exception occurred 1952 */ 1953 @Override 1954 public int getOrganizationUsersCount(long organizationId, int status) 1955 throws com.liferay.portal.kernel.exception.PortalException, 1956 com.liferay.portal.kernel.exception.SystemException { 1957 return _userLocalService.getOrganizationUsersCount(organizationId, 1958 status); 1959 } 1960 1961 /** 1962 * Returns the primary keys of all the users belonging to the role. 1963 * 1964 * @param roleId the primary key of the role 1965 * @return the primary keys of the users belonging to the role 1966 * @throws SystemException if a system exception occurred 1967 */ 1968 @Override 1969 public long[] getRoleUserIds(long roleId) 1970 throws com.liferay.portal.kernel.exception.SystemException { 1971 return _userLocalService.getRoleUserIds(roleId); 1972 } 1973 1974 /** 1975 * Returns the number of users with the status belonging to the role. 1976 * 1977 * @param roleId the primary key of the role 1978 * @param status the workflow status 1979 * @return the number of users with the status belonging to the role 1980 * @throws PortalException if an role with the primary key could not be 1981 found 1982 * @throws SystemException if a system exception occurred 1983 */ 1984 @Override 1985 public int getRoleUsersCount(long roleId, int status) 1986 throws com.liferay.portal.kernel.exception.PortalException, 1987 com.liferay.portal.kernel.exception.SystemException { 1988 return _userLocalService.getRoleUsersCount(roleId, status); 1989 } 1990 1991 /** 1992 * Returns an ordered range of all the users with a social relation of the 1993 * type with the user. 1994 * 1995 * <p> 1996 * Useful when paginating results. Returns a maximum of <code>end - 1997 * start</code> instances. <code>start</code> and <code>end</code> are not 1998 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1999 * refers to the first result in the set. Setting both <code>start</code> 2000 * and <code>end</code> to {@link 2001 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 2002 * result set. 2003 * </p> 2004 * 2005 * @param userId the primary key of the user 2006 * @param type the type of social relation. The possible types can be found 2007 in {@link 2008 com.liferay.portlet.social.model.SocialRelationConstants}. 2009 * @param start the lower bound of the range of users 2010 * @param end the upper bound of the range of users (not inclusive) 2011 * @param obc the comparator to order the users by (optionally 2012 <code>null</code>) 2013 * @return the ordered range of users with a social relation of the type 2014 with the user 2015 * @throws PortalException if a user with the primary key could not be found 2016 * @throws SystemException if a system exception occurred 2017 */ 2018 @Override 2019 public java.util.List<com.liferay.portal.model.User> getSocialUsers( 2020 long userId, int type, int start, int end, 2021 com.liferay.portal.kernel.util.OrderByComparator obc) 2022 throws com.liferay.portal.kernel.exception.PortalException, 2023 com.liferay.portal.kernel.exception.SystemException { 2024 return _userLocalService.getSocialUsers(userId, type, start, end, obc); 2025 } 2026 2027 /** 2028 * Returns an ordered range of all the users with a social relation with the 2029 * user. 2030 * 2031 * <p> 2032 * Useful when paginating results. Returns a maximum of <code>end - 2033 * start</code> instances. <code>start</code> and <code>end</code> are not 2034 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2035 * refers to the first result in the set. Setting both <code>start</code> 2036 * and <code>end</code> to {@link 2037 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 2038 * result set. 2039 * </p> 2040 * 2041 * @param userId the primary key of the user 2042 * @param start the lower bound of the range of users 2043 * @param end the upper bound of the range of users (not inclusive) 2044 * @param obc the comparator to order the users by (optionally 2045 <code>null</code>) 2046 * @return the ordered range of users with a social relation with the user 2047 * @throws PortalException if a user with the primary key could not be found 2048 * @throws SystemException if a system exception occurred 2049 */ 2050 @Override 2051 public java.util.List<com.liferay.portal.model.User> getSocialUsers( 2052 long userId, int start, int end, 2053 com.liferay.portal.kernel.util.OrderByComparator obc) 2054 throws com.liferay.portal.kernel.exception.PortalException, 2055 com.liferay.portal.kernel.exception.SystemException { 2056 return _userLocalService.getSocialUsers(userId, start, end, obc); 2057 } 2058 2059 /** 2060 * Returns an ordered range of all the users with a mutual social relation 2061 * of the type with both of the given users. 2062 * 2063 * <p> 2064 * Useful when paginating results. Returns a maximum of <code>end - 2065 * start</code> instances. <code>start</code> and <code>end</code> are not 2066 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2067 * refers to the first result in the set. Setting both <code>start</code> 2068 * and <code>end</code> to {@link 2069 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 2070 * result set. 2071 * </p> 2072 * 2073 * @param userId1 the primary key of the first user 2074 * @param userId2 the primary key of the second user 2075 * @param type the type of social relation. The possible types can be found 2076 in {@link 2077 com.liferay.portlet.social.model.SocialRelationConstants}. 2078 * @param start the lower bound of the range of users 2079 * @param end the upper bound of the range of users (not inclusive) 2080 * @param obc the comparator to order the users by (optionally 2081 <code>null</code>) 2082 * @return the ordered range of users with a mutual social relation of the 2083 type with the user 2084 * @throws PortalException if a user with the primary key could not be found 2085 * @throws SystemException if a system exception occurred 2086 */ 2087 @Override 2088 public java.util.List<com.liferay.portal.model.User> getSocialUsers( 2089 long userId1, long userId2, int type, int start, int end, 2090 com.liferay.portal.kernel.util.OrderByComparator obc) 2091 throws com.liferay.portal.kernel.exception.PortalException, 2092 com.liferay.portal.kernel.exception.SystemException { 2093 return _userLocalService.getSocialUsers(userId1, userId2, type, start, 2094 end, obc); 2095 } 2096 2097 /** 2098 * Returns an ordered range of all the users with a mutual social relation 2099 * with both of the given users. 2100 * 2101 * <p> 2102 * Useful when paginating results. Returns a maximum of <code>end - 2103 * start</code> instances. <code>start</code> and <code>end</code> are not 2104 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2105 * refers to the first result in the set. Setting both <code>start</code> 2106 * and <code>end</code> to {@link 2107 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 2108 * result set. 2109 * </p> 2110 * 2111 * @param userId1 the primary key of the first user 2112 * @param userId2 the primary key of the second user 2113 * @param start the lower bound of the range of users 2114 * @param end the upper bound of the range of users (not inclusive) 2115 * @param obc the comparator to order the users by (optionally 2116 <code>null</code>) 2117 * @return the ordered range of users with a mutual social relation with the 2118 user 2119 * @throws PortalException if a user with the primary key could not be found 2120 * @throws SystemException if a system exception occurred 2121 */ 2122 @Override 2123 public java.util.List<com.liferay.portal.model.User> getSocialUsers( 2124 long userId1, long userId2, int start, int end, 2125 com.liferay.portal.kernel.util.OrderByComparator obc) 2126 throws com.liferay.portal.kernel.exception.PortalException, 2127 com.liferay.portal.kernel.exception.SystemException { 2128 return _userLocalService.getSocialUsers(userId1, userId2, start, end, 2129 obc); 2130 } 2131 2132 /** 2133 * Returns the number of users with a social relation with the user. 2134 * 2135 * @param userId the primary key of the user 2136 * @return the number of users with a social relation with the user 2137 * @throws PortalException if a user with the primary key could not be found 2138 * @throws SystemException if a system exception occurred 2139 */ 2140 @Override 2141 public int getSocialUsersCount(long userId) 2142 throws com.liferay.portal.kernel.exception.PortalException, 2143 com.liferay.portal.kernel.exception.SystemException { 2144 return _userLocalService.getSocialUsersCount(userId); 2145 } 2146 2147 /** 2148 * Returns the number of users with a social relation of the type with the 2149 * user. 2150 * 2151 * @param userId the primary key of the user 2152 * @param type the type of social relation. The possible types can be found 2153 in {@link 2154 com.liferay.portlet.social.model.SocialRelationConstants}. 2155 * @return the number of users with a social relation of the type with the 2156 user 2157 * @throws PortalException if a user with the primary key could not be found 2158 * @throws SystemException if a system exception occurred 2159 */ 2160 @Override 2161 public int getSocialUsersCount(long userId, int type) 2162 throws com.liferay.portal.kernel.exception.PortalException, 2163 com.liferay.portal.kernel.exception.SystemException { 2164 return _userLocalService.getSocialUsersCount(userId, type); 2165 } 2166 2167 /** 2168 * Returns the number of users with a mutual social relation with both of 2169 * the given users. 2170 * 2171 * @param userId1 the primary key of the first user 2172 * @param userId2 the primary key of the second user 2173 * @return the number of users with a mutual social relation with the user 2174 * @throws PortalException if a user with the primary key could not be found 2175 * @throws SystemException if a system exception occurred 2176 */ 2177 @Override 2178 public int getSocialUsersCount(long userId1, long userId2) 2179 throws com.liferay.portal.kernel.exception.PortalException, 2180 com.liferay.portal.kernel.exception.SystemException { 2181 return _userLocalService.getSocialUsersCount(userId1, userId2); 2182 } 2183 2184 /** 2185 * Returns the number of users with a mutual social relation of the type 2186 * with both of the given users. 2187 * 2188 * @param userId1 the primary key of the first user 2189 * @param userId2 the primary key of the second user 2190 * @param type the type of social relation. The possible types can be found 2191 in {@link 2192 com.liferay.portlet.social.model.SocialRelationConstants}. 2193 * @return the number of users with a mutual social relation of the type 2194 with the user 2195 * @throws PortalException if a user with the primary key could not be found 2196 * @throws SystemException if a system exception occurred 2197 */ 2198 @Override 2199 public int getSocialUsersCount(long userId1, long userId2, int type) 2200 throws com.liferay.portal.kernel.exception.PortalException, 2201 com.liferay.portal.kernel.exception.SystemException { 2202 return _userLocalService.getSocialUsersCount(userId1, userId2, type); 2203 } 2204 2205 /** 2206 * Returns the user with the contact ID. 2207 * 2208 * @param contactId the user's contact ID 2209 * @return the user with the contact ID 2210 * @throws PortalException if a user with the contact ID could not be found 2211 * @throws SystemException if a system exception occurred 2212 */ 2213 @Override 2214 public com.liferay.portal.model.User getUserByContactId(long contactId) 2215 throws com.liferay.portal.kernel.exception.PortalException, 2216 com.liferay.portal.kernel.exception.SystemException { 2217 return _userLocalService.getUserByContactId(contactId); 2218 } 2219 2220 /** 2221 * Returns the user with the email address. 2222 * 2223 * @param companyId the primary key of the user's company 2224 * @param emailAddress the user's email address 2225 * @return the user with the email address 2226 * @throws PortalException if a user with the email address could not be 2227 found 2228 * @throws SystemException if a system exception occurred 2229 */ 2230 @Override 2231 public com.liferay.portal.model.User getUserByEmailAddress(long companyId, 2232 java.lang.String emailAddress) 2233 throws com.liferay.portal.kernel.exception.PortalException, 2234 com.liferay.portal.kernel.exception.SystemException { 2235 return _userLocalService.getUserByEmailAddress(companyId, emailAddress); 2236 } 2237 2238 /** 2239 * Returns the user with the Facebook ID. 2240 * 2241 * @param companyId the primary key of the user's company 2242 * @param facebookId the user's Facebook ID 2243 * @return the user with the Facebook ID 2244 * @throws PortalException if a user with the Facebook ID could not be found 2245 * @throws SystemException if a system exception occurred 2246 */ 2247 @Override 2248 public com.liferay.portal.model.User getUserByFacebookId(long companyId, 2249 long facebookId) 2250 throws com.liferay.portal.kernel.exception.PortalException, 2251 com.liferay.portal.kernel.exception.SystemException { 2252 return _userLocalService.getUserByFacebookId(companyId, facebookId); 2253 } 2254 2255 /** 2256 * Returns the user with the primary key. 2257 * 2258 * @param userId the primary key of the user 2259 * @return the user with the primary key 2260 * @throws PortalException if a user with the primary key could not be found 2261 * @throws SystemException if a system exception occurred 2262 */ 2263 @Override 2264 public com.liferay.portal.model.User getUserById(long userId) 2265 throws com.liferay.portal.kernel.exception.PortalException, 2266 com.liferay.portal.kernel.exception.SystemException { 2267 return _userLocalService.getUserById(userId); 2268 } 2269 2270 /** 2271 * Returns the user with the primary key from the company. 2272 * 2273 * @param companyId the primary key of the user's company 2274 * @param userId the primary key of the user 2275 * @return the user with the primary key 2276 * @throws PortalException if a user with the primary key from the company 2277 could not be found 2278 * @throws SystemException if a system exception occurred 2279 */ 2280 @Override 2281 public com.liferay.portal.model.User getUserById(long companyId, long userId) 2282 throws com.liferay.portal.kernel.exception.PortalException, 2283 com.liferay.portal.kernel.exception.SystemException { 2284 return _userLocalService.getUserById(companyId, userId); 2285 } 2286 2287 /** 2288 * Returns the user with the OpenID. 2289 * 2290 * @param companyId the primary key of the user's company 2291 * @param openId the user's OpenID 2292 * @return the user with the OpenID 2293 * @throws PortalException if a user with the OpenID could not be found 2294 * @throws SystemException if a system exception occurred 2295 */ 2296 @Override 2297 public com.liferay.portal.model.User getUserByOpenId(long companyId, 2298 java.lang.String openId) 2299 throws com.liferay.portal.kernel.exception.PortalException, 2300 com.liferay.portal.kernel.exception.SystemException { 2301 return _userLocalService.getUserByOpenId(companyId, openId); 2302 } 2303 2304 /** 2305 * Returns the user with the portrait ID. 2306 * 2307 * @param portraitId the user's portrait ID 2308 * @return the user with the portrait ID 2309 * @throws PortalException if a user with the portrait ID could not be found 2310 * @throws SystemException if a system exception occurred 2311 */ 2312 @Override 2313 public com.liferay.portal.model.User getUserByPortraitId(long portraitId) 2314 throws com.liferay.portal.kernel.exception.PortalException, 2315 com.liferay.portal.kernel.exception.SystemException { 2316 return _userLocalService.getUserByPortraitId(portraitId); 2317 } 2318 2319 /** 2320 * Returns the user with the screen name. 2321 * 2322 * @param companyId the primary key of the user's company 2323 * @param screenName the user's screen name 2324 * @return the user with the screen name 2325 * @throws PortalException if a user with the screen name could not be found 2326 * @throws SystemException if a system exception occurred 2327 */ 2328 @Override 2329 public com.liferay.portal.model.User getUserByScreenName(long companyId, 2330 java.lang.String screenName) 2331 throws com.liferay.portal.kernel.exception.PortalException, 2332 com.liferay.portal.kernel.exception.SystemException { 2333 return _userLocalService.getUserByScreenName(companyId, screenName); 2334 } 2335 2336 /** 2337 * Returns the user with the UUID. 2338 * 2339 * @param uuid the user's UUID 2340 * @return the user with the UUID 2341 * @throws PortalException if a user with the UUID could not be found 2342 * @throws SystemException if a system exception occurred 2343 * @deprecated As of 6.2.0, replaced by {@link 2344 #getUserByUuidAndCompanyId(String, long)} 2345 */ 2346 @Override 2347 public com.liferay.portal.model.User getUserByUuid(java.lang.String uuid) 2348 throws com.liferay.portal.kernel.exception.PortalException, 2349 com.liferay.portal.kernel.exception.SystemException { 2350 return _userLocalService.getUserByUuid(uuid); 2351 } 2352 2353 /** 2354 * Returns the number of users with the status belonging to the user group. 2355 * 2356 * @param userGroupId the primary key of the user group 2357 * @param status the workflow status 2358 * @return the number of users with the status belonging to the user group 2359 * @throws PortalException if a user group with the primary key could not be 2360 found 2361 * @throws SystemException if a system exception occurred 2362 */ 2363 @Override 2364 public int getUserGroupUsersCount(long userGroupId, int status) 2365 throws com.liferay.portal.kernel.exception.PortalException, 2366 com.liferay.portal.kernel.exception.SystemException { 2367 return _userLocalService.getUserGroupUsersCount(userGroupId, status); 2368 } 2369 2370 /** 2371 * Returns the primary key of the user with the email address. 2372 * 2373 * @param companyId the primary key of the user's company 2374 * @param emailAddress the user's email address 2375 * @return the primary key of the user with the email address 2376 * @throws PortalException if a user with the email address could not be 2377 found 2378 * @throws SystemException if a system exception occurred 2379 */ 2380 @Override 2381 public long getUserIdByEmailAddress(long companyId, 2382 java.lang.String emailAddress) 2383 throws com.liferay.portal.kernel.exception.PortalException, 2384 com.liferay.portal.kernel.exception.SystemException { 2385 return _userLocalService.getUserIdByEmailAddress(companyId, emailAddress); 2386 } 2387 2388 /** 2389 * Returns the primary key of the user with the screen name. 2390 * 2391 * @param companyId the primary key of the user's company 2392 * @param screenName the user's screen name 2393 * @return the primary key of the user with the screen name 2394 * @throws PortalException if a user with the screen name could not be found 2395 * @throws SystemException if a system exception occurred 2396 */ 2397 @Override 2398 public long getUserIdByScreenName(long companyId, 2399 java.lang.String screenName) 2400 throws com.liferay.portal.kernel.exception.PortalException, 2401 com.liferay.portal.kernel.exception.SystemException { 2402 return _userLocalService.getUserIdByScreenName(companyId, screenName); 2403 } 2404 2405 /** 2406 * Returns <code>true</code> if the password policy has been assigned to the 2407 * user. 2408 * 2409 * @param passwordPolicyId the primary key of the password policy 2410 * @param userId the primary key of the user 2411 * @return <code>true</code> if the password policy is assigned to the user; 2412 <code>false</code> otherwise 2413 * @throws SystemException if a system exception occurred 2414 */ 2415 @Override 2416 public boolean hasPasswordPolicyUser(long passwordPolicyId, long userId) 2417 throws com.liferay.portal.kernel.exception.SystemException { 2418 return _userLocalService.hasPasswordPolicyUser(passwordPolicyId, userId); 2419 } 2420 2421 /** 2422 * Returns <code>true</code> if the user has the role with the name, 2423 * optionally through inheritance. 2424 * 2425 * @param companyId the primary key of the role's company 2426 * @param name the name of the role (must be a regular role, not an 2427 organization, site or provider role) 2428 * @param userId the primary key of the user 2429 * @param inherited whether to include roles inherited from organizations, 2430 sites, etc. 2431 * @return <code>true</code> if the user has the role; <code>false</code> 2432 otherwise 2433 * @throws PortalException if a role with the name could not be found 2434 * @throws SystemException if a system exception occurred 2435 */ 2436 @Override 2437 public boolean hasRoleUser(long companyId, java.lang.String name, 2438 long userId, boolean inherited) 2439 throws com.liferay.portal.kernel.exception.PortalException, 2440 com.liferay.portal.kernel.exception.SystemException { 2441 return _userLocalService.hasRoleUser(companyId, name, userId, inherited); 2442 } 2443 2444 /** 2445 * Returns <code>true</code> if the user's password is expired. 2446 * 2447 * @param user the user 2448 * @return <code>true</code> if the user's password is expired; 2449 <code>false</code> otherwise 2450 * @throws PortalException if the password policy for the user could not be 2451 found 2452 * @throws SystemException if a system exception occurred 2453 */ 2454 @Override 2455 public boolean isPasswordExpired(com.liferay.portal.model.User user) 2456 throws com.liferay.portal.kernel.exception.PortalException, 2457 com.liferay.portal.kernel.exception.SystemException { 2458 return _userLocalService.isPasswordExpired(user); 2459 } 2460 2461 /** 2462 * Returns <code>true</code> if the password policy is configured to warn 2463 * the user that his password is expiring and the remaining time until 2464 * expiration is equal or less than the configured warning time. 2465 * 2466 * @param user the user 2467 * @return <code>true</code> if the user's password is expiring soon; 2468 <code>false</code> otherwise 2469 * @throws PortalException if the password policy for the user could not be 2470 found 2471 * @throws SystemException if a system exception occurred 2472 */ 2473 @Override 2474 public boolean isPasswordExpiringSoon(com.liferay.portal.model.User user) 2475 throws com.liferay.portal.kernel.exception.PortalException, 2476 com.liferay.portal.kernel.exception.SystemException { 2477 return _userLocalService.isPasswordExpiringSoon(user); 2478 } 2479 2480 /** 2481 * Returns the default user for the company. 2482 * 2483 * @param companyId the primary key of the company 2484 * @return the default user for the company 2485 * @throws PortalException if the user could not be found 2486 * @throws SystemException if a system exception occurred 2487 */ 2488 @Override 2489 public com.liferay.portal.model.User loadGetDefaultUser(long companyId) 2490 throws com.liferay.portal.kernel.exception.PortalException, 2491 com.liferay.portal.kernel.exception.SystemException { 2492 return _userLocalService.loadGetDefaultUser(companyId); 2493 } 2494 2495 /** 2496 * Returns an ordered range of all the users who match the keywords and 2497 * status, without using the indexer. It is preferable to use the indexed 2498 * version {@link #search(long, String, int, LinkedHashMap, int, int, Sort)} 2499 * instead of this method wherever possible for performance reasons. 2500 * 2501 * <p> 2502 * Useful when paginating results. Returns a maximum of <code>end - 2503 * start</code> instances. <code>start</code> and <code>end</code> are not 2504 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2505 * refers to the first result in the set. Setting both <code>start</code> 2506 * and <code>end</code> to {@link 2507 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 2508 * result set. 2509 * </p> 2510 * 2511 * @param companyId the primary key of the user's company 2512 * @param keywords the keywords (space separated), which may occur in the 2513 user's first name, middle name, last name, screen name, or email 2514 address 2515 * @param status the workflow status 2516 * @param params the finder parameters (optionally <code>null</code>). For 2517 more information see {@link 2518 com.liferay.portal.service.persistence.UserFinder}. 2519 * @param start the lower bound of the range of users 2520 * @param end the upper bound of the range of users (not inclusive) 2521 * @param obc the comparator to order the users by (optionally 2522 <code>null</code>) 2523 * @return the matching users 2524 * @throws SystemException if a system exception occurred 2525 * @see com.liferay.portal.service.persistence.UserFinder 2526 */ 2527 @Override 2528 public java.util.List<com.liferay.portal.model.User> search( 2529 long companyId, java.lang.String keywords, int status, 2530 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2531 int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) 2532 throws com.liferay.portal.kernel.exception.SystemException { 2533 return _userLocalService.search(companyId, keywords, status, params, 2534 start, end, obc); 2535 } 2536 2537 /** 2538 * Returns an ordered range of all the users who match the keywords and 2539 * status, using the indexer. It is preferable to use this method instead of 2540 * the non-indexed version whenever possible for performance reasons. 2541 * 2542 * <p> 2543 * Useful when paginating results. Returns a maximum of <code>end - 2544 * start</code> instances. <code>start</code> and <code>end</code> are not 2545 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2546 * refers to the first result in the set. Setting both <code>start</code> 2547 * and <code>end</code> to {@link 2548 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 2549 * result set. 2550 * </p> 2551 * 2552 * @param companyId the primary key of the user's company 2553 * @param keywords the keywords (space separated), which may occur in the 2554 user's first name, middle name, last name, screen name, or email 2555 address 2556 * @param status the workflow status 2557 * @param params the indexer parameters (optionally <code>null</code>). For 2558 more information see {@link 2559 com.liferay.portlet.usersadmin.util.UserIndexer}. 2560 * @param start the lower bound of the range of users 2561 * @param end the upper bound of the range of users (not inclusive) 2562 * @param sort the field and direction to sort by (optionally 2563 <code>null</code>) 2564 * @return the matching users 2565 * @throws SystemException if a system exception occurred 2566 * @see com.liferay.portlet.usersadmin.util.UserIndexer 2567 */ 2568 @Override 2569 public com.liferay.portal.kernel.search.Hits search(long companyId, 2570 java.lang.String keywords, int status, 2571 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2572 int start, int end, com.liferay.portal.kernel.search.Sort sort) 2573 throws com.liferay.portal.kernel.exception.SystemException { 2574 return _userLocalService.search(companyId, keywords, status, params, 2575 start, end, sort); 2576 } 2577 2578 /** 2579 * Returns an ordered range of all the users with the status, and whose 2580 * first name, middle name, last name, screen name, and email address match 2581 * the keywords specified for them, without using the indexer. It is 2582 * preferable to use the indexed version {@link #search(long, String, 2583 * String, String, String, String, int, LinkedHashMap, boolean, int, int, 2584 * Sort)} instead of this method wherever possible for performance reasons. 2585 * 2586 * <p> 2587 * Useful when paginating results. Returns a maximum of <code>end - 2588 * start</code> instances. <code>start</code> and <code>end</code> are not 2589 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2590 * refers to the first result in the set. Setting both <code>start</code> 2591 * and <code>end</code> to {@link 2592 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 2593 * result set. 2594 * </p> 2595 * 2596 * @param companyId the primary key of the user's company 2597 * @param firstName the first name keywords (space separated) 2598 * @param middleName the middle name keywords 2599 * @param lastName the last name keywords 2600 * @param screenName the screen name keywords 2601 * @param emailAddress the email address keywords 2602 * @param status the workflow status 2603 * @param params the finder parameters (optionally <code>null</code>). For 2604 more information see {@link 2605 com.liferay.portal.service.persistence.UserFinder}. 2606 * @param andSearch whether every field must match its keywords, or just 2607 one field. For example, "users with the first name 'bob' and 2608 last name 'smith'" vs "users with the first name 'bob' 2609 or the last name 'smith'". 2610 * @param start the lower bound of the range of users 2611 * @param end the upper bound of the range of users (not inclusive) 2612 * @param obc the comparator to order the users by (optionally 2613 <code>null</code>) 2614 * @return the matching users 2615 * @throws SystemException if a system exception occurred 2616 * @see com.liferay.portal.service.persistence.UserFinder 2617 */ 2618 @Override 2619 public java.util.List<com.liferay.portal.model.User> search( 2620 long companyId, java.lang.String firstName, 2621 java.lang.String middleName, java.lang.String lastName, 2622 java.lang.String screenName, java.lang.String emailAddress, int status, 2623 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2624 boolean andSearch, int start, int end, 2625 com.liferay.portal.kernel.util.OrderByComparator obc) 2626 throws com.liferay.portal.kernel.exception.SystemException { 2627 return _userLocalService.search(companyId, firstName, middleName, 2628 lastName, screenName, emailAddress, status, params, andSearch, 2629 start, end, obc); 2630 } 2631 2632 /** 2633 * Returns an ordered range of all the users with the status, and whose 2634 * first name, middle name, last name, screen name, and email address match 2635 * the keywords specified for them, using the indexer. It is preferable to 2636 * use this method instead of the non-indexed version whenever possible for 2637 * performance reasons. 2638 * 2639 * <p> 2640 * Useful when paginating results. Returns a maximum of <code>end - 2641 * start</code> instances. <code>start</code> and <code>end</code> are not 2642 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2643 * refers to the first result in the set. Setting both <code>start</code> 2644 * and <code>end</code> to {@link 2645 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 2646 * result set. 2647 * </p> 2648 * 2649 * @param companyId the primary key of the user's company 2650 * @param firstName the first name keywords (space separated) 2651 * @param middleName the middle name keywords 2652 * @param lastName the last name keywords 2653 * @param screenName the screen name keywords 2654 * @param emailAddress the email address keywords 2655 * @param status the workflow status 2656 * @param params the indexer parameters (optionally <code>null</code>). For 2657 more information see {@link 2658 com.liferay.portlet.usersadmin.util.UserIndexer}. 2659 * @param andSearch whether every field must match its keywords, or just 2660 one field. For example, "users with the first name 'bob' and 2661 last name 'smith'" vs "users with the first name 'bob' 2662 or the last name 'smith'". 2663 * @param start the lower bound of the range of users 2664 * @param end the upper bound of the range of users (not inclusive) 2665 * @param sort the field and direction to sort by (optionally 2666 <code>null</code>) 2667 * @return the matching users 2668 * @throws SystemException if a system exception occurred 2669 * @see com.liferay.portlet.usersadmin.util.UserIndexer 2670 */ 2671 @Override 2672 public com.liferay.portal.kernel.search.Hits search(long companyId, 2673 java.lang.String firstName, java.lang.String middleName, 2674 java.lang.String lastName, java.lang.String screenName, 2675 java.lang.String emailAddress, int status, 2676 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2677 boolean andSearch, int start, int end, 2678 com.liferay.portal.kernel.search.Sort sort) 2679 throws com.liferay.portal.kernel.exception.SystemException { 2680 return _userLocalService.search(companyId, firstName, middleName, 2681 lastName, screenName, emailAddress, status, params, andSearch, 2682 start, end, sort); 2683 } 2684 2685 /** 2686 * Returns the number of users who match the keywords and status. 2687 * 2688 * @param companyId the primary key of the user's company 2689 * @param keywords the keywords (space separated), which may occur in the 2690 user's first name, middle name, last name, screen name, or email 2691 address 2692 * @param status the workflow status 2693 * @param params the finder parameters (optionally <code>null</code>). For 2694 more information see {@link 2695 com.liferay.portal.service.persistence.UserFinder}. 2696 * @return the number matching users 2697 * @throws SystemException if a system exception occurred 2698 */ 2699 @Override 2700 public int searchCount(long companyId, java.lang.String keywords, 2701 int status, 2702 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params) 2703 throws com.liferay.portal.kernel.exception.SystemException { 2704 return _userLocalService.searchCount(companyId, keywords, status, params); 2705 } 2706 2707 /** 2708 * Returns the number of users with the status, and whose first name, middle 2709 * name, last name, screen name, and email address match the keywords 2710 * specified for them. 2711 * 2712 * @param companyId the primary key of the user's company 2713 * @param firstName the first name keywords (space separated) 2714 * @param middleName the middle name keywords 2715 * @param lastName the last name keywords 2716 * @param screenName the screen name keywords 2717 * @param emailAddress the email address keywords 2718 * @param status the workflow status 2719 * @param params the finder parameters (optionally <code>null</code>). For 2720 more information see {@link 2721 com.liferay.portal.service.persistence.UserFinder}. 2722 * @param andSearch whether every field must match its keywords, or just 2723 one field. For example, "users with the first name 'bob' and 2724 last name 'smith'" vs "users with the first name 'bob' 2725 or the last name 'smith'". 2726 * @return the number of matching users 2727 * @throws SystemException if a system exception occurred 2728 */ 2729 @Override 2730 public int searchCount(long companyId, java.lang.String firstName, 2731 java.lang.String middleName, java.lang.String lastName, 2732 java.lang.String screenName, java.lang.String emailAddress, int status, 2733 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2734 boolean andSearch) 2735 throws com.liferay.portal.kernel.exception.SystemException { 2736 return _userLocalService.searchCount(companyId, firstName, middleName, 2737 lastName, screenName, emailAddress, status, params, andSearch); 2738 } 2739 2740 /** 2741 * Sends an email address verification to the user. 2742 * 2743 * @param user the verification email recipient 2744 * @param emailAddress the recipient's email address 2745 * @param serviceContext the service context to be applied. Must set the 2746 portal URL, main path, primary key of the layout, remote address, 2747 remote host, and agent for the user. 2748 * @throws PortalException if a portal exception occurred 2749 * @throws SystemException if a system exception occurred 2750 */ 2751 @Override 2752 public void sendEmailAddressVerification( 2753 com.liferay.portal.model.User user, java.lang.String emailAddress, 2754 com.liferay.portal.service.ServiceContext serviceContext) 2755 throws com.liferay.portal.kernel.exception.PortalException, 2756 com.liferay.portal.kernel.exception.SystemException { 2757 _userLocalService.sendEmailAddressVerification(user, emailAddress, 2758 serviceContext); 2759 } 2760 2761 /** 2762 * Sends the password email to the user with the email address. The content 2763 * of this email can be specified in <code>portal.properties</code> with the 2764 * <code>admin.email.password</code> keys. 2765 * 2766 * @param companyId the primary key of the user's company 2767 * @param emailAddress the user's email address 2768 * @param fromName the name of the individual that the email should be from 2769 * @param fromAddress the address of the individual that the email should 2770 be from 2771 * @param subject the email subject. If <code>null</code>, the subject 2772 specified in <code>portal.properties</code> will be used. 2773 * @param body the email body. If <code>null</code>, the body specified in 2774 <code>portal.properties</code> will be used. 2775 * @param serviceContext the service context to be applied 2776 * @throws PortalException if a user with the email address could not be 2777 found 2778 * @throws SystemException if a system exception occurred 2779 */ 2780 @Override 2781 public void sendPassword(long companyId, java.lang.String emailAddress, 2782 java.lang.String fromName, java.lang.String fromAddress, 2783 java.lang.String subject, java.lang.String body, 2784 com.liferay.portal.service.ServiceContext serviceContext) 2785 throws com.liferay.portal.kernel.exception.PortalException, 2786 com.liferay.portal.kernel.exception.SystemException { 2787 _userLocalService.sendPassword(companyId, emailAddress, fromName, 2788 fromAddress, subject, body, serviceContext); 2789 } 2790 2791 /** 2792 * Removes the users from the teams of a group. 2793 * 2794 * @param groupId the primary key of the group 2795 * @param userIds the primary keys of the users 2796 * @throws PortalException if a portal exception occurred 2797 * @throws SystemException if a system exception occurred 2798 */ 2799 @Override 2800 public void unsetGroupTeamsUsers(long groupId, long[] userIds) 2801 throws com.liferay.portal.kernel.exception.PortalException, 2802 com.liferay.portal.kernel.exception.SystemException { 2803 _userLocalService.unsetGroupTeamsUsers(groupId, userIds); 2804 } 2805 2806 /** 2807 * Removes the users from the group. 2808 * 2809 * @param groupId the primary key of the group 2810 * @param userIds the primary keys of the users 2811 * @param serviceContext the service context to be applied (optionally 2812 <code>null</code>) 2813 * @throws PortalException if a portal exception occurred 2814 * @throws SystemException if a system exception occurred 2815 */ 2816 @Override 2817 public void unsetGroupUsers(long groupId, long[] userIds, 2818 com.liferay.portal.service.ServiceContext serviceContext) 2819 throws com.liferay.portal.kernel.exception.PortalException, 2820 com.liferay.portal.kernel.exception.SystemException { 2821 _userLocalService.unsetGroupUsers(groupId, userIds, serviceContext); 2822 } 2823 2824 /** 2825 * Removes the users from the organization. 2826 * 2827 * @param organizationId the primary key of the organization 2828 * @param userIds the primary keys of the users 2829 * @throws PortalException if a portal exception occurred 2830 * @throws SystemException if a system exception occurred 2831 */ 2832 @Override 2833 public void unsetOrganizationUsers(long organizationId, long[] userIds) 2834 throws com.liferay.portal.kernel.exception.PortalException, 2835 com.liferay.portal.kernel.exception.SystemException { 2836 _userLocalService.unsetOrganizationUsers(organizationId, userIds); 2837 } 2838 2839 /** 2840 * Removes the users from the password policy. 2841 * 2842 * @param passwordPolicyId the primary key of the password policy 2843 * @param userIds the primary keys of the users 2844 * @throws SystemException if a system exception occurred 2845 */ 2846 @Override 2847 public void unsetPasswordPolicyUsers(long passwordPolicyId, long[] userIds) 2848 throws com.liferay.portal.kernel.exception.SystemException { 2849 _userLocalService.unsetPasswordPolicyUsers(passwordPolicyId, userIds); 2850 } 2851 2852 /** 2853 * Removes the users from the role. 2854 * 2855 * @param roleId the primary key of the role 2856 * @param users the users 2857 * @throws PortalException if a portal exception occurred 2858 * @throws SystemException if a system exception occurred 2859 */ 2860 @Override 2861 public void unsetRoleUsers(long roleId, 2862 java.util.List<com.liferay.portal.model.User> users) 2863 throws com.liferay.portal.kernel.exception.PortalException, 2864 com.liferay.portal.kernel.exception.SystemException { 2865 _userLocalService.unsetRoleUsers(roleId, users); 2866 } 2867 2868 /** 2869 * Removes the users from the role. 2870 * 2871 * @param roleId the primary key of the role 2872 * @param userIds the primary keys of the users 2873 * @throws PortalException if a portal exception occurred 2874 * @throws SystemException if a system exception occurred 2875 */ 2876 @Override 2877 public void unsetRoleUsers(long roleId, long[] userIds) 2878 throws com.liferay.portal.kernel.exception.PortalException, 2879 com.liferay.portal.kernel.exception.SystemException { 2880 _userLocalService.unsetRoleUsers(roleId, userIds); 2881 } 2882 2883 /** 2884 * Removes the users from the team. 2885 * 2886 * @param teamId the primary key of the team 2887 * @param userIds the primary keys of the users 2888 * @throws PortalException if a portal exception occurred 2889 * @throws SystemException if a system exception occurred 2890 */ 2891 @Override 2892 public void unsetTeamUsers(long teamId, long[] userIds) 2893 throws com.liferay.portal.kernel.exception.PortalException, 2894 com.liferay.portal.kernel.exception.SystemException { 2895 _userLocalService.unsetTeamUsers(teamId, userIds); 2896 } 2897 2898 /** 2899 * Removes the users from the user group. 2900 * 2901 * @param userGroupId the primary key of the user group 2902 * @param userIds the primary keys of the users 2903 * @throws PortalException if a portal exception occurred 2904 * @throws SystemException if a system exception occurred 2905 */ 2906 @Override 2907 public void unsetUserGroupUsers(long userGroupId, long[] userIds) 2908 throws com.liferay.portal.kernel.exception.PortalException, 2909 com.liferay.portal.kernel.exception.SystemException { 2910 _userLocalService.unsetUserGroupUsers(userGroupId, userIds); 2911 } 2912 2913 /** 2914 * Updates whether the user has agreed to the terms of use. 2915 * 2916 * @param userId the primary key of the user 2917 * @param agreedToTermsOfUse whether the user has agreet to the terms of 2918 use 2919 * @return the user 2920 * @throws PortalException if a user with the primary key could not be found 2921 * @throws SystemException if a system exception occurred 2922 */ 2923 @Override 2924 public com.liferay.portal.model.User updateAgreedToTermsOfUse(long userId, 2925 boolean agreedToTermsOfUse) 2926 throws com.liferay.portal.kernel.exception.PortalException, 2927 com.liferay.portal.kernel.exception.SystemException { 2928 return _userLocalService.updateAgreedToTermsOfUse(userId, 2929 agreedToTermsOfUse); 2930 } 2931 2932 /** 2933 * Updates the user's asset with the new asset categories and tag names, 2934 * removing and adding asset categories and tag names as necessary. 2935 * 2936 * @param userId the primary key of the user 2937 * @param user ID the primary key of the user 2938 * @param assetCategoryIds the primary key's of the new asset categories 2939 * @param assetTagNames the new asset tag names 2940 * @throws PortalException if a user with the primary key could not be found 2941 * @throws SystemException if a system exception occurred 2942 */ 2943 @Override 2944 public void updateAsset(long userId, com.liferay.portal.model.User user, 2945 long[] assetCategoryIds, java.lang.String[] assetTagNames) 2946 throws com.liferay.portal.kernel.exception.PortalException, 2947 com.liferay.portal.kernel.exception.SystemException { 2948 _userLocalService.updateAsset(userId, user, assetCategoryIds, 2949 assetTagNames); 2950 } 2951 2952 /** 2953 * Updates the user's creation date. 2954 * 2955 * @param userId the primary key of the user 2956 * @param createDate the new creation date 2957 * @return the user 2958 * @throws PortalException if a user with the primary key could not be found 2959 * @throws SystemException if a system exception occurred 2960 */ 2961 @Override 2962 public com.liferay.portal.model.User updateCreateDate(long userId, 2963 java.util.Date createDate) 2964 throws com.liferay.portal.kernel.exception.PortalException, 2965 com.liferay.portal.kernel.exception.SystemException { 2966 return _userLocalService.updateCreateDate(userId, createDate); 2967 } 2968 2969 /** 2970 * Updates the user's email address. 2971 * 2972 * @param userId the primary key of the user 2973 * @param password the user's password 2974 * @param emailAddress1 the user's new email address 2975 * @param emailAddress2 the user's new email address confirmation 2976 * @return the user 2977 * @throws PortalException if a user with the primary key could not be found 2978 * @throws SystemException if a system exception occurred 2979 */ 2980 @Override 2981 public com.liferay.portal.model.User updateEmailAddress(long userId, 2982 java.lang.String password, java.lang.String emailAddress1, 2983 java.lang.String emailAddress2) 2984 throws com.liferay.portal.kernel.exception.PortalException, 2985 com.liferay.portal.kernel.exception.SystemException { 2986 return _userLocalService.updateEmailAddress(userId, password, 2987 emailAddress1, emailAddress2); 2988 } 2989 2990 /** 2991 * Updates the user's email address or sends verification email. 2992 * 2993 * @param userId the primary key of the user 2994 * @param password the user's password 2995 * @param emailAddress1 the user's new email address 2996 * @param emailAddress2 the user's new email address confirmation 2997 * @param serviceContext the service context to be applied. Must set the 2998 portal URL, main path, primary key of the layout, remote address, 2999 remote host, and agent for the user. 3000 * @return the user 3001 * @throws PortalException if a user with the primary key could not be found 3002 * @throws SystemException if a system exception occurred 3003 */ 3004 @Override 3005 public com.liferay.portal.model.User updateEmailAddress(long userId, 3006 java.lang.String password, java.lang.String emailAddress1, 3007 java.lang.String emailAddress2, 3008 com.liferay.portal.service.ServiceContext serviceContext) 3009 throws com.liferay.portal.kernel.exception.PortalException, 3010 com.liferay.portal.kernel.exception.SystemException { 3011 return _userLocalService.updateEmailAddress(userId, password, 3012 emailAddress1, emailAddress2, serviceContext); 3013 } 3014 3015 /** 3016 * Updates whether the user has verified email address. 3017 * 3018 * @param userId the primary key of the user 3019 * @param emailAddressVerified whether the user has verified email address 3020 * @return the user 3021 * @throws PortalException if a user with the primary key could not be found 3022 * @throws SystemException if a system exception occurred 3023 */ 3024 @Override 3025 public com.liferay.portal.model.User updateEmailAddressVerified( 3026 long userId, boolean emailAddressVerified) 3027 throws com.liferay.portal.kernel.exception.PortalException, 3028 com.liferay.portal.kernel.exception.SystemException { 3029 return _userLocalService.updateEmailAddressVerified(userId, 3030 emailAddressVerified); 3031 } 3032 3033 /** 3034 * Updates the user's Facebook ID. 3035 * 3036 * @param userId the primary key of the user 3037 * @param facebookId the user's new Facebook ID 3038 * @return the user 3039 * @throws PortalException if a user with the primary key could not be found 3040 * @throws SystemException if a system exception occurred 3041 */ 3042 @Override 3043 public com.liferay.portal.model.User updateFacebookId(long userId, 3044 long facebookId) 3045 throws com.liferay.portal.kernel.exception.PortalException, 3046 com.liferay.portal.kernel.exception.SystemException { 3047 return _userLocalService.updateFacebookId(userId, facebookId); 3048 } 3049 3050 /** 3051 * Sets the groups the user is in, removing and adding groups as necessary. 3052 * 3053 * @param userId the primary key of the user 3054 * @param newGroupIds the primary keys of the groups 3055 * @param serviceContext the service context to be applied (optionally 3056 <code>null</code>) 3057 * @throws PortalException if a portal exception occurred 3058 * @throws SystemException if a system exception occurred 3059 */ 3060 @Override 3061 public void updateGroups(long userId, long[] newGroupIds, 3062 com.liferay.portal.service.ServiceContext serviceContext) 3063 throws com.liferay.portal.kernel.exception.PortalException, 3064 com.liferay.portal.kernel.exception.SystemException { 3065 _userLocalService.updateGroups(userId, newGroupIds, serviceContext); 3066 } 3067 3068 /** 3069 * Updates a user account that was automatically created when a guest user 3070 * participated in an action (e.g. posting a comment) and only provided his 3071 * name and email address. 3072 * 3073 * @param creatorUserId the primary key of the creator 3074 * @param companyId the primary key of the user's company 3075 * @param autoPassword whether a password should be automatically generated 3076 for the user 3077 * @param password1 the user's password 3078 * @param password2 the user's password confirmation 3079 * @param autoScreenName whether a screen name should be automatically 3080 generated for the user 3081 * @param screenName the user's screen name 3082 * @param emailAddress the user's email address 3083 * @param facebookId the user's facebook ID 3084 * @param openId the user's OpenID 3085 * @param locale the user's locale 3086 * @param firstName the user's first name 3087 * @param middleName the user's middle name 3088 * @param lastName the user's last name 3089 * @param prefixId the user's name prefix ID 3090 * @param suffixId the user's name suffix ID 3091 * @param male whether the user is male 3092 * @param birthdayMonth the user's birthday month (0-based, meaning 0 for 3093 January) 3094 * @param birthdayDay the user's birthday day 3095 * @param birthdayYear the user's birthday year 3096 * @param jobTitle the user's job title 3097 * @param updateUserInformation whether to update the user's information 3098 * @param sendEmail whether to send the user an email notification about 3099 their new account 3100 * @param serviceContext the service context to be applied (optionally 3101 <code>null</code>). Can set expando bridge attributes for the 3102 user. 3103 * @return the user 3104 * @throws PortalException if the user's information was invalid 3105 * @throws SystemException if a system exception occurred 3106 */ 3107 @Override 3108 public com.liferay.portal.model.User updateIncompleteUser( 3109 long creatorUserId, long companyId, boolean autoPassword, 3110 java.lang.String password1, java.lang.String password2, 3111 boolean autoScreenName, java.lang.String screenName, 3112 java.lang.String emailAddress, long facebookId, 3113 java.lang.String openId, java.util.Locale locale, 3114 java.lang.String firstName, java.lang.String middleName, 3115 java.lang.String lastName, int prefixId, int suffixId, boolean male, 3116 int birthdayMonth, int birthdayDay, int birthdayYear, 3117 java.lang.String jobTitle, boolean updateUserInformation, 3118 boolean sendEmail, 3119 com.liferay.portal.service.ServiceContext serviceContext) 3120 throws com.liferay.portal.kernel.exception.PortalException, 3121 com.liferay.portal.kernel.exception.SystemException { 3122 return _userLocalService.updateIncompleteUser(creatorUserId, companyId, 3123 autoPassword, password1, password2, autoScreenName, screenName, 3124 emailAddress, facebookId, openId, locale, firstName, middleName, 3125 lastName, prefixId, suffixId, male, birthdayMonth, birthdayDay, 3126 birthdayYear, jobTitle, updateUserInformation, sendEmail, 3127 serviceContext); 3128 } 3129 3130 /** 3131 * Updates the user's job title. 3132 * 3133 * @param userId the primary key of the user 3134 * @param jobTitle the user's job title 3135 * @return the user 3136 * @throws PortalException if a user with the primary key could not be found 3137 or if a contact could not be found matching the user's contact ID 3138 * @throws SystemException if a system exception occurred 3139 */ 3140 @Override 3141 public com.liferay.portal.model.User updateJobTitle(long userId, 3142 java.lang.String jobTitle) 3143 throws com.liferay.portal.kernel.exception.PortalException, 3144 com.liferay.portal.kernel.exception.SystemException { 3145 return _userLocalService.updateJobTitle(userId, jobTitle); 3146 } 3147 3148 /** 3149 * Updates the user's last login with the current time and the IP address. 3150 * 3151 * @param userId the primary key of the user 3152 * @param loginIP the IP address the user logged in from 3153 * @return the user 3154 * @throws PortalException if a user with the primary key could not be found 3155 * @throws SystemException if a system exception occurred 3156 */ 3157 @Override 3158 public com.liferay.portal.model.User updateLastLogin(long userId, 3159 java.lang.String loginIP) 3160 throws com.liferay.portal.kernel.exception.PortalException, 3161 com.liferay.portal.kernel.exception.SystemException { 3162 return _userLocalService.updateLastLogin(userId, loginIP); 3163 } 3164 3165 /** 3166 * Updates whether the user is locked out from logging in. 3167 * 3168 * @param user the user 3169 * @param lockout whether the user is locked out 3170 * @return the user 3171 * @throws PortalException if a portal exception occurred 3172 * @throws SystemException if a system exception occurred 3173 */ 3174 @Override 3175 public com.liferay.portal.model.User updateLockout( 3176 com.liferay.portal.model.User user, boolean lockout) 3177 throws com.liferay.portal.kernel.exception.PortalException, 3178 com.liferay.portal.kernel.exception.SystemException { 3179 return _userLocalService.updateLockout(user, lockout); 3180 } 3181 3182 /** 3183 * Updates whether the user is locked out from logging in. 3184 * 3185 * @param companyId the primary key of the user's company 3186 * @param emailAddress the user's email address 3187 * @param lockout whether the user is locked out 3188 * @return the user 3189 * @throws PortalException if a user with the email address could not be 3190 found 3191 * @throws SystemException if a system exception occurred 3192 */ 3193 @Override 3194 public com.liferay.portal.model.User updateLockoutByEmailAddress( 3195 long companyId, java.lang.String emailAddress, boolean lockout) 3196 throws com.liferay.portal.kernel.exception.PortalException, 3197 com.liferay.portal.kernel.exception.SystemException { 3198 return _userLocalService.updateLockoutByEmailAddress(companyId, 3199 emailAddress, lockout); 3200 } 3201 3202 /** 3203 * Updates whether the user is locked out from logging in. 3204 * 3205 * @param userId the primary key of the user 3206 * @param lockout whether the user is locked out 3207 * @return the user 3208 * @throws PortalException if a user with the primary key could not be found 3209 * @throws SystemException if a system exception occurred 3210 */ 3211 @Override 3212 public com.liferay.portal.model.User updateLockoutById(long userId, 3213 boolean lockout) 3214 throws com.liferay.portal.kernel.exception.PortalException, 3215 com.liferay.portal.kernel.exception.SystemException { 3216 return _userLocalService.updateLockoutById(userId, lockout); 3217 } 3218 3219 /** 3220 * Updates whether the user is locked out from logging in. 3221 * 3222 * @param companyId the primary key of the user's company 3223 * @param screenName the user's screen name 3224 * @param lockout whether the user is locked out 3225 * @return the user 3226 * @throws PortalException if a user with the screen name could not be found 3227 * @throws SystemException if a system exception occurred 3228 */ 3229 @Override 3230 public com.liferay.portal.model.User updateLockoutByScreenName( 3231 long companyId, java.lang.String screenName, boolean lockout) 3232 throws com.liferay.portal.kernel.exception.PortalException, 3233 com.liferay.portal.kernel.exception.SystemException { 3234 return _userLocalService.updateLockoutByScreenName(companyId, 3235 screenName, lockout); 3236 } 3237 3238 /** 3239 * Updates the user's modified date. 3240 * 3241 * @param userId the primary key of the user 3242 * @param modifiedDate the new modified date 3243 * @return the user 3244 * @throws PortalException if a user with the primary key could not be found 3245 * @throws SystemException if a system exception occurred 3246 */ 3247 @Override 3248 public com.liferay.portal.model.User updateModifiedDate(long userId, 3249 java.util.Date modifiedDate) 3250 throws com.liferay.portal.kernel.exception.PortalException, 3251 com.liferay.portal.kernel.exception.SystemException { 3252 return _userLocalService.updateModifiedDate(userId, modifiedDate); 3253 } 3254 3255 /** 3256 * Updates the user's OpenID. 3257 * 3258 * @param userId the primary key of the user 3259 * @param openId the new OpenID 3260 * @return the user 3261 * @throws PortalException if a user with the primary key could not be found 3262 * @throws SystemException if a system exception occurred 3263 */ 3264 @Override 3265 public com.liferay.portal.model.User updateOpenId(long userId, 3266 java.lang.String openId) 3267 throws com.liferay.portal.kernel.exception.PortalException, 3268 com.liferay.portal.kernel.exception.SystemException { 3269 return _userLocalService.updateOpenId(userId, openId); 3270 } 3271 3272 /** 3273 * Sets the organizations that the user is in, removing and adding 3274 * organizations as necessary. 3275 * 3276 * @param userId the primary key of the user 3277 * @param newOrganizationIds the primary keys of the organizations 3278 * @param serviceContext the service context to be applied. Must set 3279 whether user indexing is enabled. 3280 * @throws PortalException if a user with the primary key could not be found 3281 * @throws SystemException if a system exception occurred 3282 */ 3283 @Override 3284 public void updateOrganizations(long userId, long[] newOrganizationIds, 3285 com.liferay.portal.service.ServiceContext serviceContext) 3286 throws com.liferay.portal.kernel.exception.PortalException, 3287 com.liferay.portal.kernel.exception.SystemException { 3288 _userLocalService.updateOrganizations(userId, newOrganizationIds, 3289 serviceContext); 3290 } 3291 3292 /** 3293 * Updates the user's password without tracking or validation of the change. 3294 * 3295 * @param userId the primary key of the user 3296 * @param password1 the user's new password 3297 * @param password2 the user's new password confirmation 3298 * @param passwordReset whether the user should be asked to reset their 3299 password the next time they log in 3300 * @return the user 3301 * @throws PortalException if a user with the primary key could not be found 3302 * @throws SystemException if a system exception occurred 3303 */ 3304 @Override 3305 public com.liferay.portal.model.User updatePassword(long userId, 3306 java.lang.String password1, java.lang.String password2, 3307 boolean passwordReset) 3308 throws com.liferay.portal.kernel.exception.PortalException, 3309 com.liferay.portal.kernel.exception.SystemException { 3310 return _userLocalService.updatePassword(userId, password1, password2, 3311 passwordReset); 3312 } 3313 3314 /** 3315 * Updates the user's password, optionally with tracking and validation of 3316 * the change. 3317 * 3318 * @param userId the primary key of the user 3319 * @param password1 the user's new password 3320 * @param password2 the user's new password confirmation 3321 * @param passwordReset whether the user should be asked to reset their 3322 password the next time they login 3323 * @param silentUpdate whether the password should be updated without being 3324 tracked, or validated. Primarily used for password imports. 3325 * @return the user 3326 * @throws PortalException if a user with the primary key could not be found 3327 * @throws SystemException if a system exception occurred 3328 */ 3329 @Override 3330 public com.liferay.portal.model.User updatePassword(long userId, 3331 java.lang.String password1, java.lang.String password2, 3332 boolean passwordReset, boolean silentUpdate) 3333 throws com.liferay.portal.kernel.exception.PortalException, 3334 com.liferay.portal.kernel.exception.SystemException { 3335 return _userLocalService.updatePassword(userId, password1, password2, 3336 passwordReset, silentUpdate); 3337 } 3338 3339 /** 3340 * Updates the user's password with manually input information. This method 3341 * should only be used when performing maintenance. 3342 * 3343 * @param userId the primary key of the user 3344 * @param password the user's new password 3345 * @param passwordEncrypted the user's new encrypted password 3346 * @param passwordReset whether the user should be asked to reset their 3347 password the next time they login 3348 * @param passwordModifiedDate the new password modified date 3349 * @return the user 3350 * @throws PortalException if a user with the primary key could not be found 3351 * @throws SystemException if a system exception occurred 3352 */ 3353 @Override 3354 public com.liferay.portal.model.User updatePasswordManually(long userId, 3355 java.lang.String password, boolean passwordEncrypted, 3356 boolean passwordReset, java.util.Date passwordModifiedDate) 3357 throws com.liferay.portal.kernel.exception.PortalException, 3358 com.liferay.portal.kernel.exception.SystemException { 3359 return _userLocalService.updatePasswordManually(userId, password, 3360 passwordEncrypted, passwordReset, passwordModifiedDate); 3361 } 3362 3363 /** 3364 * Updates whether the user should be asked to reset their password the next 3365 * time they login. 3366 * 3367 * @param userId the primary key of the user 3368 * @param passwordReset whether the user should be asked to reset their 3369 password the next time they login 3370 * @return the user 3371 * @throws PortalException if a user with the primary key could not be found 3372 * @throws SystemException if a system exception occurred 3373 */ 3374 @Override 3375 public com.liferay.portal.model.User updatePasswordReset(long userId, 3376 boolean passwordReset) 3377 throws com.liferay.portal.kernel.exception.PortalException, 3378 com.liferay.portal.kernel.exception.SystemException { 3379 return _userLocalService.updatePasswordReset(userId, passwordReset); 3380 } 3381 3382 /** 3383 * Updates the user's portrait image. 3384 * 3385 * @param userId the primary key of the user 3386 * @param bytes the new portrait image data 3387 * @return the user 3388 * @throws PortalException if a user with the primary key could not be found 3389 or if the new portrait was invalid 3390 * @throws SystemException if a system exception occurred 3391 */ 3392 @Override 3393 public com.liferay.portal.model.User updatePortrait(long userId, 3394 byte[] bytes) 3395 throws com.liferay.portal.kernel.exception.PortalException, 3396 com.liferay.portal.kernel.exception.SystemException { 3397 return _userLocalService.updatePortrait(userId, bytes); 3398 } 3399 3400 /** 3401 * Updates the user's password reset question and answer. 3402 * 3403 * @param userId the primary key of the user 3404 * @param question the user's new password reset question 3405 * @param answer the user's new password reset answer 3406 * @return the user 3407 * @throws PortalException if a user with the primary key could not be found 3408 or if the new question or answer were invalid 3409 * @throws SystemException if a system exception occurred 3410 */ 3411 @Override 3412 public com.liferay.portal.model.User updateReminderQuery(long userId, 3413 java.lang.String question, java.lang.String answer) 3414 throws com.liferay.portal.kernel.exception.PortalException, 3415 com.liferay.portal.kernel.exception.SystemException { 3416 return _userLocalService.updateReminderQuery(userId, question, answer); 3417 } 3418 3419 /** 3420 * Updates the user's screen name. 3421 * 3422 * @param userId the primary key of the user 3423 * @param screenName the user's new screen name 3424 * @return the user 3425 * @throws PortalException if a user with the primary key could not be found 3426 or if the new screen name was invalid 3427 * @throws SystemException if a system exception occurred 3428 */ 3429 @Override 3430 public com.liferay.portal.model.User updateScreenName(long userId, 3431 java.lang.String screenName) 3432 throws com.liferay.portal.kernel.exception.PortalException, 3433 com.liferay.portal.kernel.exception.SystemException { 3434 return _userLocalService.updateScreenName(userId, screenName); 3435 } 3436 3437 /** 3438 * Updates the user's workflow status. 3439 * 3440 * @param userId the primary key of the user 3441 * @param status the user's new workflow status 3442 * @return the user 3443 * @throws PortalException if a user with the primary key could not be 3444 found 3445 * @throws SystemException if a system exception occurred 3446 * @deprecated As of 7.0.0, replaced by {@link #updateStatus(long, int, 3447 ServiceContext)} 3448 */ 3449 @Override 3450 public com.liferay.portal.model.User updateStatus(long userId, int status) 3451 throws com.liferay.portal.kernel.exception.PortalException, 3452 com.liferay.portal.kernel.exception.SystemException { 3453 return _userLocalService.updateStatus(userId, status); 3454 } 3455 3456 /** 3457 * Updates the user's workflow status. 3458 * 3459 * @param userId the primary key of the user 3460 * @param status the user's new workflow status 3461 * @param serviceContext the service context to be applied. You can specify 3462 an unencrypted custom password (used by an LDAP listener) for the 3463 user via attribute <code>passwordUnencrypted</code>. 3464 * @return the user 3465 * @throws PortalException if a user with the primary key could not be found 3466 * @throws SystemException if a system exception occurred 3467 */ 3468 @Override 3469 public com.liferay.portal.model.User updateStatus(long userId, int status, 3470 com.liferay.portal.service.ServiceContext serviceContext) 3471 throws com.liferay.portal.kernel.exception.PortalException, 3472 com.liferay.portal.kernel.exception.SystemException { 3473 return _userLocalService.updateStatus(userId, status, serviceContext); 3474 } 3475 3476 /** 3477 * Updates the user. 3478 * 3479 * @param userId the primary key of the user 3480 * @param oldPassword the user's old password 3481 * @param newPassword1 the user's new password (optionally 3482 <code>null</code>) 3483 * @param newPassword2 the user's new password confirmation (optionally 3484 <code>null</code>) 3485 * @param passwordReset whether the user should be asked to reset their 3486 password the next time they login 3487 * @param reminderQueryQuestion the user's new password reset question 3488 * @param reminderQueryAnswer the user's new password reset answer 3489 * @param screenName the user's new screen name 3490 * @param emailAddress the user's new email address 3491 * @param facebookId the user's new Facebook ID 3492 * @param openId the user's new OpenID 3493 * @param languageId the user's new language ID 3494 * @param timeZoneId the user's new time zone ID 3495 * @param greeting the user's new greeting 3496 * @param comments the user's new comments 3497 * @param firstName the user's new first name 3498 * @param middleName the user's new middle name 3499 * @param lastName the user's new last name 3500 * @param prefixId the user's new name prefix ID 3501 * @param suffixId the user's new name suffix ID 3502 * @param male whether user is male 3503 * @param birthdayMonth the user's new birthday month (0-based, meaning 0 3504 for January) 3505 * @param birthdayDay the user's new birthday day 3506 * @param birthdayYear the user's birthday year 3507 * @param smsSn the user's new SMS screen name 3508 * @param aimSn the user's new AIM screen name 3509 * @param facebookSn the user's new Facebook screen name 3510 * @param icqSn the user's new ICQ screen name 3511 * @param jabberSn the user's new Jabber screen name 3512 * @param msnSn the user's new MSN screen name 3513 * @param mySpaceSn the user's new MySpace screen name 3514 * @param skypeSn the user's new Skype screen name 3515 * @param twitterSn the user's new Twitter screen name 3516 * @param ymSn the user's new Yahoo! Messenger screen name 3517 * @param jobTitle the user's new job title 3518 * @param groupIds the primary keys of the user's groups 3519 * @param organizationIds the primary keys of the user's organizations 3520 * @param roleIds the primary keys of the user's roles 3521 * @param userGroupRoles the user user's group roles 3522 * @param userGroupIds the primary keys of the user's user groups 3523 * @param serviceContext the service context to be applied (optionally 3524 <code>null</code>). Can set the UUID (with the <code>uuid</code> 3525 attribute), asset category IDs, asset tag names, and expando 3526 bridge attributes for the user. 3527 * @return the user 3528 * @throws PortalException if a user with the primary key could not be found 3529 or if the new information was invalid 3530 * @throws SystemException if a system exception occurred 3531 */ 3532 @Override 3533 public com.liferay.portal.model.User updateUser(long userId, 3534 java.lang.String oldPassword, java.lang.String newPassword1, 3535 java.lang.String newPassword2, boolean passwordReset, 3536 java.lang.String reminderQueryQuestion, 3537 java.lang.String reminderQueryAnswer, java.lang.String screenName, 3538 java.lang.String emailAddress, long facebookId, 3539 java.lang.String openId, java.lang.String languageId, 3540 java.lang.String timeZoneId, java.lang.String greeting, 3541 java.lang.String comments, java.lang.String firstName, 3542 java.lang.String middleName, java.lang.String lastName, int prefixId, 3543 int suffixId, boolean male, int birthdayMonth, int birthdayDay, 3544 int birthdayYear, java.lang.String smsSn, java.lang.String aimSn, 3545 java.lang.String facebookSn, java.lang.String icqSn, 3546 java.lang.String jabberSn, java.lang.String msnSn, 3547 java.lang.String mySpaceSn, java.lang.String skypeSn, 3548 java.lang.String twitterSn, java.lang.String ymSn, 3549 java.lang.String jobTitle, long[] groupIds, long[] organizationIds, 3550 long[] roleIds, 3551 java.util.List<com.liferay.portal.model.UserGroupRole> userGroupRoles, 3552 long[] userGroupIds, 3553 com.liferay.portal.service.ServiceContext serviceContext) 3554 throws com.liferay.portal.kernel.exception.PortalException, 3555 com.liferay.portal.kernel.exception.SystemException { 3556 return _userLocalService.updateUser(userId, oldPassword, newPassword1, 3557 newPassword2, passwordReset, reminderQueryQuestion, 3558 reminderQueryAnswer, screenName, emailAddress, facebookId, openId, 3559 languageId, timeZoneId, greeting, comments, firstName, middleName, 3560 lastName, prefixId, suffixId, male, birthdayMonth, birthdayDay, 3561 birthdayYear, smsSn, aimSn, facebookSn, icqSn, jabberSn, msnSn, 3562 mySpaceSn, skypeSn, twitterSn, ymSn, jobTitle, groupIds, 3563 organizationIds, roleIds, userGroupRoles, userGroupIds, 3564 serviceContext); 3565 } 3566 3567 /** 3568 * Verifies the email address of the ticket. 3569 * 3570 * @param ticketKey the ticket key 3571 * @throws PortalException if a ticket matching the ticket key could not be 3572 found, if the ticket has expired, if the ticket is an email 3573 address ticket, or if the email address is invalid 3574 * @throws SystemException if a system exception occurred 3575 */ 3576 @Override 3577 public void verifyEmailAddress(java.lang.String ticketKey) 3578 throws com.liferay.portal.kernel.exception.PortalException, 3579 com.liferay.portal.kernel.exception.SystemException { 3580 _userLocalService.verifyEmailAddress(ticketKey); 3581 } 3582 3583 /** 3584 * @deprecated As of 6.1.0, replaced by {@link #getWrappedService} 3585 */ 3586 public UserLocalService getWrappedUserLocalService() { 3587 return _userLocalService; 3588 } 3589 3590 /** 3591 * @deprecated As of 6.1.0, replaced by {@link #setWrappedService} 3592 */ 3593 public void setWrappedUserLocalService(UserLocalService userLocalService) { 3594 _userLocalService = userLocalService; 3595 } 3596 3597 @Override 3598 public UserLocalService getWrappedService() { 3599 return _userLocalService; 3600 } 3601 3602 @Override 3603 public void setWrappedService(UserLocalService userLocalService) { 3604 _userLocalService = userLocalService; 3605 } 3606 3607 private UserLocalService _userLocalService; 3608 }