UserLocalServiceImpl

java.lang.Object
- com.liferay.portal.service.BaseLocalServiceImpl
- - com.liferay.portal.service.base.UserLocalServiceBaseImpl
  - - com.liferay.portal.service.impl.UserLocalServiceImpl

All Implemented Interfaces:

com.liferay.portal.kernel.bean.IdentifiableBean, com.liferay.portal.service.BaseLocalService, com.liferay.portal.service.PersistedModelLocalService, com.liferay.portal.service.UserLocalService
```
public class UserLocalServiceImpl
extends UserLocalServiceBaseImpl
```
Provides the local service for accessing, adding, authenticating, deleting, and updating users.

Author:

Brian Wing Shun Chan, Scott Lee, Raymond Augé, Jorge Ferrer, Julio Camarero, Wesley Gong, Zsigmond Rab

Field Summary
- Fields inherited from class com.liferay.portal.service.base.UserLocalServiceBaseImpl
  accountLocalService, accountPersistence, accountService, addressLocalService, addressPersistence, addressService, announcementsDeliveryLocalService, announcementsDeliveryPersistence, announcementsDeliveryService, assetEntryFinder, assetEntryLocalService, assetEntryPersistence, assetEntryService, backgroundTaskLocalService, backgroundTaskPersistence, backgroundTaskService, blogsStatsUserFinder, blogsStatsUserLocalService, blogsStatsUserPersistence, browserTrackerLocalService, browserTrackerPersistence, classNameLocalService, classNamePersistence, classNameService, clusterGroupLocalService, clusterGroupPersistence, cmisRepositoryLocalService, companyLocalService, companyPersistence, companyService, contactLocalService, contactPersistence, contactService, counterLocalService, countryPersistence, countryService, dlFileRankFinder, dlFileRankLocalService, dlFileRankPersistence, emailAddressLocalService, emailAddressPersistence, emailAddressService, expandoRowLocalService, expandoRowPersistence, groupFinder, groupLocalService, groupPersistence, groupService, imageLocalService, imagePersistence, imageService, layoutBranchLocalService, layoutBranchPersistence, layoutBranchService, layoutFinder, layoutFriendlyURLLocalService, layoutFriendlyURLPersistence, layoutLocalService, layoutPersistence, layoutPrototypeLocalService, layoutPrototypePersistence, layoutPrototypeService, layoutRevisionLocalService, layoutRevisionPersistence, layoutRevisionService, layoutService, layoutSetBranchLocalService, layoutSetBranchPersistence, layoutSetBranchService, layoutSetLocalService, layoutSetPersistence, layoutSetPrototypeLocalService, layoutSetPrototypePersistence, layoutSetPrototypeService, layoutSetService, layoutTemplateLocalService, listTypePersistence, listTypeService, lockFinder, lockLocalService, lockPersistence, mailService, mbBanLocalService, mbBanPersistence, mbBanService, mbMessageFinder, mbMessageLocalService, mbMessagePersistence, mbMessageService, mbStatsUserLocalService, mbStatsUserPersistence, mbThreadFlagLocalService, mbThreadFlagPersistence, membershipRequestLocalService, membershipRequestPersistence, membershipRequestService, organizationFinder, organizationLocalService, organizationPersistence, organizationService, orgGroupRolePersistence, orgLaborLocalService, orgLaborPersistence, orgLaborService, passwordPolicyFinder, passwordPolicyLocalService, passwordPolicyPersistence, passwordPolicyRelLocalService, passwordPolicyRelPersistence, passwordPolicyService, passwordTrackerLocalService, passwordTrackerPersistence, permissionService, persistedModelLocalServiceRegistry, phoneLocalService, phonePersistence, phoneService, pluginSettingLocalService, pluginSettingPersistence, pluginSettingService, portalLocalService, portalPreferencesLocalService, portalPreferencesPersistence, portalService, portletItemLocalService, portletItemPersistence, portletLocalService, portletPersistence, portletPreferencesFinder, portletPreferencesLocalService, portletPreferencesPersistence, portletPreferencesService, portletService, quartzLocalService, regionPersistence, regionService, releaseLocalService, releasePersistence, repositoryEntryLocalService, repositoryEntryPersistence, repositoryLocalService, repositoryPersistence, repositoryService, resourceActionLocalService, resourceActionPersistence, resourceBlockFinder, resourceBlockLocalService, resourceBlockPermissionLocalService, resourceBlockPermissionPersistence, resourceBlockPersistence, resourceBlockService, resourceLocalService, resourcePermissionFinder, resourcePermissionLocalService, resourcePermissionPersistence, resourcePermissionService, resourceTypePermissionFinder, resourceTypePermissionLocalService, resourceTypePermissionPersistence, roleFinder, roleLocalService, rolePersistence, roleService, serviceComponentLocalService, serviceComponentPersistence, shardLocalService, shardPersistence, shoppingCartLocalService, shoppingCartPersistence, socialActivityFinder, socialActivityLocalService, socialActivityPersistence, socialActivityService, socialRequestLocalService, socialRequestPersistence, socialRequestService, stagingLocalService, stagingService, subscriptionLocalService, subscriptionPersistence, systemEventLocalService, systemEventPersistence, teamFinder, teamLocalService, teamPersistence, teamService, themeLocalService, themeService, ticketLocalService, ticketPersistence, userFinder, userGroupFinder, userGroupGroupRoleLocalService, userGroupGroupRolePersistence, userGroupGroupRoleService, userGroupLocalService, userGroupPersistence, userGroupRoleFinder, userGroupRoleLocalService, userGroupRolePersistence, userGroupRoleService, userGroupService, userIdMapperLocalService, userIdMapperPersistence, userLocalService, userNotificationDeliveryLocalService, userNotificationDeliveryPersistence, userNotificationEventLocalService, userNotificationEventPersistence, userPersistence, userService, userTrackerLocalService, userTrackerPathLocalService, userTrackerPathPersistence, userTrackerPersistence, virtualHostLocalService, virtualHostPersistence, webDAVPropsLocalService, webDAVPropsPersistence, websiteLocalService, websitePersistence, websiteService, workflowDefinitionLinkLocalService, workflowDefinitionLinkPersistence, workflowInstanceLinkLocalService, workflowInstanceLinkPersistence

Constructor Summary

Constructors
Constructor and Description

UserLocalServiceImpl()

Constructors
Constructor and Description
`UserLocalServiceImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`com.liferay.portal.model.User`	`addDefaultAdminUser(long companyId, java.lang.String screenName, java.lang.String emailAddress, java.util.Locale locale, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName)` Adds a default admin user for the company.
`void`	`addDefaultGroups(long userId)` Adds the user to the default groups, unless the user is already in these groups.
`void`	`addDefaultRoles(long userId)` Adds the user to the default roles, unless the user already has these roles.
`protected void`	`addDefaultRolesAndTeams(long groupId, long[] userIds)`
`void`	`addDefaultUserGroups(long userId)` Adds the user to the default user groups, unless the user is already in these user groups.
`void`	`addGroupUsers(long groupId, long[] userIds)` Adds the users to the group.
`void`	`addOrganizationUsers(long organizationId, long[] userIds)` Adds the users to the organization.
`void`	`addPasswordPolicyUsers(long passwordPolicyId, long[] userIds)` Assigns the password policy to the users, removing any other currently assigned password policies.
`void`	`addRoleUsers(long roleId, long[] userIds)` Adds the users to the role.
`void`	`addTeamUsers(long teamId, long[] userIds)` Adds the users to the team.
`com.liferay.portal.model.User`	addUser(long creatorUserId, long companyId, boolean autoPassword, java.lang.String password1, java.lang.String password2, boolean autoScreenName, java.lang.String screenName, java.lang.String emailAddress, long facebookId, java.lang.String openId, java.util.Locale locale, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName, int prefixId, int suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, java.lang.String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, com.liferay.portal.service.ServiceContext serviceContext) Adds a user.
`void`	`addUserGroupUsers(long userGroupId, long[] userIds)` Adds the users to the user group.
`com.liferay.portal.model.User`	addUserWithWorkflow(long creatorUserId, long companyId, boolean autoPassword, java.lang.String password1, java.lang.String password2, boolean autoScreenName, java.lang.String screenName, java.lang.String emailAddress, long facebookId, java.lang.String openId, java.util.Locale locale, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName, int prefixId, int suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, java.lang.String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, com.liferay.portal.service.ServiceContext serviceContext) Adds a user with workflow.
`void`	`afterPropertiesSet()`
`protected int`	`authenticate(long companyId, java.lang.String login, java.lang.String password, java.lang.String authType, java.util.Map<java.lang.String,java.lang.String[]> headerMap, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Map<java.lang.String,java.lang.Object> resultsMap)` Attempts to authenticate the user by their login and password, while using the AuthPipeline.
`int`	`authenticateByEmailAddress(long companyId, java.lang.String emailAddress, java.lang.String password, java.util.Map<java.lang.String,java.lang.String[]> headerMap, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Map<java.lang.String,java.lang.Object> resultsMap)` Attempts to authenticate the user by their email address and password, while using the AuthPipeline.
`int`	`authenticateByScreenName(long companyId, java.lang.String screenName, java.lang.String password, java.util.Map<java.lang.String,java.lang.String[]> headerMap, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Map<java.lang.String,java.lang.Object> resultsMap)` Attempts to authenticate the user by their screen name and password, while using the AuthPipeline.
`int`	`authenticateByUserId(long companyId, long userId, java.lang.String password, java.util.Map<java.lang.String,java.lang.String[]> headerMap, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Map<java.lang.String,java.lang.Object> resultsMap)` Attempts to authenticate the user by their primary key and password, while using the AuthPipeline.
`long`	`authenticateForBasic(long companyId, java.lang.String authType, java.lang.String login, java.lang.String password)` Attempts to authenticate the user using HTTP basic access authentication, without using the AuthPipeline.
`long`	`authenticateForDigest(long companyId, java.lang.String username, java.lang.String realm, java.lang.String nonce, java.lang.String method, java.lang.String uri, java.lang.String response)` Attempts to authenticate the user using HTTP digest access authentication, without using the AuthPipeline.
`boolean`	`authenticateForJAAS(long userId, java.lang.String encPassword)` Attempts to authenticate the user using JAAS credentials, without using the AuthPipeline.
`void`	`checkLockout(com.liferay.portal.model.User user)` Checks if the user is currently locked out based on the password policy, and performs maintenance on the user's lockout and failed login data.
`void`	`checkLoginFailure(com.liferay.portal.model.User user)` Adds a failed login attempt to the user and updates the user's last failed login date.
`void`	`checkLoginFailureByEmailAddress(long companyId, java.lang.String emailAddress)` Adds a failed login attempt to the user with the email address and updates the user's last failed login date.
`void`	`checkLoginFailureById(long userId)` Adds a failed login attempt to the user and updates the user's last failed login date.
`void`	`checkLoginFailureByScreenName(long companyId, java.lang.String screenName)` Adds a failed login attempt to the user with the screen name and updates the user's last failed login date.
`void`	`checkPasswordExpired(com.liferay.portal.model.User user)` Checks if the user's password is expired based on the password policy, and performs maintenance on the user's grace login and password reset data.
`void`	`clearOrganizationUsers(long organizationId)` Removes all the users from the organization.
`void`	`clearUserGroupUsers(long userGroupId)` Removes all the users from the user group.
`void`	`completeUserRegistration(com.liferay.portal.model.User user, com.liferay.portal.service.ServiceContext serviceContext)` Completes the user's registration by generating a password and sending the confirmation email.
`com.liferay.portal.kernel.util.KeyValuePair`	`decryptUserId(long companyId, java.lang.String name, java.lang.String password)` Decrypts the user's primary key and password from their encrypted forms.
`void`	`deletePortrait(long userId)` Deletes the user's portrait image.
`void`	`deleteRoleUser(long roleId, long userId)` Removes the user from the role.
`com.liferay.portal.model.User`	`deleteUser(long userId)` Deletes the user.
`com.liferay.portal.model.User`	`deleteUser(com.liferay.portal.model.User user)` Deletes the user.
`void`	`deleteUserGroupUser(long userGroupId, long userId)` Removes the user from the user group.
`java.lang.String`	`encryptUserId(java.lang.String name)` Encrypts the primary key of the user.
`com.liferay.portal.model.User`	`fetchUserByEmailAddress(long companyId, java.lang.String emailAddress)` Returns the user with the email address.
`com.liferay.portal.model.User`	`fetchUserByFacebookId(long companyId, long facebookId)` Returns the user with the Facebook ID.
`com.liferay.portal.model.User`	`fetchUserById(long userId)` Returns the user with the primary key.
`com.liferay.portal.model.User`	`fetchUserByOpenId(long companyId, java.lang.String openId)` Returns the user with the OpenID.
`com.liferay.portal.model.User`	`fetchUserByScreenName(long companyId, java.lang.String screenName)` Returns the user with the screen name.
`protected java.util.Date`	`getBirthday(int birthdayMonth, int birthdayDay, int birthdayYear)`
`java.util.List<com.liferay.portal.model.User>`	`getCompanyUsers(long companyId, int start, int end)` Returns a range of all the users belonging to the company.
`int`	`getCompanyUsersCount(long companyId)` Returns the number of users belonging to the company.
`com.liferay.portal.model.User`	`getDefaultUser(long companyId)` Returns the default user for the company.
`long`	`getDefaultUserId(long companyId)` Returns the primary key of the default user for the company.
`long[]`	`getGroupUserIds(long groupId)` Returns the primary keys of all the users belonging to the group.
`int`	`getGroupUsersCount(long groupId, int status)` Returns the number of users with the status belonging to the group.
`java.util.List<com.liferay.portal.model.User>`	`getInheritedRoleUsers(long roleId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)`
`protected java.lang.String`	`getLogin(java.lang.String login)`
`java.util.List<com.liferay.portal.model.User>`	`getNoAnnouncementsDeliveries(java.lang.String type)` Returns all the users who have not had any announcements of the type delivered, excluding the default user.
`java.util.List<com.liferay.portal.model.User>`	`getNoContacts()` Returns all the users who do not have any contacts.
`java.util.List<com.liferay.portal.model.User>`	`getNoGroups()` Returns all the users who do not belong to any groups, excluding the default user.
`long[]`	`getOrganizationUserIds(long organizationId)` Returns the primary keys of all the users belonging to the organization.
`int`	`getOrganizationUsersCount(long organizationId, int status)` Returns the number of users with the status belonging to the organization.
`long[]`	`getRoleUserIds(long roleId)` Returns the primary keys of all the users belonging to the role.
`int`	`getRoleUsersCount(long roleId, int status)` Returns the number of users with the status belonging to the role.
`java.util.List<com.liferay.portal.model.User>`	`getSocialUsers(long userId, int type, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)` Returns an ordered range of all the users with a social relation of the type with the user.
`java.util.List<com.liferay.portal.model.User>`	`getSocialUsers(long userId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)` Returns an ordered range of all the users with a social relation with the user.
`java.util.List<com.liferay.portal.model.User>`	`getSocialUsers(long userId1, long userId2, int type, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)` Returns an ordered range of all the users with a mutual social relation of the type with both of the given users.
`java.util.List<com.liferay.portal.model.User>`	`getSocialUsers(long userId1, long userId2, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)` Returns an ordered range of all the users with a mutual social relation with both of the given users.
`int`	`getSocialUsersCount(long userId)` Returns the number of users with a social relation with the user.
`int`	`getSocialUsersCount(long userId, int type)` Returns the number of users with a social relation of the type with the user.
`int`	`getSocialUsersCount(long userId1, long userId2)` Returns the number of users with a mutual social relation with both of the given users.
`int`	`getSocialUsersCount(long userId1, long userId2, int type)` Returns the number of users with a mutual social relation of the type with both of the given users.
`com.liferay.portal.model.User`	`getUserByContactId(long contactId)` Returns the user with the contact ID.
`com.liferay.portal.model.User`	`getUserByEmailAddress(long companyId, java.lang.String emailAddress)` Returns the user with the email address.
`com.liferay.portal.model.User`	`getUserByFacebookId(long companyId, long facebookId)` Returns the user with the Facebook ID.
`com.liferay.portal.model.User`	`getUserById(long userId)` Returns the user with the primary key.
`com.liferay.portal.model.User`	`getUserById(long companyId, long userId)` Returns the user with the primary key from the company.
`com.liferay.portal.model.User`	`getUserByOpenId(long companyId, java.lang.String openId)` Returns the user with the OpenID.
`com.liferay.portal.model.User`	`getUserByPortraitId(long portraitId)` Returns the user with the portrait ID.
`com.liferay.portal.model.User`	`getUserByScreenName(long companyId, java.lang.String screenName)` Returns the user with the screen name.
`com.liferay.portal.model.User`	`getUserByUuid(java.lang.String uuid)` Deprecated. As of 6.2.0, replaced by `getUserByUuidAndCompanyId(String, long)`
`com.liferay.portal.model.User`	`getUserByUuidAndCompanyId(java.lang.String uuid, long companyId)` Returns the user with the UUID.
`int`	`getUserGroupUsersCount(long userGroupId, int status)` Returns the number of users with the status belonging to the user group.
`long`	`getUserIdByEmailAddress(long companyId, java.lang.String emailAddress)` Returns the primary key of the user with the email address.
`long`	`getUserIdByScreenName(long companyId, java.lang.String screenName)` Returns the primary key of the user with the screen name.
`protected long[]`	`getUserIds(java.util.List<com.liferay.portal.model.User> users)`
`boolean`	`hasPasswordPolicyUser(long passwordPolicyId, long userId)` Returns `true` if the password policy has been assigned to the user.
`boolean`	`hasRoleUser(long companyId, java.lang.String name, long userId, boolean inherited)` Returns `true` if the user has the role with the name, optionally through inheritance.
`boolean`	`isPasswordExpired(com.liferay.portal.model.User user)` Returns `true` if the user's password is expired.
`boolean`	`isPasswordExpiringSoon(com.liferay.portal.model.User user)` Returns `true` if the password policy is configured to warn the user that his password is expiring and the remaining time until expiration is equal or less than the configured warning time.
`com.liferay.portal.model.User`	`loadGetDefaultUser(long companyId)` Returns the default user for the company.
`protected void`	`reindex(com.liferay.portal.model.User user)`
`java.util.List<com.liferay.portal.model.User>`	`search(long companyId, java.lang.String keywords, int status, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)` Returns an ordered range of all the users who match the keywords and status, without using the indexer.
`com.liferay.portal.kernel.search.Hits`	`search(long companyId, java.lang.String keywords, int status, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, com.liferay.portal.kernel.search.Sort sort)` Returns an ordered range of all the users who match the keywords and status, using the indexer.
`java.util.List<com.liferay.portal.model.User>`	`search(long companyId, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName, java.lang.String screenName, java.lang.String emailAddress, int status, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andSearch, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)` Returns an ordered range of all the users with the status, and whose first name, middle name, last name, screen name, and email address match the keywords specified for them, without using the indexer.
`com.liferay.portal.kernel.search.Hits`	`search(long companyId, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName, java.lang.String screenName, java.lang.String emailAddress, int status, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andSearch, int start, int end, com.liferay.portal.kernel.search.Sort sort)` Returns an ordered range of all the users with the status, and whose first name, middle name, last name, screen name, and email address match the keywords specified for them, using the indexer.
`protected com.liferay.portal.kernel.search.Hits`	`search(long companyId, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName, java.lang.String fullName, java.lang.String screenName, java.lang.String emailAddress, java.lang.String street, java.lang.String city, java.lang.String zip, java.lang.String region, java.lang.String country, int status, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andSearch, int start, int end, com.liferay.portal.kernel.search.Sort sort)`
`int`	`searchCount(long companyId, java.lang.String keywords, int status, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)` Returns the number of users who match the keywords and status.
`int`	`searchCount(long companyId, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName, java.lang.String screenName, java.lang.String emailAddress, int status, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andSearch)` Returns the number of users with the status, and whose first name, middle name, last name, screen name, and email address match the keywords specified for them.
`protected void`	`sendEmail(com.liferay.portal.model.User user, java.lang.String password, com.liferay.portal.service.ServiceContext serviceContext)`
`void`	`sendEmailAddressVerification(com.liferay.portal.model.User user, java.lang.String emailAddress, com.liferay.portal.service.ServiceContext serviceContext)` Sends an email address verification to the user.
`void`	`sendPassword(long companyId, java.lang.String emailAddress, java.lang.String fromName, java.lang.String fromAddress, java.lang.String subject, java.lang.String body, com.liferay.portal.service.ServiceContext serviceContext)` Sends the password email to the user with the email address.
`protected void`	`setEmailAddress(com.liferay.portal.model.User user, java.lang.String password, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName, java.lang.String emailAddress)`
`void`	`setRoleUsers(long roleId, long[] userIds)` Sets the users in the role, removing and adding users to the role as necessary.
`void`	`setUserGroupUsers(long userGroupId, long[] userIds)` Sets the users in the user group, removing and adding users to the user group as necessary.
`void`	`unsetGroupTeamsUsers(long groupId, long[] userIds)` Removes the users from the teams of a group.
`void`	`unsetGroupUsers(long groupId, long[] userIds, com.liferay.portal.service.ServiceContext serviceContext)` Removes the users from the group.
`void`	`unsetOrganizationUsers(long organizationId, long[] userIds)` Removes the users from the organization.
`void`	`unsetPasswordPolicyUsers(long passwordPolicyId, long[] userIds)` Removes the users from the password policy.
`void`	`unsetRoleUsers(long roleId, java.util.List<com.liferay.portal.model.User> users)` Removes the users from the role.
`void`	`unsetRoleUsers(long roleId, long[] userIds)` Removes the users from the role.
`void`	`unsetTeamUsers(long teamId, long[] userIds)` Removes the users from the team.
`void`	`unsetUserGroupUsers(long userGroupId, long[] userIds)` Removes the users from the user group.
`com.liferay.portal.model.User`	`updateAgreedToTermsOfUse(long userId, boolean agreedToTermsOfUse)` Updates whether the user has agreed to the terms of use.
`void`	`updateAsset(long userId, com.liferay.portal.model.User user, long[] assetCategoryIds, java.lang.String[] assetTagNames)` Updates the user's asset with the new asset categories and tag names, removing and adding asset categories and tag names as necessary.
`com.liferay.portal.model.User`	`updateCreateDate(long userId, java.util.Date createDate)` Updates the user's creation date.
`com.liferay.portal.model.User`	`updateEmailAddress(long userId, java.lang.String password, java.lang.String emailAddress1, java.lang.String emailAddress2)` Updates the user's email address.
`com.liferay.portal.model.User`	`updateEmailAddress(long userId, java.lang.String password, java.lang.String emailAddress1, java.lang.String emailAddress2, com.liferay.portal.service.ServiceContext serviceContext)` Updates the user's email address or sends verification email.
`com.liferay.portal.model.User`	`updateEmailAddressVerified(long userId, boolean emailAddressVerified)` Updates whether the user has verified email address.
`com.liferay.portal.model.User`	`updateFacebookId(long userId, long facebookId)` Updates the user's Facebook ID.
`void`	`updateGroups(long userId, long[] newGroupIds, com.liferay.portal.service.ServiceContext serviceContext)` Sets the groups the user is in, removing and adding groups as necessary.
`protected void`	`updateGroups(long userId, long[] newGroupIds, com.liferay.portal.service.ServiceContext serviceContext, boolean indexingEnabled)`
`com.liferay.portal.model.User`	updateIncompleteUser(long creatorUserId, long companyId, boolean autoPassword, java.lang.String password1, java.lang.String password2, boolean autoScreenName, java.lang.String screenName, java.lang.String emailAddress, long facebookId, java.lang.String openId, java.util.Locale locale, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName, int prefixId, int suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, java.lang.String jobTitle, boolean updateUserInformation, boolean sendEmail, com.liferay.portal.service.ServiceContext serviceContext) Updates a user account that was automatically created when a guest user participated in an action (e.g. posting a comment) and only provided his name and email address.
`com.liferay.portal.model.User`	`updateJobTitle(long userId, java.lang.String jobTitle)` Updates the user's job title.
`com.liferay.portal.model.User`	`updateLastLogin(long userId, java.lang.String loginIP)` Updates the user's last login with the current time and the IP address.
`com.liferay.portal.model.User`	`updateLockout(com.liferay.portal.model.User user, boolean lockout)` Updates whether the user is locked out from logging in.
`com.liferay.portal.model.User`	`updateLockoutByEmailAddress(long companyId, java.lang.String emailAddress, boolean lockout)` Updates whether the user is locked out from logging in.
`com.liferay.portal.model.User`	`updateLockoutById(long userId, boolean lockout)` Updates whether the user is locked out from logging in.
`com.liferay.portal.model.User`	`updateLockoutByScreenName(long companyId, java.lang.String screenName, boolean lockout)` Updates whether the user is locked out from logging in.
`com.liferay.portal.model.User`	`updateModifiedDate(long userId, java.util.Date modifiedDate)` Updates the user's modified date.
`com.liferay.portal.model.User`	`updateOpenId(long userId, java.lang.String openId)` Updates the user's OpenID.
`protected void`	`updateOrganizations(long userId, long[] newOrganizationIds, boolean indexingEnabled)`
`void`	`updateOrganizations(long userId, long[] newOrganizationIds, com.liferay.portal.service.ServiceContext serviceContext)` Sets the organizations that the user is in, removing and adding organizations as necessary.
`com.liferay.portal.model.User`	`updatePassword(long userId, java.lang.String password1, java.lang.String password2, boolean passwordReset)` Updates the user's password without tracking or validation of the change.
`com.liferay.portal.model.User`	`updatePassword(long userId, java.lang.String password1, java.lang.String password2, boolean passwordReset, boolean silentUpdate)` Updates the user's password, optionally with tracking and validation of the change.
`com.liferay.portal.model.User`	`updatePasswordManually(long userId, java.lang.String password, boolean passwordEncrypted, boolean passwordReset, java.util.Date passwordModifiedDate)` Updates the user's password with manually input information.
`com.liferay.portal.model.User`	`updatePasswordReset(long userId, boolean passwordReset)` Updates whether the user should be asked to reset their password the next time they login.
`com.liferay.portal.model.User`	`updatePortrait(long userId, byte[] bytes)` Updates the user's portrait image.
`com.liferay.portal.model.User`	`updateReminderQuery(long userId, java.lang.String question, java.lang.String answer)` Updates the user's password reset question and answer.
`com.liferay.portal.model.User`	`updateScreenName(long userId, java.lang.String screenName)` Updates the user's screen name.
`com.liferay.portal.model.User`	`updateStatus(long userId, int status)` Deprecated. As of 7.0.0, replaced by `updateStatus(long, int, ServiceContext)`
`com.liferay.portal.model.User`	`updateStatus(long userId, int status, com.liferay.portal.service.ServiceContext serviceContext)` Updates the user's workflow status.
`com.liferay.portal.model.User`	updateUser(long userId, java.lang.String oldPassword, java.lang.String newPassword1, java.lang.String newPassword2, boolean passwordReset, java.lang.String reminderQueryQuestion, java.lang.String reminderQueryAnswer, java.lang.String screenName, java.lang.String emailAddress, long facebookId, java.lang.String openId, java.lang.String languageId, java.lang.String timeZoneId, java.lang.String greeting, java.lang.String comments, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName, int prefixId, int suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, java.lang.String smsSn, java.lang.String aimSn, java.lang.String facebookSn, java.lang.String icqSn, java.lang.String jabberSn, java.lang.String msnSn, java.lang.String mySpaceSn, java.lang.String skypeSn, java.lang.String twitterSn, java.lang.String ymSn, java.lang.String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, java.util.List<com.liferay.portal.model.UserGroupRole> userGroupRoles, long[] userGroupIds, com.liferay.portal.service.ServiceContext serviceContext) Updates the user.
`protected void`	`updateUserGroupRoles(com.liferay.portal.model.User user, long[] groupIds, long[] organizationIds, java.util.List<com.liferay.portal.model.UserGroupRole> userGroupRoles, java.util.List<com.liferay.portal.model.UserGroupRole> previousUserGroupRoles)`
`protected void`	`validate(long companyId, long userId, boolean autoPassword, java.lang.String password1, java.lang.String password2, boolean autoScreenName, java.lang.String screenName, java.lang.String emailAddress, java.lang.String openId, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName, long[] organizationIds)`
`protected void`	`validate(long userId, java.lang.String screenName, java.lang.String emailAddress, java.lang.String openId, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName, java.lang.String smsSn)`
`protected void`	`validateCompanyMaxUsers(long companyId)`
`protected void`	`validateEmailAddress(long companyId, java.lang.String emailAddress)`
`protected void`	`validateEmailAddress(com.liferay.portal.model.User user, java.lang.String emailAddress1, java.lang.String emailAddress2)`
`protected void`	`validateFullName(long companyId, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName)`
`protected void`	`validateOpenId(long companyId, long userId, java.lang.String openId)`
`protected void`	`validatePassword(long companyId, long userId, java.lang.String password1, java.lang.String password2)`
`protected void`	`validateReminderQuery(java.lang.String question, java.lang.String answer)`
`protected void`	`validateScreenName(long companyId, long userId, java.lang.String screenName)`
`void`	`verifyEmailAddress(java.lang.String ticketKey)` Verifies the email address of the ticket.

Methods inherited from class com.liferay.portal.service.base.UserLocalServiceBaseImpl
addGroupUser, addGroupUser, addGroupUsers, addOrganizationUser, addOrganizationUser, addOrganizationUsers, addRoleUser, addRoleUser, addRoleUsers, addTeamUser, addTeamUser, addTeamUsers, addUser, addUserGroupUser, addUserGroupUser, addUserGroupUsers, clearGroupUsers, clearRoleUsers, clearTeamUsers, createUser, deleteGroupUser, deleteGroupUser, deleteGroupUsers, deleteGroupUsers, deleteOrganizationUser, deleteOrganizationUser, deleteOrganizationUsers, deleteOrganizationUsers, deleteRoleUser, deleteRoleUsers, deleteRoleUsers, deleteTeamUser, deleteTeamUser, deleteTeamUsers, deleteTeamUsers, deleteUserGroupUser, deleteUserGroupUsers, deleteUserGroupUsers, destroy, dynamicQuery, dynamicQuery, dynamicQuery, dynamicQuery, dynamicQueryCount, dynamicQueryCount, fetchUser, fetchUserByUuidAndCompanyId, getAccountLocalService, getAccountPersistence, getAccountService, getAddressLocalService, getAddressPersistence, getAddressService, getAnnouncementsDeliveryLocalService, getAnnouncementsDeliveryPersistence, getAnnouncementsDeliveryService, getAssetEntryFinder, getAssetEntryLocalService, getAssetEntryPersistence, getAssetEntryService, getBackgroundTaskLocalService, getBackgroundTaskPersistence, getBackgroundTaskService, getBeanIdentifier, getBlogsStatsUserFinder, getBlogsStatsUserLocalService, getBlogsStatsUserPersistence, getBrowserTrackerLocalService, getBrowserTrackerPersistence, getClassNameLocalService, getClassNamePersistence, getClassNameService, getClusterGroupLocalService, getClusterGroupPersistence, getCMISRepositoryLocalService, getCompanyLocalService, getCompanyPersistence, getCompanyService, getContactLocalService, getContactPersistence, getContactService, getCounterLocalService, getCountryPersistence, getCountryService, getDLFileRankFinder, getDLFileRankLocalService, getDLFileRankPersistence, getEmailAddressLocalService, getEmailAddressPersistence, getEmailAddressService, getExpandoRowLocalService, getExpandoRowPersistence, getGroupFinder, getGroupLocalService, getGroupPersistence, getGroupService, getGroupUsers, getGroupUsers, getGroupUsers, getGroupUsersCount, getImageLocalService, getImagePersistence, getImageService, getLayoutBranchLocalService, getLayoutBranchPersistence, getLayoutBranchService, getLayoutFinder, getLayoutFriendlyURLLocalService, getLayoutFriendlyURLPersistence, getLayoutLocalService, getLayoutPersistence, getLayoutPrototypeLocalService, getLayoutPrototypePersistence, getLayoutPrototypeService, getLayoutRevisionLocalService, getLayoutRevisionPersistence, getLayoutRevisionService, getLayoutService, getLayoutSetBranchLocalService, getLayoutSetBranchPersistence, getLayoutSetBranchService, getLayoutSetLocalService, getLayoutSetPersistence, getLayoutSetPrototypeLocalService, getLayoutSetPrototypePersistence, getLayoutSetPrototypeService, getLayoutSetService, getLayoutTemplateLocalService, getListTypePersistence, getListTypeService, getLockFinder, getLockLocalService, getLockPersistence, getMailService, getMBBanLocalService, getMBBanPersistence, getMBBanService, getMBMessageFinder, getMBMessageLocalService, getMBMessagePersistence, getMBMessageService, getMBStatsUserLocalService, getMBStatsUserPersistence, getMBThreadFlagLocalService, getMBThreadFlagPersistence, getMembershipRequestLocalService, getMembershipRequestPersistence, getMembershipRequestService, getModelClass, getModelClassName, getOrganizationFinder, getOrganizationLocalService, getOrganizationPersistence, getOrganizationService, getOrganizationUsers, getOrganizationUsers, getOrganizationUsers, getOrganizationUsersCount, getOrgGroupRolePersistence, getOrgLaborLocalService, getOrgLaborPersistence, getOrgLaborService, getPasswordPolicyFinder, getPasswordPolicyLocalService, getPasswordPolicyPersistence, getPasswordPolicyRelLocalService, getPasswordPolicyRelPersistence, getPasswordPolicyService, getPasswordTrackerLocalService, getPasswordTrackerPersistence, getPermissionService, getPersistedModel, getPhoneLocalService, getPhonePersistence, getPhoneService, getPluginSettingLocalService, getPluginSettingPersistence, getPluginSettingService, getPortalLocalService, getPortalPreferencesLocalService, getPortalPreferencesPersistence, getPortalService, getPortletItemLocalService, getPortletItemPersistence, getPortletLocalService, getPortletPersistence, getPortletPreferencesFinder, getPortletPreferencesLocalService, getPortletPreferencesPersistence, getPortletPreferencesService, getPortletService, getQuartzLocalService, getRegionPersistence, getRegionService, getReleaseLocalService, getReleasePersistence, getRepositoryEntryLocalService, getRepositoryEntryPersistence, getRepositoryLocalService, getRepositoryPersistence, getRepositoryService, getResourceActionLocalService, getResourceActionPersistence, getResourceBlockFinder, getResourceBlockLocalService, getResourceBlockPermissionLocalService, getResourceBlockPermissionPersistence, getResourceBlockPersistence, getResourceBlockService, getResourceLocalService, getResourcePermissionFinder, getResourcePermissionLocalService, getResourcePermissionPersistence, getResourcePermissionService, getResourceTypePermissionFinder, getResourceTypePermissionLocalService, getResourceTypePermissionPersistence, getRoleFinder, getRoleLocalService, getRolePersistence, getRoleService, getRoleUsers, getRoleUsers, getRoleUsers, getRoleUsersCount, getServiceComponentLocalService, getServiceComponentPersistence, getShardLocalService, getShardPersistence, getShoppingCartLocalService, getShoppingCartPersistence, getSocialActivityFinder, getSocialActivityLocalService, getSocialActivityPersistence, getSocialActivityService, getSocialRequestLocalService, getSocialRequestPersistence, getSocialRequestService, getStagingLocalService, getStagingService, getSubscriptionLocalService, getSubscriptionPersistence, getSystemEventLocalService, getSystemEventPersistence, getTeamFinder, getTeamLocalService, getTeamPersistence, getTeamService, getTeamUsers, getTeamUsers, getTeamUsers, getTeamUsersCount, getThemeLocalService, getThemeService, getTicketLocalService, getTicketPersistence, getUser, getUserFinder, getUserGroupFinder, getUserGroupGroupRoleLocalService, getUserGroupGroupRolePersistence, getUserGroupGroupRoleService, getUserGroupLocalService, getUserGroupPersistence, getUserGroupRoleFinder, getUserGroupRoleLocalService, getUserGroupRolePersistence, getUserGroupRoleService, getUserGroupService, getUserGroupUsers, getUserGroupUsers, getUserGroupUsers, getUserGroupUsersCount, getUserIdMapperLocalService, getUserIdMapperPersistence, getUserLocalService, getUserNotificationDeliveryLocalService, getUserNotificationDeliveryPersistence, getUserNotificationEventLocalService, getUserNotificationEventPersistence, getUserPersistence, getUsers, getUsersCount, getUserService, getUserTrackerLocalService, getUserTrackerPathLocalService, getUserTrackerPathPersistence, getUserTrackerPersistence, getVirtualHostLocalService, getVirtualHostPersistence, getWebDAVPropsLocalService, getWebDAVPropsPersistence, getWebsiteLocalService, getWebsitePersistence, getWebsiteService, getWorkflowDefinitionLinkLocalService, getWorkflowDefinitionLinkPersistence, getWorkflowInstanceLinkLocalService, getWorkflowInstanceLinkPersistence, hasGroupUser, hasGroupUsers, hasOrganizationUser, hasOrganizationUsers, hasRoleUser, hasRoleUsers, hasTeamUser, hasTeamUsers, hasUserGroupUser, hasUserGroupUsers, runSQL, setAccountLocalService, setAccountPersistence, setAccountService, setAddressLocalService, setAddressPersistence, setAddressService, setAnnouncementsDeliveryLocalService, setAnnouncementsDeliveryPersistence, setAnnouncementsDeliveryService, setAssetEntryFinder, setAssetEntryLocalService, setAssetEntryPersistence, setAssetEntryService, setBackgroundTaskLocalService, setBackgroundTaskPersistence, setBackgroundTaskService, setBeanIdentifier, setBlogsStatsUserFinder, setBlogsStatsUserLocalService, setBlogsStatsUserPersistence, setBrowserTrackerLocalService, setBrowserTrackerPersistence, setClassNameLocalService, setClassNamePersistence, setClassNameService, setClusterGroupLocalService, setClusterGroupPersistence, setCMISRepositoryLocalService, setCompanyLocalService, setCompanyPersistence, setCompanyService, setContactLocalService, setContactPersistence, setContactService, setCounterLocalService, setCountryPersistence, setCountryService, setDLFileRankFinder, setDLFileRankLocalService, setDLFileRankPersistence, setEmailAddressLocalService, setEmailAddressPersistence, setEmailAddressService, setExpandoRowLocalService, setExpandoRowPersistence, setGroupFinder, setGroupLocalService, setGroupPersistence, setGroupService, setGroupUsers, setImageLocalService, setImagePersistence, setImageService, setLayoutBranchLocalService, setLayoutBranchPersistence, setLayoutBranchService, setLayoutFinder, setLayoutFriendlyURLLocalService, setLayoutFriendlyURLPersistence, setLayoutLocalService, setLayoutPersistence, setLayoutPrototypeLocalService, setLayoutPrototypePersistence, setLayoutPrototypeService, setLayoutRevisionLocalService, setLayoutRevisionPersistence, setLayoutRevisionService, setLayoutService, setLayoutSetBranchLocalService, setLayoutSetBranchPersistence, setLayoutSetBranchService, setLayoutSetLocalService, setLayoutSetPersistence, setLayoutSetPrototypeLocalService, setLayoutSetPrototypePersistence, setLayoutSetPrototypeService, setLayoutSetService, setLayoutTemplateLocalService, setListTypePersistence, setListTypeService, setLockFinder, setLockLocalService, setLockPersistence, setMailService, setMBBanLocalService, setMBBanPersistence, setMBBanService, setMBMessageFinder, setMBMessageLocalService, setMBMessagePersistence, setMBMessageService, setMBStatsUserLocalService, setMBStatsUserPersistence, setMBThreadFlagLocalService, setMBThreadFlagPersistence, setMembershipRequestLocalService, setMembershipRequestPersistence, setMembershipRequestService, setOrganizationFinder, setOrganizationLocalService, setOrganizationPersistence, setOrganizationService, setOrganizationUsers, setOrgGroupRolePersistence, setOrgLaborLocalService, setOrgLaborPersistence, setOrgLaborService, setPasswordPolicyFinder, setPasswordPolicyLocalService, setPasswordPolicyPersistence, setPasswordPolicyRelLocalService, setPasswordPolicyRelPersistence, setPasswordPolicyService, setPasswordTrackerLocalService, setPasswordTrackerPersistence, setPermissionService, setPhoneLocalService, setPhonePersistence, setPhoneService, setPluginSettingLocalService, setPluginSettingPersistence, setPluginSettingService, setPortalLocalService, setPortalPreferencesLocalService, setPortalPreferencesPersistence, setPortalService, setPortletItemLocalService, setPortletItemPersistence, setPortletLocalService, setPortletPersistence, setPortletPreferencesFinder, setPortletPreferencesLocalService, setPortletPreferencesPersistence, setPortletPreferencesService, setPortletService, setQuartzLocalService, setRegionPersistence, setRegionService, setReleaseLocalService, setReleasePersistence, setRepositoryEntryLocalService, setRepositoryEntryPersistence, setRepositoryLocalService, setRepositoryPersistence, setRepositoryService, setResourceActionLocalService, setResourceActionPersistence, setResourceBlockFinder, setResourceBlockLocalService, setResourceBlockPermissionLocalService, setResourceBlockPermissionPersistence, setResourceBlockPersistence, setResourceBlockService, setResourceLocalService, setResourcePermissionFinder, setResourcePermissionLocalService, setResourcePermissionPersistence, setResourcePermissionService, setResourceTypePermissionFinder, setResourceTypePermissionLocalService, setResourceTypePermissionPersistence, setRoleFinder, setRoleLocalService, setRolePersistence, setRoleService, setServiceComponentLocalService, setServiceComponentPersistence, setShardLocalService, setShardPersistence, setShoppingCartLocalService, setShoppingCartPersistence, setSocialActivityFinder, setSocialActivityLocalService, setSocialActivityPersistence, setSocialActivityService, setSocialRequestLocalService, setSocialRequestPersistence, setSocialRequestService, setStagingLocalService, setStagingService, setSubscriptionLocalService, setSubscriptionPersistence, setSystemEventLocalService, setSystemEventPersistence, setTeamFinder, setTeamLocalService, setTeamPersistence, setTeamService, setTeamUsers, setThemeLocalService, setThemeService, setTicketLocalService, setTicketPersistence, setUserFinder, setUserGroupFinder, setUserGroupGroupRoleLocalService, setUserGroupGroupRolePersistence, setUserGroupGroupRoleService, setUserGroupLocalService, setUserGroupPersistence, setUserGroupRoleFinder, setUserGroupRoleLocalService, setUserGroupRolePersistence, setUserGroupRoleService, setUserGroupService, setUserIdMapperLocalService, setUserIdMapperPersistence, setUserLocalService, setUserNotificationDeliveryLocalService, setUserNotificationDeliveryPersistence, setUserNotificationEventLocalService, setUserNotificationEventPersistence, setUserPersistence, setUserService, setUserTrackerLocalService, setUserTrackerPathLocalService, setUserTrackerPathPersistence, setUserTrackerPersistence, setVirtualHostLocalService, setVirtualHostPersistence, setWebDAVPropsLocalService, setWebDAVPropsPersistence, setWebsiteLocalService, setWebsitePersistence, setWebsiteService, setWorkflowDefinitionLinkLocalService, setWorkflowDefinitionLinkPersistence, setWorkflowInstanceLinkLocalService, setWorkflowInstanceLinkPersistence, updateUser

Methods inherited from class com.liferay.portal.service.BaseLocalServiceImpl
getClassLoader, getLayoutURL, getLayoutURL

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - UserLocalServiceImpl
```
public UserLocalServiceImpl()
```
- Method Detail
  - addDefaultAdminUser
```
public com.liferay.portal.model.User addDefaultAdminUser(long companyId,
                                                java.lang.String screenName,
                                                java.lang.String emailAddress,
                                                java.util.Locale locale,
                                                java.lang.String firstName,
                                                java.lang.String middleName,
                                                java.lang.String lastName)
                                                  throws com.liferay.portal.kernel.exception.PortalException,
                                                         com.liferay.portal.kernel.exception.SystemException
```
    Adds a default admin user for the company.
    
    Parameters:
    companyId - the primary key of the user's company
    screenName - the user's screen name
    emailAddress - the user's email address
    locale - the user's locale
    firstName - the user's first name
    middleName - the user's middle name
    lastName - the user's last name
    
    Returns:
    the new default admin user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - n if a portal exception occurred
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - addDefaultGroups
```
public void addDefaultGroups(long userId)
                      throws com.liferay.portal.kernel.exception.PortalException,
                             com.liferay.portal.kernel.exception.SystemException
```
    Adds the user to the default groups, unless the user is already in these groups. The default groups can be specified in portal.properties with the key admin.default.group.names.
    
    Parameters:
    userId - the primary key of the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - addDefaultRoles
```
public void addDefaultRoles(long userId)
                     throws com.liferay.portal.kernel.exception.PortalException,
                            com.liferay.portal.kernel.exception.SystemException
```
    Adds the user to the default roles, unless the user already has these roles. The default roles can be specified in portal.properties with the key admin.default.role.names.
    
    Parameters:
    userId - the primary key of the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - addDefaultUserGroups
```
public void addDefaultUserGroups(long userId)
                          throws com.liferay.portal.kernel.exception.PortalException,
                                 com.liferay.portal.kernel.exception.SystemException
```
    Adds the user to the default user groups, unless the user is already in these user groups. The default user groups can be specified in portal.properties with the property admin.default.user.group.names.
    
    Parameters:
    userId - the primary key of the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - addGroupUsers
```
public void addGroupUsers(long groupId,
                 long[] userIds)
                   throws com.liferay.portal.kernel.exception.PortalException,
                          com.liferay.portal.kernel.exception.SystemException
```
    Adds the users to the group.
    
    Specified by:
    
    addGroupUsers in interface com.liferay.portal.service.UserLocalService
    
    Overrides:
    
    addGroupUsers in class UserLocalServiceBaseImpl
    
    Parameters:
    groupId - the primary key of the group
    userIds - the primary keys of the users
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a group or user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - addOrganizationUsers
```
public void addOrganizationUsers(long organizationId,
                        long[] userIds)
                          throws com.liferay.portal.kernel.exception.PortalException,
                                 com.liferay.portal.kernel.exception.SystemException
```
    Adds the users to the organization.
    
    Specified by:
    
    addOrganizationUsers in interface com.liferay.portal.service.UserLocalService
    
    Overrides:
    
    addOrganizationUsers in class UserLocalServiceBaseImpl
    
    Parameters:
    organizationId - the primary key of the organization
    userIds - the primary keys of the users
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if an organization or user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - addPasswordPolicyUsers
```
public void addPasswordPolicyUsers(long passwordPolicyId,
                          long[] userIds)
                            throws com.liferay.portal.kernel.exception.SystemException
```
    Assigns the password policy to the users, removing any other currently assigned password policies.
    
    Parameters:
    passwordPolicyId - the primary key of the password policy
    userIds - the primary keys of the users
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - addRoleUsers
```
public void addRoleUsers(long roleId,
                long[] userIds)
                  throws com.liferay.portal.kernel.exception.PortalException,
                         com.liferay.portal.kernel.exception.SystemException
```
    Adds the users to the role.
    
    Specified by:
    
    addRoleUsers in interface com.liferay.portal.service.UserLocalService
    
    Overrides:
    
    addRoleUsers in class UserLocalServiceBaseImpl
    
    Parameters:
    roleId - the primary key of the role
    userIds - the primary keys of the users
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a role or user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - addTeamUsers
```
public void addTeamUsers(long teamId,
                long[] userIds)
                  throws com.liferay.portal.kernel.exception.PortalException,
                         com.liferay.portal.kernel.exception.SystemException
```
    Adds the users to the team.
    
    Specified by:
    
    addTeamUsers in interface com.liferay.portal.service.UserLocalService
    
    Overrides:
    
    addTeamUsers in class UserLocalServiceBaseImpl
    
    Parameters:
    teamId - the primary key of the team
    userIds - the primary keys of the users
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a team or user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - addUser
```
public com.liferay.portal.model.User addUser(long creatorUserId,
                                    long companyId,
                                    boolean autoPassword,
                                    java.lang.String password1,
                                    java.lang.String password2,
                                    boolean autoScreenName,
                                    java.lang.String screenName,
                                    java.lang.String emailAddress,
                                    long facebookId,
                                    java.lang.String openId,
                                    java.util.Locale locale,
                                    java.lang.String firstName,
                                    java.lang.String middleName,
                                    java.lang.String lastName,
                                    int prefixId,
                                    int suffixId,
                                    boolean male,
                                    int birthdayMonth,
                                    int birthdayDay,
                                    int birthdayYear,
                                    java.lang.String jobTitle,
                                    long[] groupIds,
                                    long[] organizationIds,
                                    long[] roleIds,
                                    long[] userGroupIds,
                                    boolean sendEmail,
                                    com.liferay.portal.service.ServiceContext serviceContext)
                                      throws com.liferay.portal.kernel.exception.PortalException,
                                             com.liferay.portal.kernel.exception.SystemException
```
    Adds a user.
    This method handles the creation and bookkeeping of the user including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, etc.
    
    Parameters:
    creatorUserId - the primary key of the creator
    companyId - the primary key of the user's company
    autoPassword - whether a password should be automatically generated for the user
    password1 - the user's password
    password2 - the user's password confirmation
    autoScreenName - whether a screen name should be automatically generated for the user
    screenName - the user's screen name
    emailAddress - the user's email address
    facebookId - the user's facebook ID
    openId - the user's OpenID
    locale - the user's locale
    firstName - the user's first name
    middleName - the user's middle name
    lastName - the user's last name
    prefixId - the user's name prefix ID
    suffixId - the user's name suffix ID
    male - whether the user is male
    birthdayMonth - the user's birthday month (0-based, meaning 0 for January)
    birthdayDay - the user's birthday day
    birthdayYear - the user's birthday year
    jobTitle - the user's job title
    groupIds - the primary keys of the user's groups
    organizationIds - the primary keys of the user's organizations
    roleIds - the primary keys of the roles this user possesses
    userGroupIds - the primary keys of the user's user groups
    sendEmail - whether to send the user an email notification about their new account
    serviceContext - the service context to be applied (optionally null). Can set the UUID (with the uuid attribute), asset category IDs, asset tag names, and expando bridge attributes for the user.
    
    Returns:
    the new user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if the user's information was invalid
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - addUserGroupUsers
```
public void addUserGroupUsers(long userGroupId,
                     long[] userIds)
                       throws com.liferay.portal.kernel.exception.PortalException,
                              com.liferay.portal.kernel.exception.SystemException
```
    Adds the users to the user group.
    
    Specified by:
    
    addUserGroupUsers in interface com.liferay.portal.service.UserLocalService
    
    Overrides:
    
    addUserGroupUsers in class UserLocalServiceBaseImpl
    
    Parameters:
    userGroupId - the primary key of the user group
    userIds - the primary keys of the users
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user group or user with the primary could could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - addUserWithWorkflow
```
public com.liferay.portal.model.User addUserWithWorkflow(long creatorUserId,
                                                long companyId,
                                                boolean autoPassword,
                                                java.lang.String password1,
                                                java.lang.String password2,
                                                boolean autoScreenName,
                                                java.lang.String screenName,
                                                java.lang.String emailAddress,
                                                long facebookId,
                                                java.lang.String openId,
                                                java.util.Locale locale,
                                                java.lang.String firstName,
                                                java.lang.String middleName,
                                                java.lang.String lastName,
                                                int prefixId,
                                                int suffixId,
                                                boolean male,
                                                int birthdayMonth,
                                                int birthdayDay,
                                                int birthdayYear,
                                                java.lang.String jobTitle,
                                                long[] groupIds,
                                                long[] organizationIds,
                                                long[] roleIds,
                                                long[] userGroupIds,
                                                boolean sendEmail,
                                                com.liferay.portal.service.ServiceContext serviceContext)
                                                  throws com.liferay.portal.kernel.exception.PortalException,
                                                         com.liferay.portal.kernel.exception.SystemException
```
    Adds a user with workflow.
    This method handles the creation and bookkeeping of the user including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, etc.
    
    Parameters:
    creatorUserId - the primary key of the creator
    companyId - the primary key of the user's company
    autoPassword - whether a password should be automatically generated for the user
    password1 - the user's password
    password2 - the user's password confirmation
    autoScreenName - whether a screen name should be automatically generated for the user
    screenName - the user's screen name
    emailAddress - the user's email address
    facebookId - the user's facebook ID
    openId - the user's OpenID
    locale - the user's locale
    firstName - the user's first name
    middleName - the user's middle name
    lastName - the user's last name
    prefixId - the user's name prefix ID
    suffixId - the user's name suffix ID
    male - whether the user is male
    birthdayMonth - the user's birthday month (0-based, meaning 0 for January)
    birthdayDay - the user's birthday day
    birthdayYear - the user's birthday year
    jobTitle - the user's job title
    groupIds - the primary keys of the user's groups
    organizationIds - the primary keys of the user's organizations
    roleIds - the primary keys of the roles this user possesses
    userGroupIds - the primary keys of the user's user groups
    sendEmail - whether to send the user an email notification about their new account
    serviceContext - the service context to be applied (optionally null). Can set the UUID (with the uuid attribute), asset category IDs, asset tag names, and expando bridge attributes for the user.
    
    Returns:
    the new user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if the user's information was invalid
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - afterPropertiesSet
```
public void afterPropertiesSet()
```
    Overrides:
    
    afterPropertiesSet in class UserLocalServiceBaseImpl
  - authenticateByEmailAddress
```
public int authenticateByEmailAddress(long companyId,
                             java.lang.String emailAddress,
                             java.lang.String password,
                             java.util.Map<java.lang.String,java.lang.String[]> headerMap,
                             java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                             java.util.Map<java.lang.String,java.lang.Object> resultsMap)
                               throws com.liferay.portal.kernel.exception.PortalException,
                                      com.liferay.portal.kernel.exception.SystemException
```
    Attempts to authenticate the user by their email address and password, while using the AuthPipeline.
    
    Parameters:
    companyId - the primary key of the user's company
    emailAddress - the user's email address
    password - the user's password
    headerMap - the header map from the authentication request
    parameterMap - the parameter map from the authentication request
    resultsMap - the map of authentication results (may be nil). After a succesful authentication the user's primary key will be placed under the key userId.
    
    Returns:
    the authentication status. This can be Authenticator.FAILURE indicating that the user's credentials are invalid, Authenticator.SUCCESS indicating a successful login, or Authenticator.DNE indicating that a user with that login does not exist.
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if emailAddress or password was null
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
    See Also:
    AuthPipeline
  - authenticateByScreenName
```
public int authenticateByScreenName(long companyId,
                           java.lang.String screenName,
                           java.lang.String password,
                           java.util.Map<java.lang.String,java.lang.String[]> headerMap,
                           java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                           java.util.Map<java.lang.String,java.lang.Object> resultsMap)
                             throws com.liferay.portal.kernel.exception.PortalException,
                                    com.liferay.portal.kernel.exception.SystemException
```
    Attempts to authenticate the user by their screen name and password, while using the AuthPipeline.
    
    Parameters:
    companyId - the primary key of the user's company
    screenName - the user's screen name
    password - the user's password
    headerMap - the header map from the authentication request
    parameterMap - the parameter map from the authentication request
    resultsMap - the map of authentication results (may be nil). After a succesful authentication the user's primary key will be placed under the key userId.
    
    Returns:
    the authentication status. This can be Authenticator.FAILURE indicating that the user's credentials are invalid, Authenticator.SUCCESS indicating a successful login, or Authenticator.DNE indicating that a user with that login does not exist.
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if screenName or password was null
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
    See Also:
    AuthPipeline
  - authenticateByUserId
```
public int authenticateByUserId(long companyId,
                       long userId,
                       java.lang.String password,
                       java.util.Map<java.lang.String,java.lang.String[]> headerMap,
                       java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                       java.util.Map<java.lang.String,java.lang.Object> resultsMap)
                         throws com.liferay.portal.kernel.exception.PortalException,
                                com.liferay.portal.kernel.exception.SystemException
```
    Attempts to authenticate the user by their primary key and password, while using the AuthPipeline.
    
    Parameters:
    companyId - the primary key of the user's company
    userId - the user's primary key
    password - the user's password
    headerMap - the header map from the authentication request
    parameterMap - the parameter map from the authentication request
    resultsMap - the map of authentication results (may be nil). After a succesful authentication the user's primary key will be placed under the key userId.
    
    Returns:
    the authentication status. This can be Authenticator.FAILURE indicating that the user's credentials are invalid, Authenticator.SUCCESS indicating a successful login, or Authenticator.DNE indicating that a user with that login does not exist.
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if userId or password was null
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
    See Also:
    AuthPipeline
  - authenticateForBasic
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
public long authenticateForBasic(long companyId,
                                      java.lang.String authType,
                                      java.lang.String login,
                                      java.lang.String password)
                          throws com.liferay.portal.kernel.exception.PortalException,
                                 com.liferay.portal.kernel.exception.SystemException
```
    Attempts to authenticate the user using HTTP basic access authentication, without using the AuthPipeline. Primarily used for authenticating users of tunnel-web.
    Authentication type specifies what login contains.The valid values are:
    - CompanyConstants.AUTH_TYPE_EA - login is the user's email address
    - CompanyConstants.AUTH_TYPE_SN - login is the user's screen name
    - CompanyConstants.AUTH_TYPE_ID - login is the user's primary key
    Parameters:
    companyId - the primary key of the user's company
    authType - the type of authentication to perform
    login - either the user's email address, screen name, or primary key depending on the value of authType
    password - the user's password
    
    Returns:
    the authentication status. This can be Authenticator.FAILURE indicating that the user's credentials are invalid, Authenticator.SUCCESS indicating a successful login, or Authenticator.DNE indicating that a user with that login does not exist.
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - authenticateForDigest
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
public long authenticateForDigest(long companyId,
                                       java.lang.String username,
                                       java.lang.String realm,
                                       java.lang.String nonce,
                                       java.lang.String method,
                                       java.lang.String uri,
                                       java.lang.String response)
                           throws com.liferay.portal.kernel.exception.PortalException,
                                  com.liferay.portal.kernel.exception.SystemException
```
    Attempts to authenticate the user using HTTP digest access authentication, without using the AuthPipeline. Primarily used for authenticating users of tunnel-web.
    
    Parameters:
    companyId - the primary key of the user's company
    username - either the user's email address, screen name, or primary key
    realm - unused
    nonce - the number used once
    method - the request method
    uri - the request URI
    response - the authentication response hash
    
    Returns:
    the user's primary key if authentication is succesful; 0 otherwise
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - authenticateForJAAS
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
public boolean authenticateForJAAS(long userId,
                                        java.lang.String encPassword)
```
    Attempts to authenticate the user using JAAS credentials, without using the AuthPipeline.
    
    Parameters:
    userId - the primary key of the user
    encPassword - the encrypted password
    
    Returns:
    true if authentication is successful; false otherwise
  - checkLockout
```
public void checkLockout(com.liferay.portal.model.User user)
                  throws com.liferay.portal.kernel.exception.PortalException,
                         com.liferay.portal.kernel.exception.SystemException
```
    Checks if the user is currently locked out based on the password policy, and performs maintenance on the user's lockout and failed login data.
    
    Parameters:
    user - the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if the user was determined to still be locked out
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - checkLoginFailure
```
public void checkLoginFailure(com.liferay.portal.model.User user)
                       throws com.liferay.portal.kernel.exception.SystemException
```
    Adds a failed login attempt to the user and updates the user's last failed login date.
    
    Parameters:
    user - the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - checkLoginFailureByEmailAddress
```
public void checkLoginFailureByEmailAddress(long companyId,
                                   java.lang.String emailAddress)
                                     throws com.liferay.portal.kernel.exception.PortalException,
                                            com.liferay.portal.kernel.exception.SystemException
```
    Adds a failed login attempt to the user with the email address and updates the user's last failed login date.
    
    Parameters:
    companyId - the primary key of the user's company
    emailAddress - the user's email address
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the email address could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - checkLoginFailureById
```
public void checkLoginFailureById(long userId)
                           throws com.liferay.portal.kernel.exception.PortalException,
                                  com.liferay.portal.kernel.exception.SystemException
```
    Adds a failed login attempt to the user and updates the user's last failed login date.
    
    Parameters:
    userId - the primary key of the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - checkLoginFailureByScreenName
```
public void checkLoginFailureByScreenName(long companyId,
                                 java.lang.String screenName)
                                   throws com.liferay.portal.kernel.exception.PortalException,
                                          com.liferay.portal.kernel.exception.SystemException
```
    Adds a failed login attempt to the user with the screen name and updates the user's last failed login date.
    
    Parameters:
    companyId - the primary key of the user's company
    screenName - the user's screen name
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the screen name could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - checkPasswordExpired
```
public void checkPasswordExpired(com.liferay.portal.model.User user)
                          throws com.liferay.portal.kernel.exception.PortalException,
                                 com.liferay.portal.kernel.exception.SystemException
```
    Checks if the user's password is expired based on the password policy, and performs maintenance on the user's grace login and password reset data.
    
    Parameters:
    user - the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if the user's password has expired and the grace login limit has been exceeded
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - clearOrganizationUsers
```
public void clearOrganizationUsers(long organizationId)
                            throws com.liferay.portal.kernel.exception.SystemException
```
    Removes all the users from the organization.
    
    Specified by:
    
    clearOrganizationUsers in interface com.liferay.portal.service.UserLocalService
    
    Overrides:
    
    clearOrganizationUsers in class UserLocalServiceBaseImpl
    
    Parameters:
    organizationId - the primary key of the organization
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - clearUserGroupUsers
```
public void clearUserGroupUsers(long userGroupId)
                         throws com.liferay.portal.kernel.exception.SystemException
```
    Removes all the users from the user group.
    
    Specified by:
    
    clearUserGroupUsers in interface com.liferay.portal.service.UserLocalService
    
    Overrides:
    
    clearUserGroupUsers in class UserLocalServiceBaseImpl
    
    Parameters:
    userGroupId - the primary key of the user group
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - completeUserRegistration
```
public void completeUserRegistration(com.liferay.portal.model.User user,
                            com.liferay.portal.service.ServiceContext serviceContext)
                              throws com.liferay.portal.kernel.exception.PortalException,
                                     com.liferay.portal.kernel.exception.SystemException
```
    Completes the user's registration by generating a password and sending the confirmation email.
    
    Parameters:
    user - the user
    serviceContext - the service context to be applied. You can specify an unencrypted custom password for the user via attribute passwordUnencrypted. You automatically generate a password for the user by setting attribute autoPassword to true. You can send a confirmation email to the user by setting attribute sendEmail to true.
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - decryptUserId
```
public com.liferay.portal.kernel.util.KeyValuePair decryptUserId(long companyId,
                                                        java.lang.String name,
                                                        java.lang.String password)
                                                          throws com.liferay.portal.kernel.exception.PortalException,
                                                                 com.liferay.portal.kernel.exception.SystemException
```
    Decrypts the user's primary key and password from their encrypted forms. Used for decrypting a user's credentials from the values stored in an automatic login cookie.
    
    Parameters:
    companyId - the primary key of the user's company
    name - the encrypted primary key of the user
    password - the encrypted password of the user
    
    Returns:
    the user's primary key and password
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found or if the user's password was incorrect
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - deletePortrait
```
public void deletePortrait(long userId)
                    throws com.liferay.portal.kernel.exception.PortalException,
                           com.liferay.portal.kernel.exception.SystemException
```
    Deletes the user's portrait image.
    
    Parameters:
    userId - the primary key of the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found or if the user's portrait could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - deleteRoleUser
```
public void deleteRoleUser(long roleId,
                  long userId)
                    throws com.liferay.portal.kernel.exception.PortalException,
                           com.liferay.portal.kernel.exception.SystemException
```
    Removes the user from the role.
    
    Specified by:
    
    deleteRoleUser in interface com.liferay.portal.service.UserLocalService
    
    Overrides:
    
    deleteRoleUser in class UserLocalServiceBaseImpl
    
    Parameters:
    roleId - the primary key of the role
    userId - the primary key of the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a role or user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - deleteUser
```
public com.liferay.portal.model.User deleteUser(long userId)
                                         throws com.liferay.portal.kernel.exception.PortalException,
                                                com.liferay.portal.kernel.exception.SystemException
```
    Deletes the user.
    
    Specified by:
    
    deleteUser in interface com.liferay.portal.service.UserLocalService
    
    Overrides:
    
    deleteUser in class UserLocalServiceBaseImpl
    
    Parameters:
    userId - the primary key of the user
    
    Returns:
    the deleted user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - deleteUser
```
public com.liferay.portal.model.User deleteUser(com.liferay.portal.model.User user)
                                         throws com.liferay.portal.kernel.exception.PortalException,
                                                com.liferay.portal.kernel.exception.SystemException
```
    Deletes the user.
    
    Specified by:
    
    deleteUser in interface com.liferay.portal.service.UserLocalService
    
    Overrides:
    
    deleteUser in class UserLocalServiceBaseImpl
    
    Parameters:
    user - the user
    
    Returns:
    the deleted user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - deleteUserGroupUser
```
public void deleteUserGroupUser(long userGroupId,
                       long userId)
                         throws com.liferay.portal.kernel.exception.PortalException,
                                com.liferay.portal.kernel.exception.SystemException
```
    Removes the user from the user group.
    
    Specified by:
    
    deleteUserGroupUser in interface com.liferay.portal.service.UserLocalService
    
    Overrides:
    
    deleteUserGroupUser in class UserLocalServiceBaseImpl
    
    Parameters:
    userGroupId - the primary key of the user group
    userId - the primary key of the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - encryptUserId
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
public java.lang.String encryptUserId(java.lang.String name)
                               throws com.liferay.portal.kernel.exception.PortalException,
                                      com.liferay.portal.kernel.exception.SystemException
```
    Encrypts the primary key of the user. Used when encrypting the user's credentials for storage in an automatic login cookie.
    
    Parameters:
    name - the primary key of the user
    
    Returns:
    the user's encrypted primary key
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - fetchUserByEmailAddress
```
public com.liferay.portal.model.User fetchUserByEmailAddress(long companyId,
                                                    java.lang.String emailAddress)
                                                      throws com.liferay.portal.kernel.exception.SystemException
```
    Returns the user with the email address.
    
    Parameters:
    companyId - the primary key of the user's company
    emailAddress - the user's email address
    
    Returns:
    the user with the email address, or null if a user with the email address could not be found
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - fetchUserByFacebookId
```
public com.liferay.portal.model.User fetchUserByFacebookId(long companyId,
                                                  long facebookId)
                                                    throws com.liferay.portal.kernel.exception.SystemException
```
    Returns the user with the Facebook ID.
    
    Parameters:
    companyId - the primary key of the user's company
    facebookId - the user's Facebook ID
    
    Returns:
    the user with the Facebook ID, or null if a user with the Facebook ID could not be found
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - fetchUserById
```
public com.liferay.portal.model.User fetchUserById(long userId)
                                            throws com.liferay.portal.kernel.exception.SystemException
```
    Returns the user with the primary key.
    
    Parameters:
    userId - the primary key of the user
    
    Returns:
    the user with the primary key, or null if a user with the primary key could not be found
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - fetchUserByOpenId
```
public com.liferay.portal.model.User fetchUserByOpenId(long companyId,
                                              java.lang.String openId)
                                                throws com.liferay.portal.kernel.exception.SystemException
```
    Returns the user with the OpenID.
    
    Parameters:
    companyId - the primary key of the user's company
    openId - the user's OpenID
    
    Returns:
    the user with the OpenID, or null if a user with the OpenID could not be found
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - fetchUserByScreenName
```
public com.liferay.portal.model.User fetchUserByScreenName(long companyId,
                                                  java.lang.String screenName)
                                                    throws com.liferay.portal.kernel.exception.SystemException
```
    Returns the user with the screen name.
    
    Parameters:
    companyId - the primary key of the user's company
    screenName - the user's screen name
    
    Returns:
    the user with the screen name, or null if a user with the screen name could not be found
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getCompanyUsers
```
public java.util.List<com.liferay.portal.model.User> getCompanyUsers(long companyId,
                                                            int start,
                                                            int end)
                                                              throws com.liferay.portal.kernel.exception.SystemException
```
    Returns a range of all the users belonging to the company.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Parameters:
    companyId - the primary key of the company
    start - the lower bound of the range of users
    end - the upper bound of the range of users (not inclusive)
    
    Returns:
    the range of users belonging to the company
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getCompanyUsersCount
```
public int getCompanyUsersCount(long companyId)
                         throws com.liferay.portal.kernel.exception.SystemException
```
    Returns the number of users belonging to the company.
    
    Parameters:
    companyId - the primary key of the company
    
    Returns:
    the number of users belonging to the company
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getDefaultUser
```
@Skip
public com.liferay.portal.model.User getDefaultUser(long companyId)
                                             throws com.liferay.portal.kernel.exception.PortalException,
                                                    com.liferay.portal.kernel.exception.SystemException
```
    Returns the default user for the company.
    
    Parameters:
    companyId - the primary key of the company
    
    Returns:
    the default user for the company
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a default user for the company could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getDefaultUserId
```
@Skip
public long getDefaultUserId(long companyId)
                      throws com.liferay.portal.kernel.exception.PortalException,
                             com.liferay.portal.kernel.exception.SystemException
```
    Returns the primary key of the default user for the company.
    
    Parameters:
    companyId - the primary key of the company
    
    Returns:
    the primary key of the default user for the company
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a default user for the company could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getGroupUserIds
```
public long[] getGroupUserIds(long groupId)
                       throws com.liferay.portal.kernel.exception.SystemException
```
    Returns the primary keys of all the users belonging to the group.
    
    Parameters:
    groupId - the primary key of the group
    
    Returns:
    the primary keys of the users belonging to the group
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getGroupUsersCount
```
public int getGroupUsersCount(long groupId,
                     int status)
                       throws com.liferay.portal.kernel.exception.PortalException,
                              com.liferay.portal.kernel.exception.SystemException
```
    Returns the number of users with the status belonging to the group.
    
    Parameters:
    groupId - the primary key of the group
    status - the workflow status
    
    Returns:
    the number of users with the status belonging to the group
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a group with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getInheritedRoleUsers
```
public java.util.List<com.liferay.portal.model.User> getInheritedRoleUsers(long roleId,
                                                                  int start,
                                                                  int end,
                                                                  com.liferay.portal.kernel.util.OrderByComparator obc)
                                                                    throws com.liferay.portal.kernel.exception.PortalException,
                                                                           com.liferay.portal.kernel.exception.SystemException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
    
    com.liferay.portal.kernel.exception.SystemException
  - getNoAnnouncementsDeliveries
```
public java.util.List<com.liferay.portal.model.User> getNoAnnouncementsDeliveries(java.lang.String type)
                                                                           throws com.liferay.portal.kernel.exception.SystemException
```
    Returns all the users who have not had any announcements of the type delivered, excluding the default user.
    
    Parameters:
    type - the type of announcement
    
    Returns:
    the users who have not had any annoucements of the type delivered
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getNoContacts
```
public java.util.List<com.liferay.portal.model.User> getNoContacts()
                                                            throws com.liferay.portal.kernel.exception.SystemException
```
    Returns all the users who do not have any contacts.
    
    Returns:
    the users who do not have any contacts
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getNoGroups
```
public java.util.List<com.liferay.portal.model.User> getNoGroups()
                                                          throws com.liferay.portal.kernel.exception.SystemException
```
    Returns all the users who do not belong to any groups, excluding the default user.
    
    Returns:
    the users who do not belong to any groups
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getOrganizationUserIds
```
public long[] getOrganizationUserIds(long organizationId)
                              throws com.liferay.portal.kernel.exception.SystemException
```
    Returns the primary keys of all the users belonging to the organization.
    
    Parameters:
    organizationId - the primary key of the organization
    
    Returns:
    the primary keys of the users belonging to the organization
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getOrganizationUsersCount
```
public int getOrganizationUsersCount(long organizationId,
                            int status)
                              throws com.liferay.portal.kernel.exception.PortalException,
                                     com.liferay.portal.kernel.exception.SystemException
```
    Returns the number of users with the status belonging to the organization.
    
    Parameters:
    organizationId - the primary key of the organization
    status - the workflow status
    
    Returns:
    the number of users with the status belonging to the organization
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if an organization with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getRoleUserIds
```
public long[] getRoleUserIds(long roleId)
                      throws com.liferay.portal.kernel.exception.SystemException
```
    Returns the primary keys of all the users belonging to the role.
    
    Parameters:
    roleId - the primary key of the role
    
    Returns:
    the primary keys of the users belonging to the role
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getRoleUsersCount
```
public int getRoleUsersCount(long roleId,
                    int status)
                      throws com.liferay.portal.kernel.exception.PortalException,
                             com.liferay.portal.kernel.exception.SystemException
```
    Returns the number of users with the status belonging to the role.
    
    Parameters:
    roleId - the primary key of the role
    status - the workflow status
    
    Returns:
    the number of users with the status belonging to the role
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if an role with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getSocialUsers
```
public java.util.List<com.liferay.portal.model.User> getSocialUsers(long userId,
                                                           int type,
                                                           int start,
                                                           int end,
                                                           com.liferay.portal.kernel.util.OrderByComparator obc)
                                                             throws com.liferay.portal.kernel.exception.PortalException,
                                                                    com.liferay.portal.kernel.exception.SystemException
```
    Returns an ordered range of all the users with a social relation of the type with the user.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Parameters:
    userId - the primary key of the user
    type - the type of social relation. The possible types can be found in SocialRelationConstants.
    start - the lower bound of the range of users
    end - the upper bound of the range of users (not inclusive)
    obc - the comparator to order the users by (optionally null)
    
    Returns:
    the ordered range of users with a social relation of the type with the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getSocialUsers
```
public java.util.List<com.liferay.portal.model.User> getSocialUsers(long userId,
                                                           int start,
                                                           int end,
                                                           com.liferay.portal.kernel.util.OrderByComparator obc)
                                                             throws com.liferay.portal.kernel.exception.PortalException,
                                                                    com.liferay.portal.kernel.exception.SystemException
```
    Returns an ordered range of all the users with a social relation with the user.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Parameters:
    userId - the primary key of the user
    start - the lower bound of the range of users
    end - the upper bound of the range of users (not inclusive)
    obc - the comparator to order the users by (optionally null)
    
    Returns:
    the ordered range of users with a social relation with the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getSocialUsers
```
public java.util.List<com.liferay.portal.model.User> getSocialUsers(long userId1,
                                                           long userId2,
                                                           int type,
                                                           int start,
                                                           int end,
                                                           com.liferay.portal.kernel.util.OrderByComparator obc)
                                                             throws com.liferay.portal.kernel.exception.PortalException,
                                                                    com.liferay.portal.kernel.exception.SystemException
```
    Returns an ordered range of all the users with a mutual social relation of the type with both of the given users.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Parameters:
    userId1 - the primary key of the first user
    userId2 - the primary key of the second user
    type - the type of social relation. The possible types can be found in SocialRelationConstants.
    start - the lower bound of the range of users
    end - the upper bound of the range of users (not inclusive)
    obc - the comparator to order the users by (optionally null)
    
    Returns:
    the ordered range of users with a mutual social relation of the type with the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getSocialUsers
```
public java.util.List<com.liferay.portal.model.User> getSocialUsers(long userId1,
                                                           long userId2,
                                                           int start,
                                                           int end,
                                                           com.liferay.portal.kernel.util.OrderByComparator obc)
                                                             throws com.liferay.portal.kernel.exception.PortalException,
                                                                    com.liferay.portal.kernel.exception.SystemException
```
    Returns an ordered range of all the users with a mutual social relation with both of the given users.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Parameters:
    userId1 - the primary key of the first user
    userId2 - the primary key of the second user
    start - the lower bound of the range of users
    end - the upper bound of the range of users (not inclusive)
    obc - the comparator to order the users by (optionally null)
    
    Returns:
    the ordered range of users with a mutual social relation with the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getSocialUsersCount
```
public int getSocialUsersCount(long userId)
                        throws com.liferay.portal.kernel.exception.PortalException,
                               com.liferay.portal.kernel.exception.SystemException
```
    Returns the number of users with a social relation with the user.
    
    Parameters:
    userId - the primary key of the user
    
    Returns:
    the number of users with a social relation with the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getSocialUsersCount
```
public int getSocialUsersCount(long userId,
                      int type)
                        throws com.liferay.portal.kernel.exception.PortalException,
                               com.liferay.portal.kernel.exception.SystemException
```
    Returns the number of users with a social relation of the type with the user.
    
    Parameters:
    userId - the primary key of the user
    type - the type of social relation. The possible types can be found in SocialRelationConstants.
    
    Returns:
    the number of users with a social relation of the type with the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getSocialUsersCount
```
public int getSocialUsersCount(long userId1,
                      long userId2)
                        throws com.liferay.portal.kernel.exception.PortalException,
                               com.liferay.portal.kernel.exception.SystemException
```
    Returns the number of users with a mutual social relation with both of the given users.
    
    Parameters:
    userId1 - the primary key of the first user
    userId2 - the primary key of the second user
    
    Returns:
    the number of users with a mutual social relation with the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getSocialUsersCount
```
public int getSocialUsersCount(long userId1,
                      long userId2,
                      int type)
                        throws com.liferay.portal.kernel.exception.PortalException,
                               com.liferay.portal.kernel.exception.SystemException
```
    Returns the number of users with a mutual social relation of the type with both of the given users.
    
    Parameters:
    userId1 - the primary key of the first user
    userId2 - the primary key of the second user
    type - the type of social relation. The possible types can be found in SocialRelationConstants.
    
    Returns:
    the number of users with a mutual social relation of the type with the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getUserByContactId
```
public com.liferay.portal.model.User getUserByContactId(long contactId)
                                                 throws com.liferay.portal.kernel.exception.PortalException,
                                                        com.liferay.portal.kernel.exception.SystemException
```
    Returns the user with the contact ID.
    
    Parameters:
    contactId - the user's contact ID
    
    Returns:
    the user with the contact ID
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the contact ID could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getUserByEmailAddress
```
public com.liferay.portal.model.User getUserByEmailAddress(long companyId,
                                                  java.lang.String emailAddress)
                                                    throws com.liferay.portal.kernel.exception.PortalException,
                                                           com.liferay.portal.kernel.exception.SystemException
```
    Returns the user with the email address.
    
    Parameters:
    companyId - the primary key of the user's company
    emailAddress - the user's email address
    
    Returns:
    the user with the email address
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the email address could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getUserByFacebookId
```
public com.liferay.portal.model.User getUserByFacebookId(long companyId,
                                                long facebookId)
                                                  throws com.liferay.portal.kernel.exception.PortalException,
                                                         com.liferay.portal.kernel.exception.SystemException
```
    Returns the user with the Facebook ID.
    
    Parameters:
    companyId - the primary key of the user's company
    facebookId - the user's Facebook ID
    
    Returns:
    the user with the Facebook ID
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the Facebook ID could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getUserById
```
public com.liferay.portal.model.User getUserById(long userId)
                                          throws com.liferay.portal.kernel.exception.PortalException,
                                                 com.liferay.portal.kernel.exception.SystemException
```
    Returns the user with the primary key.
    
    Parameters:
    userId - the primary key of the user
    
    Returns:
    the user with the primary key
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getUserById
```
public com.liferay.portal.model.User getUserById(long companyId,
                                        long userId)
                                          throws com.liferay.portal.kernel.exception.PortalException,
                                                 com.liferay.portal.kernel.exception.SystemException
```
    Returns the user with the primary key from the company.
    
    Parameters:
    companyId - the primary key of the user's company
    userId - the primary key of the user
    
    Returns:
    the user with the primary key
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key from the company could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getUserByOpenId
```
public com.liferay.portal.model.User getUserByOpenId(long companyId,
                                            java.lang.String openId)
                                              throws com.liferay.portal.kernel.exception.PortalException,
                                                     com.liferay.portal.kernel.exception.SystemException
```
    Returns the user with the OpenID.
    
    Parameters:
    companyId - the primary key of the user's company
    openId - the user's OpenID
    
    Returns:
    the user with the OpenID
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the OpenID could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getUserByPortraitId
```
public com.liferay.portal.model.User getUserByPortraitId(long portraitId)
                                                  throws com.liferay.portal.kernel.exception.PortalException,
                                                         com.liferay.portal.kernel.exception.SystemException
```
    Returns the user with the portrait ID.
    
    Parameters:
    portraitId - the user's portrait ID
    
    Returns:
    the user with the portrait ID
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the portrait ID could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getUserByScreenName
```
public com.liferay.portal.model.User getUserByScreenName(long companyId,
                                                java.lang.String screenName)
                                                  throws com.liferay.portal.kernel.exception.PortalException,
                                                         com.liferay.portal.kernel.exception.SystemException
```
    Returns the user with the screen name.
    
    Parameters:
    companyId - the primary key of the user's company
    screenName - the user's screen name
    
    Returns:
    the user with the screen name
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the screen name could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getUserByUuid
```
public com.liferay.portal.model.User getUserByUuid(java.lang.String uuid)
                                            throws com.liferay.portal.kernel.exception.PortalException,
                                                   com.liferay.portal.kernel.exception.SystemException
```
    Deprecated. As of 6.2.0, replaced by getUserByUuidAndCompanyId(String, long)
    
    Returns the user with the UUID.
    
    Parameters:
    uuid - the user's UUID
    
    Returns:
    the user with the UUID
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the UUID could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getUserByUuidAndCompanyId
```
public com.liferay.portal.model.User getUserByUuidAndCompanyId(java.lang.String uuid,
                                                      long companyId)
                                                        throws com.liferay.portal.kernel.exception.PortalException,
                                                               com.liferay.portal.kernel.exception.SystemException
```
    Returns the user with the UUID.
    
    Specified by:
    
    getUserByUuidAndCompanyId in interface com.liferay.portal.service.UserLocalService
    
    Overrides:
    
    getUserByUuidAndCompanyId in class UserLocalServiceBaseImpl
    
    Parameters:
    uuid - the user's UUID
    companyId - the primary key of the user's company
    
    Returns:
    the user with the UUID
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the UUID could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getUserGroupUsersCount
```
public int getUserGroupUsersCount(long userGroupId,
                         int status)
                           throws com.liferay.portal.kernel.exception.PortalException,
                                  com.liferay.portal.kernel.exception.SystemException
```
    Returns the number of users with the status belonging to the user group.
    
    Parameters:
    userGroupId - the primary key of the user group
    status - the workflow status
    
    Returns:
    the number of users with the status belonging to the user group
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user group with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getUserIdByEmailAddress
```
public long getUserIdByEmailAddress(long companyId,
                           java.lang.String emailAddress)
                             throws com.liferay.portal.kernel.exception.PortalException,
                                    com.liferay.portal.kernel.exception.SystemException
```
    Returns the primary key of the user with the email address.
    
    Parameters:
    companyId - the primary key of the user's company
    emailAddress - the user's email address
    
    Returns:
    the primary key of the user with the email address
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the email address could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - getUserIdByScreenName
```
public long getUserIdByScreenName(long companyId,
                         java.lang.String screenName)
                           throws com.liferay.portal.kernel.exception.PortalException,
                                  com.liferay.portal.kernel.exception.SystemException
```
    Returns the primary key of the user with the screen name.
    
    Parameters:
    companyId - the primary key of the user's company
    screenName - the user's screen name
    
    Returns:
    the primary key of the user with the screen name
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the screen name could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - hasPasswordPolicyUser
```
public boolean hasPasswordPolicyUser(long passwordPolicyId,
                            long userId)
                              throws com.liferay.portal.kernel.exception.SystemException
```
    Returns true if the password policy has been assigned to the user.
    
    Parameters:
    passwordPolicyId - the primary key of the password policy
    userId - the primary key of the user
    
    Returns:
    true if the password policy is assigned to the user; false otherwise
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - hasRoleUser
```
public boolean hasRoleUser(long companyId,
                  java.lang.String name,
                  long userId,
                  boolean inherited)
                    throws com.liferay.portal.kernel.exception.PortalException,
                           com.liferay.portal.kernel.exception.SystemException
```
    Returns true if the user has the role with the name, optionally through inheritance.
    
    Parameters:
    companyId - the primary key of the role's company
    name - the name of the role (must be a regular role, not an organization, site or provider role)
    userId - the primary key of the user
    inherited - whether to include roles inherited from organizations, sites, etc.
    
    Returns:
    true if the user has the role; false otherwise
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a role with the name could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - isPasswordExpired
```
public boolean isPasswordExpired(com.liferay.portal.model.User user)
                          throws com.liferay.portal.kernel.exception.PortalException,
                                 com.liferay.portal.kernel.exception.SystemException
```
    Returns true if the user's password is expired.
    
    Parameters:
    user - the user
    
    Returns:
    true if the user's password is expired; false otherwise
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if the password policy for the user could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - isPasswordExpiringSoon
```
public boolean isPasswordExpiringSoon(com.liferay.portal.model.User user)
                               throws com.liferay.portal.kernel.exception.PortalException,
                                      com.liferay.portal.kernel.exception.SystemException
```
    Returns true if the password policy is configured to warn the user that his password is expiring and the remaining time until expiration is equal or less than the configured warning time.
    
    Parameters:
    user - the user
    
    Returns:
    true if the user's password is expiring soon; false otherwise
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if the password policy for the user could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - loadGetDefaultUser
```
public com.liferay.portal.model.User loadGetDefaultUser(long companyId)
                                                 throws com.liferay.portal.kernel.exception.PortalException,
                                                        com.liferay.portal.kernel.exception.SystemException
```
    Returns the default user for the company.
    
    Parameters:
    companyId - the primary key of the company
    
    Returns:
    the default user for the company
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if the user could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - search
```
public java.util.List<com.liferay.portal.model.User> search(long companyId,
                                                   java.lang.String keywords,
                                                   int status,
                                                   java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                   int start,
                                                   int end,
                                                   com.liferay.portal.kernel.util.OrderByComparator obc)
                                                     throws com.liferay.portal.kernel.exception.SystemException
```
    Returns an ordered range of all the users who match the keywords and status, without using the indexer. It is preferable to use the indexed version search(long, String, int, LinkedHashMap, int, int, Sort) instead of this method wherever possible for performance reasons.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Parameters:
    companyId - the primary key of the user's company
    keywords - the keywords (space separated), which may occur in the user's first name, middle name, last name, screen name, or email address
    status - the workflow status
    params - the finder parameters (optionally null). For more information see UserFinder.
    start - the lower bound of the range of users
    end - the upper bound of the range of users (not inclusive)
    obc - the comparator to order the users by (optionally null)
    
    Returns:
    the matching users
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
    See Also:
    UserFinder
  - search
```
public com.liferay.portal.kernel.search.Hits search(long companyId,
                                           java.lang.String keywords,
                                           int status,
                                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                           int start,
                                           int end,
                                           com.liferay.portal.kernel.search.Sort sort)
                                             throws com.liferay.portal.kernel.exception.SystemException
```
    Returns an ordered range of all the users who match the keywords and status, using the indexer. It is preferable to use this method instead of the non-indexed version whenever possible for performance reasons.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Parameters:
    companyId - the primary key of the user's company
    keywords - the keywords (space separated), which may occur in the user's first name, middle name, last name, screen name, or email address
    status - the workflow status
    params - the indexer parameters (optionally null). For more information see UserIndexer.
    start - the lower bound of the range of users
    end - the upper bound of the range of users (not inclusive)
    sort - the field and direction to sort by (optionally null)
    
    Returns:
    the matching users
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
    See Also:
    UserIndexer
  - search
```
public java.util.List<com.liferay.portal.model.User> search(long companyId,
                                                   java.lang.String firstName,
                                                   java.lang.String middleName,
                                                   java.lang.String lastName,
                                                   java.lang.String screenName,
                                                   java.lang.String emailAddress,
                                                   int status,
                                                   java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                   boolean andSearch,
                                                   int start,
                                                   int end,
                                                   com.liferay.portal.kernel.util.OrderByComparator obc)
                                                     throws com.liferay.portal.kernel.exception.SystemException
```
    Returns an ordered range of all the users with the status, and whose first name, middle name, last name, screen name, and email address match the keywords specified for them, without using the indexer. It is preferable to use the indexed version search(long, String, String, String, String, String, int, LinkedHashMap, boolean, int, int, Sort) instead of this method wherever possible for performance reasons.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Parameters:
    companyId - the primary key of the user's company
    firstName - the first name keywords (space separated)
    middleName - the middle name keywords
    lastName - the last name keywords
    screenName - the screen name keywords
    emailAddress - the email address keywords
    status - the workflow status
    params - the finder parameters (optionally null). For more information see UserFinder.
    andSearch - whether every field must match its keywords, or just one field. For example, "users with the first name 'bob' and last name 'smith'" vs "users with the first name 'bob' or the last name 'smith'".
    start - the lower bound of the range of users
    end - the upper bound of the range of users (not inclusive)
    obc - the comparator to order the users by (optionally null)
    
    Returns:
    the matching users
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
    See Also:
    UserFinder
  - search
```
public com.liferay.portal.kernel.search.Hits search(long companyId,
                                           java.lang.String firstName,
                                           java.lang.String middleName,
                                           java.lang.String lastName,
                                           java.lang.String screenName,
                                           java.lang.String emailAddress,
                                           int status,
                                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                           boolean andSearch,
                                           int start,
                                           int end,
                                           com.liferay.portal.kernel.search.Sort sort)
                                             throws com.liferay.portal.kernel.exception.SystemException
```
    Returns an ordered range of all the users with the status, and whose first name, middle name, last name, screen name, and email address match the keywords specified for them, using the indexer. It is preferable to use this method instead of the non-indexed version whenever possible for performance reasons.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Parameters:
    companyId - the primary key of the user's company
    firstName - the first name keywords (space separated)
    middleName - the middle name keywords
    lastName - the last name keywords
    screenName - the screen name keywords
    emailAddress - the email address keywords
    status - the workflow status
    params - the indexer parameters (optionally null). For more information see UserIndexer.
    andSearch - whether every field must match its keywords, or just one field. For example, "users with the first name 'bob' and last name 'smith'" vs "users with the first name 'bob' or the last name 'smith'".
    start - the lower bound of the range of users
    end - the upper bound of the range of users (not inclusive)
    sort - the field and direction to sort by (optionally null)
    
    Returns:
    the matching users
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
    See Also:
    UserIndexer
  - searchCount
```
public int searchCount(long companyId,
              java.lang.String keywords,
              int status,
              java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
                throws com.liferay.portal.kernel.exception.SystemException
```
    Returns the number of users who match the keywords and status.
    
    Parameters:
    companyId - the primary key of the user's company
    keywords - the keywords (space separated), which may occur in the user's first name, middle name, last name, screen name, or email address
    status - the workflow status
    params - the finder parameters (optionally null). For more information see UserFinder.
    
    Returns:
    the number matching users
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - searchCount
```
public int searchCount(long companyId,
              java.lang.String firstName,
              java.lang.String middleName,
              java.lang.String lastName,
              java.lang.String screenName,
              java.lang.String emailAddress,
              int status,
              java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
              boolean andSearch)
                throws com.liferay.portal.kernel.exception.SystemException
```
    Returns the number of users with the status, and whose first name, middle name, last name, screen name, and email address match the keywords specified for them.
    
    Parameters:
    companyId - the primary key of the user's company
    firstName - the first name keywords (space separated)
    middleName - the middle name keywords
    lastName - the last name keywords
    screenName - the screen name keywords
    emailAddress - the email address keywords
    status - the workflow status
    params - the finder parameters (optionally null). For more information see UserFinder.
    andSearch - whether every field must match its keywords, or just one field. For example, "users with the first name 'bob' and last name 'smith'" vs "users with the first name 'bob' or the last name 'smith'".
    
    Returns:
    the number of matching users
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - sendEmailAddressVerification
```
public void sendEmailAddressVerification(com.liferay.portal.model.User user,
                                java.lang.String emailAddress,
                                com.liferay.portal.service.ServiceContext serviceContext)
                                  throws com.liferay.portal.kernel.exception.PortalException,
                                         com.liferay.portal.kernel.exception.SystemException
```
    Sends an email address verification to the user.
    
    Parameters:
    user - the verification email recipient
    emailAddress - the recipient's email address
    serviceContext - the service context to be applied. Must set the portal URL, main path, primary key of the layout, remote address, remote host, and agent for the user.
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - sendPassword
```
public void sendPassword(long companyId,
                java.lang.String emailAddress,
                java.lang.String fromName,
                java.lang.String fromAddress,
                java.lang.String subject,
                java.lang.String body,
                com.liferay.portal.service.ServiceContext serviceContext)
                  throws com.liferay.portal.kernel.exception.PortalException,
                         com.liferay.portal.kernel.exception.SystemException
```
    Sends the password email to the user with the email address. The content of this email can be specified in portal.properties with the admin.email.password keys.
    
    Parameters:
    companyId - the primary key of the user's company
    emailAddress - the user's email address
    fromName - the name of the individual that the email should be from
    fromAddress - the address of the individual that the email should be from
    subject - the email subject. If null, the subject specified in portal.properties will be used.
    body - the email body. If null, the body specified in portal.properties will be used.
    serviceContext - the service context to be applied
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the email address could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - setRoleUsers
```
public void setRoleUsers(long roleId,
                long[] userIds)
                  throws com.liferay.portal.kernel.exception.PortalException,
                         com.liferay.portal.kernel.exception.SystemException
```
    Sets the users in the role, removing and adding users to the role as necessary.
    
    Specified by:
    
    setRoleUsers in interface com.liferay.portal.service.UserLocalService
    
    Overrides:
    
    setRoleUsers in class UserLocalServiceBaseImpl
    
    Parameters:
    roleId - the primary key of the role
    userIds - the primary keys of the users
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - setUserGroupUsers
```
public void setUserGroupUsers(long userGroupId,
                     long[] userIds)
                       throws com.liferay.portal.kernel.exception.PortalException,
                              com.liferay.portal.kernel.exception.SystemException
```
    Sets the users in the user group, removing and adding users to the user group as necessary.
    
    Specified by:
    
    setUserGroupUsers in interface com.liferay.portal.service.UserLocalService
    
    Overrides:
    
    setUserGroupUsers in class UserLocalServiceBaseImpl
    
    Parameters:
    userGroupId - the primary key of the user group
    userIds - the primary keys of the users
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - unsetGroupTeamsUsers
```
public void unsetGroupTeamsUsers(long groupId,
                        long[] userIds)
                          throws com.liferay.portal.kernel.exception.PortalException,
                                 com.liferay.portal.kernel.exception.SystemException
```
    Removes the users from the teams of a group.
    
    Parameters:
    groupId - the primary key of the group
    userIds - the primary keys of the users
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - unsetGroupUsers
```
public void unsetGroupUsers(long groupId,
                   long[] userIds,
                   com.liferay.portal.service.ServiceContext serviceContext)
                     throws com.liferay.portal.kernel.exception.PortalException,
                            com.liferay.portal.kernel.exception.SystemException
```
    Removes the users from the group.
    
    Parameters:
    groupId - the primary key of the group
    userIds - the primary keys of the users
    serviceContext - the service context to be applied (optionally null)
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - unsetOrganizationUsers
```
public void unsetOrganizationUsers(long organizationId,
                          long[] userIds)
                            throws com.liferay.portal.kernel.exception.PortalException,
                                   com.liferay.portal.kernel.exception.SystemException
```
    Removes the users from the organization.
    
    Parameters:
    organizationId - the primary key of the organization
    userIds - the primary keys of the users
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - unsetPasswordPolicyUsers
```
public void unsetPasswordPolicyUsers(long passwordPolicyId,
                            long[] userIds)
                              throws com.liferay.portal.kernel.exception.SystemException
```
    Removes the users from the password policy.
    
    Parameters:
    passwordPolicyId - the primary key of the password policy
    userIds - the primary keys of the users
    
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - unsetRoleUsers
```
public void unsetRoleUsers(long roleId,
                  java.util.List<com.liferay.portal.model.User> users)
                    throws com.liferay.portal.kernel.exception.PortalException,
                           com.liferay.portal.kernel.exception.SystemException
```
    Removes the users from the role.
    
    Parameters:
    roleId - the primary key of the role
    users - the users
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - unsetRoleUsers
```
public void unsetRoleUsers(long roleId,
                  long[] userIds)
                    throws com.liferay.portal.kernel.exception.PortalException,
                           com.liferay.portal.kernel.exception.SystemException
```
    Removes the users from the role.
    
    Parameters:
    roleId - the primary key of the role
    userIds - the primary keys of the users
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - unsetTeamUsers
```
public void unsetTeamUsers(long teamId,
                  long[] userIds)
                    throws com.liferay.portal.kernel.exception.PortalException,
                           com.liferay.portal.kernel.exception.SystemException
```
    Removes the users from the team.
    
    Parameters:
    teamId - the primary key of the team
    userIds - the primary keys of the users
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - unsetUserGroupUsers
```
public void unsetUserGroupUsers(long userGroupId,
                       long[] userIds)
                         throws com.liferay.portal.kernel.exception.PortalException,
                                com.liferay.portal.kernel.exception.SystemException
```
    Removes the users from the user group.
    
    Parameters:
    userGroupId - the primary key of the user group
    userIds - the primary keys of the users
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updateAgreedToTermsOfUse
```
public com.liferay.portal.model.User updateAgreedToTermsOfUse(long userId,
                                                     boolean agreedToTermsOfUse)
                                                       throws com.liferay.portal.kernel.exception.PortalException,
                                                              com.liferay.portal.kernel.exception.SystemException
```
    Updates whether the user has agreed to the terms of use.
    
    Parameters:
    userId - the primary key of the user
    agreedToTermsOfUse - whether the user has agreet to the terms of use
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updateAsset
```
public void updateAsset(long userId,
               com.liferay.portal.model.User user,
               long[] assetCategoryIds,
               java.lang.String[] assetTagNames)
                 throws com.liferay.portal.kernel.exception.PortalException,
                        com.liferay.portal.kernel.exception.SystemException
```
    Updates the user's asset with the new asset categories and tag names, removing and adding asset categories and tag names as necessary.
    
    Parameters:
    userId - the primary key of the user
    user - ID the primary key of the user
    assetCategoryIds - the primary key's of the new asset categories
    assetTagNames - the new asset tag names
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updateCreateDate
```
public com.liferay.portal.model.User updateCreateDate(long userId,
                                             java.util.Date createDate)
                                               throws com.liferay.portal.kernel.exception.PortalException,
                                                      com.liferay.portal.kernel.exception.SystemException
```
    Updates the user's creation date.
    
    Parameters:
    userId - the primary key of the user
    createDate - the new creation date
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updateEmailAddress
```
public com.liferay.portal.model.User updateEmailAddress(long userId,
                                               java.lang.String password,
                                               java.lang.String emailAddress1,
                                               java.lang.String emailAddress2)
                                                 throws com.liferay.portal.kernel.exception.PortalException,
                                                        com.liferay.portal.kernel.exception.SystemException
```
    Updates the user's email address.
    
    Parameters:
    userId - the primary key of the user
    password - the user's password
    emailAddress1 - the user's new email address
    emailAddress2 - the user's new email address confirmation
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updateEmailAddress
```
public com.liferay.portal.model.User updateEmailAddress(long userId,
                                               java.lang.String password,
                                               java.lang.String emailAddress1,
                                               java.lang.String emailAddress2,
                                               com.liferay.portal.service.ServiceContext serviceContext)
                                                 throws com.liferay.portal.kernel.exception.PortalException,
                                                        com.liferay.portal.kernel.exception.SystemException
```
    Updates the user's email address or sends verification email.
    
    Parameters:
    userId - the primary key of the user
    password - the user's password
    emailAddress1 - the user's new email address
    emailAddress2 - the user's new email address confirmation
    serviceContext - the service context to be applied. Must set the portal URL, main path, primary key of the layout, remote address, remote host, and agent for the user.
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updateEmailAddressVerified
```
public com.liferay.portal.model.User updateEmailAddressVerified(long userId,
                                                       boolean emailAddressVerified)
                                                         throws com.liferay.portal.kernel.exception.PortalException,
                                                                com.liferay.portal.kernel.exception.SystemException
```
    Updates whether the user has verified email address.
    
    Parameters:
    userId - the primary key of the user
    emailAddressVerified - whether the user has verified email address
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updateFacebookId
```
public com.liferay.portal.model.User updateFacebookId(long userId,
                                             long facebookId)
                                               throws com.liferay.portal.kernel.exception.PortalException,
                                                      com.liferay.portal.kernel.exception.SystemException
```
    Updates the user's Facebook ID.
    
    Parameters:
    userId - the primary key of the user
    facebookId - the user's new Facebook ID
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updateGroups
```
public void updateGroups(long userId,
                long[] newGroupIds,
                com.liferay.portal.service.ServiceContext serviceContext)
                  throws com.liferay.portal.kernel.exception.PortalException,
                         com.liferay.portal.kernel.exception.SystemException
```
    Sets the groups the user is in, removing and adding groups as necessary.
    
    Parameters:
    userId - the primary key of the user
    newGroupIds - the primary keys of the groups
    serviceContext - the service context to be applied (optionally null)
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updateIncompleteUser
```
public com.liferay.portal.model.User updateIncompleteUser(long creatorUserId,
                                                 long companyId,
                                                 boolean autoPassword,
                                                 java.lang.String password1,
                                                 java.lang.String password2,
                                                 boolean autoScreenName,
                                                 java.lang.String screenName,
                                                 java.lang.String emailAddress,
                                                 long facebookId,
                                                 java.lang.String openId,
                                                 java.util.Locale locale,
                                                 java.lang.String firstName,
                                                 java.lang.String middleName,
                                                 java.lang.String lastName,
                                                 int prefixId,
                                                 int suffixId,
                                                 boolean male,
                                                 int birthdayMonth,
                                                 int birthdayDay,
                                                 int birthdayYear,
                                                 java.lang.String jobTitle,
                                                 boolean updateUserInformation,
                                                 boolean sendEmail,
                                                 com.liferay.portal.service.ServiceContext serviceContext)
                                                   throws com.liferay.portal.kernel.exception.PortalException,
                                                          com.liferay.portal.kernel.exception.SystemException
```
    Updates a user account that was automatically created when a guest user participated in an action (e.g. posting a comment) and only provided his name and email address.
    
    Parameters:
    creatorUserId - the primary key of the creator
    companyId - the primary key of the user's company
    autoPassword - whether a password should be automatically generated for the user
    password1 - the user's password
    password2 - the user's password confirmation
    autoScreenName - whether a screen name should be automatically generated for the user
    screenName - the user's screen name
    emailAddress - the user's email address
    facebookId - the user's facebook ID
    openId - the user's OpenID
    locale - the user's locale
    firstName - the user's first name
    middleName - the user's middle name
    lastName - the user's last name
    prefixId - the user's name prefix ID
    suffixId - the user's name suffix ID
    male - whether the user is male
    birthdayMonth - the user's birthday month (0-based, meaning 0 for January)
    birthdayDay - the user's birthday day
    birthdayYear - the user's birthday year
    jobTitle - the user's job title
    updateUserInformation - whether to update the user's information
    sendEmail - whether to send the user an email notification about their new account
    serviceContext - the service context to be applied (optionally null). Can set expando bridge attributes for the user.
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if the user's information was invalid
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updateJobTitle
```
public com.liferay.portal.model.User updateJobTitle(long userId,
                                           java.lang.String jobTitle)
                                             throws com.liferay.portal.kernel.exception.PortalException,
                                                    com.liferay.portal.kernel.exception.SystemException
```
    Updates the user's job title.
    
    Parameters:
    userId - the primary key of the user
    jobTitle - the user's job title
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found or if a contact could not be found matching the user's contact ID
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updateLastLogin
```
public com.liferay.portal.model.User updateLastLogin(long userId,
                                            java.lang.String loginIP)
                                              throws com.liferay.portal.kernel.exception.PortalException,
                                                     com.liferay.portal.kernel.exception.SystemException
```
    Updates the user's last login with the current time and the IP address.
    
    Parameters:
    userId - the primary key of the user
    loginIP - the IP address the user logged in from
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updateLockout
```
public com.liferay.portal.model.User updateLockout(com.liferay.portal.model.User user,
                                          boolean lockout)
                                            throws com.liferay.portal.kernel.exception.PortalException,
                                                   com.liferay.portal.kernel.exception.SystemException
```
    Updates whether the user is locked out from logging in.
    
    Parameters:
    user - the user
    lockout - whether the user is locked out
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updateLockoutByEmailAddress
```
public com.liferay.portal.model.User updateLockoutByEmailAddress(long companyId,
                                                        java.lang.String emailAddress,
                                                        boolean lockout)
                                                          throws com.liferay.portal.kernel.exception.PortalException,
                                                                 com.liferay.portal.kernel.exception.SystemException
```
    Updates whether the user is locked out from logging in.
    
    Parameters:
    companyId - the primary key of the user's company
    emailAddress - the user's email address
    lockout - whether the user is locked out
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the email address could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updateLockoutById
```
public com.liferay.portal.model.User updateLockoutById(long userId,
                                              boolean lockout)
                                                throws com.liferay.portal.kernel.exception.PortalException,
                                                       com.liferay.portal.kernel.exception.SystemException
```
    Updates whether the user is locked out from logging in.
    
    Parameters:
    userId - the primary key of the user
    lockout - whether the user is locked out
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updateLockoutByScreenName
```
public com.liferay.portal.model.User updateLockoutByScreenName(long companyId,
                                                      java.lang.String screenName,
                                                      boolean lockout)
                                                        throws com.liferay.portal.kernel.exception.PortalException,
                                                               com.liferay.portal.kernel.exception.SystemException
```
    Updates whether the user is locked out from logging in.
    
    Parameters:
    companyId - the primary key of the user's company
    screenName - the user's screen name
    lockout - whether the user is locked out
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the screen name could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updateModifiedDate
```
public com.liferay.portal.model.User updateModifiedDate(long userId,
                                               java.util.Date modifiedDate)
                                                 throws com.liferay.portal.kernel.exception.PortalException,
                                                        com.liferay.portal.kernel.exception.SystemException
```
    Updates the user's modified date.
    
    Parameters:
    userId - the primary key of the user
    modifiedDate - the new modified date
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updateOpenId
```
public com.liferay.portal.model.User updateOpenId(long userId,
                                         java.lang.String openId)
                                           throws com.liferay.portal.kernel.exception.PortalException,
                                                  com.liferay.portal.kernel.exception.SystemException
```
    Updates the user's OpenID.
    
    Parameters:
    userId - the primary key of the user
    openId - the new OpenID
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updateOrganizations
```
public void updateOrganizations(long userId,
                       long[] newOrganizationIds,
                       com.liferay.portal.service.ServiceContext serviceContext)
                         throws com.liferay.portal.kernel.exception.PortalException,
                                com.liferay.portal.kernel.exception.SystemException
```
    Sets the organizations that the user is in, removing and adding organizations as necessary.
    
    Parameters:
    userId - the primary key of the user
    newOrganizationIds - the primary keys of the organizations
    serviceContext - the service context to be applied. Must set whether user indexing is enabled.
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updatePassword
```
public com.liferay.portal.model.User updatePassword(long userId,
                                           java.lang.String password1,
                                           java.lang.String password2,
                                           boolean passwordReset)
                                             throws com.liferay.portal.kernel.exception.PortalException,
                                                    com.liferay.portal.kernel.exception.SystemException
```
    Updates the user's password without tracking or validation of the change.
    
    Parameters:
    userId - the primary key of the user
    password1 - the user's new password
    password2 - the user's new password confirmation
    passwordReset - whether the user should be asked to reset their password the next time they log in
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updatePassword
```
public com.liferay.portal.model.User updatePassword(long userId,
                                           java.lang.String password1,
                                           java.lang.String password2,
                                           boolean passwordReset,
                                           boolean silentUpdate)
                                             throws com.liferay.portal.kernel.exception.PortalException,
                                                    com.liferay.portal.kernel.exception.SystemException
```
    Updates the user's password, optionally with tracking and validation of the change.
    
    Parameters:
    userId - the primary key of the user
    password1 - the user's new password
    password2 - the user's new password confirmation
    passwordReset - whether the user should be asked to reset their password the next time they login
    silentUpdate - whether the password should be updated without being tracked, or validated. Primarily used for password imports.
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updatePasswordManually
```
public com.liferay.portal.model.User updatePasswordManually(long userId,
                                                   java.lang.String password,
                                                   boolean passwordEncrypted,
                                                   boolean passwordReset,
                                                   java.util.Date passwordModifiedDate)
                                                     throws com.liferay.portal.kernel.exception.PortalException,
                                                            com.liferay.portal.kernel.exception.SystemException
```
    Updates the user's password with manually input information. This method should only be used when performing maintenance.
    
    Parameters:
    userId - the primary key of the user
    password - the user's new password
    passwordEncrypted - the user's new encrypted password
    passwordReset - whether the user should be asked to reset their password the next time they login
    passwordModifiedDate - the new password modified date
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updatePasswordReset
```
public com.liferay.portal.model.User updatePasswordReset(long userId,
                                                boolean passwordReset)
                                                  throws com.liferay.portal.kernel.exception.PortalException,
                                                         com.liferay.portal.kernel.exception.SystemException
```
    Updates whether the user should be asked to reset their password the next time they login.
    
    Parameters:
    userId - the primary key of the user
    passwordReset - whether the user should be asked to reset their password the next time they login
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updatePortrait
```
public com.liferay.portal.model.User updatePortrait(long userId,
                                           byte[] bytes)
                                             throws com.liferay.portal.kernel.exception.PortalException,
                                                    com.liferay.portal.kernel.exception.SystemException
```
    Updates the user's portrait image.
    
    Parameters:
    userId - the primary key of the user
    bytes - the new portrait image data
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found or if the new portrait was invalid
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updateReminderQuery
```
public com.liferay.portal.model.User updateReminderQuery(long userId,
                                                java.lang.String question,
                                                java.lang.String answer)
                                                  throws com.liferay.portal.kernel.exception.PortalException,
                                                         com.liferay.portal.kernel.exception.SystemException
```
    Updates the user's password reset question and answer.
    
    Parameters:
    userId - the primary key of the user
    question - the user's new password reset question
    answer - the user's new password reset answer
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found or if the new question or answer were invalid
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updateScreenName
```
public com.liferay.portal.model.User updateScreenName(long userId,
                                             java.lang.String screenName)
                                               throws com.liferay.portal.kernel.exception.PortalException,
                                                      com.liferay.portal.kernel.exception.SystemException
```
    Updates the user's screen name.
    
    Parameters:
    userId - the primary key of the user
    screenName - the user's new screen name
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found or if the new screen name was invalid
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updateStatus
```
@Deprecated
public com.liferay.portal.model.User updateStatus(long userId,
                                                    int status)
                                           throws com.liferay.portal.kernel.exception.PortalException,
                                                  com.liferay.portal.kernel.exception.SystemException
```
    Deprecated. As of 7.0.0, replaced by updateStatus(long, int, ServiceContext)
    
    Updates the user's workflow status.
    
    Parameters:
    userId - the primary key of the user
    status - the user's new workflow status
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updateStatus
```
public com.liferay.portal.model.User updateStatus(long userId,
                                         int status,
                                         com.liferay.portal.service.ServiceContext serviceContext)
                                           throws com.liferay.portal.kernel.exception.PortalException,
                                                  com.liferay.portal.kernel.exception.SystemException
```
    Updates the user's workflow status.
    
    Parameters:
    userId - the primary key of the user
    status - the user's new workflow status
    serviceContext - the service context to be applied. You can specify an unencrypted custom password (used by an LDAP listener) for the user via attribute passwordUnencrypted.
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - updateUser
```
public com.liferay.portal.model.User updateUser(long userId,
                                       java.lang.String oldPassword,
                                       java.lang.String newPassword1,
                                       java.lang.String newPassword2,
                                       boolean passwordReset,
                                       java.lang.String reminderQueryQuestion,
                                       java.lang.String reminderQueryAnswer,
                                       java.lang.String screenName,
                                       java.lang.String emailAddress,
                                       long facebookId,
                                       java.lang.String openId,
                                       java.lang.String languageId,
                                       java.lang.String timeZoneId,
                                       java.lang.String greeting,
                                       java.lang.String comments,
                                       java.lang.String firstName,
                                       java.lang.String middleName,
                                       java.lang.String lastName,
                                       int prefixId,
                                       int suffixId,
                                       boolean male,
                                       int birthdayMonth,
                                       int birthdayDay,
                                       int birthdayYear,
                                       java.lang.String smsSn,
                                       java.lang.String aimSn,
                                       java.lang.String facebookSn,
                                       java.lang.String icqSn,
                                       java.lang.String jabberSn,
                                       java.lang.String msnSn,
                                       java.lang.String mySpaceSn,
                                       java.lang.String skypeSn,
                                       java.lang.String twitterSn,
                                       java.lang.String ymSn,
                                       java.lang.String jobTitle,
                                       long[] groupIds,
                                       long[] organizationIds,
                                       long[] roleIds,
                                       java.util.List<com.liferay.portal.model.UserGroupRole> userGroupRoles,
                                       long[] userGroupIds,
                                       com.liferay.portal.service.ServiceContext serviceContext)
                                         throws com.liferay.portal.kernel.exception.PortalException,
                                                com.liferay.portal.kernel.exception.SystemException
```
    Updates the user.
    
    Parameters:
    userId - the primary key of the user
    oldPassword - the user's old password
    newPassword1 - the user's new password (optionally null)
    newPassword2 - the user's new password confirmation (optionally null)
    passwordReset - whether the user should be asked to reset their password the next time they login
    reminderQueryQuestion - the user's new password reset question
    reminderQueryAnswer - the user's new password reset answer
    screenName - the user's new screen name
    emailAddress - the user's new email address
    facebookId - the user's new Facebook ID
    openId - the user's new OpenID
    languageId - the user's new language ID
    timeZoneId - the user's new time zone ID
    greeting - the user's new greeting
    comments - the user's new comments
    firstName - the user's new first name
    middleName - the user's new middle name
    lastName - the user's new last name
    prefixId - the user's new name prefix ID
    suffixId - the user's new name suffix ID
    male - whether user is male
    birthdayMonth - the user's new birthday month (0-based, meaning 0 for January)
    birthdayDay - the user's new birthday day
    birthdayYear - the user's birthday year
    smsSn - the user's new SMS screen name
    aimSn - the user's new AIM screen name
    facebookSn - the user's new Facebook screen name
    icqSn - the user's new ICQ screen name
    jabberSn - the user's new Jabber screen name
    msnSn - the user's new MSN screen name
    mySpaceSn - the user's new MySpace screen name
    skypeSn - the user's new Skype screen name
    twitterSn - the user's new Twitter screen name
    ymSn - the user's new Yahoo! Messenger screen name
    jobTitle - the user's new job title
    groupIds - the primary keys of the user's groups
    organizationIds - the primary keys of the user's organizations
    roleIds - the primary keys of the user's roles
    userGroupRoles - the user user's group roles
    userGroupIds - the primary keys of the user's user groups
    serviceContext - the service context to be applied (optionally null). Can set the UUID (with the uuid attribute), asset category IDs, asset tag names, and expando bridge attributes for the user.
    
    Returns:
    the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found or if the new information was invalid
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - verifyEmailAddress
```
public void verifyEmailAddress(java.lang.String ticketKey)
                        throws com.liferay.portal.kernel.exception.PortalException,
                               com.liferay.portal.kernel.exception.SystemException
```
    Verifies the email address of the ticket.
    
    Parameters:
    ticketKey - the ticket key
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a ticket matching the ticket key could not be found, if the ticket has expired, if the ticket is an email address ticket, or if the email address is invalid
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
  - addDefaultRolesAndTeams
```
protected void addDefaultRolesAndTeams(long groupId,
                           long[] userIds)
                                throws com.liferay.portal.kernel.exception.PortalException,
                                       com.liferay.portal.kernel.exception.SystemException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
    
    com.liferay.portal.kernel.exception.SystemException
  - authenticate
```
protected int authenticate(long companyId,
               java.lang.String login,
               java.lang.String password,
               java.lang.String authType,
               java.util.Map<java.lang.String,java.lang.String[]> headerMap,
               java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
               java.util.Map<java.lang.String,java.lang.Object> resultsMap)
                    throws com.liferay.portal.kernel.exception.PortalException,
                           com.liferay.portal.kernel.exception.SystemException
```
    Attempts to authenticate the user by their login and password, while using the AuthPipeline.
    Authentication type specifies what login contains.The valid values are:
    - CompanyConstants.AUTH_TYPE_EA - login is the user's email address
    - CompanyConstants.AUTH_TYPE_SN - login is the user's screen name
    - CompanyConstants.AUTH_TYPE_ID - login is the user's primary key
    Parameters:
    companyId - the primary key of the user's company
    login - either the user's email address, screen name, or primary key depending on the value of authType
    password - the user's password
    authType - the type of authentication to perform
    headerMap - the header map from the authentication request
    parameterMap - the parameter map from the authentication request
    resultsMap - the map of authentication results (may be nil). After a succesful authentication the user's primary key will be placed under the key userId.
    
    Returns:
    the authentication status. This can be Authenticator.FAILURE indicating that the user's credentials are invalid, Authenticator.SUCCESS indicating a successful login, or Authenticator.DNE indicating that a user with that login does not exist.
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if login or password was null
    
    com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
    See Also:
    AuthPipeline
  - getBirthday
```
protected java.util.Date getBirthday(int birthdayMonth,
                         int birthdayDay,
                         int birthdayYear)
                              throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - getLogin
```
protected java.lang.String getLogin(java.lang.String login)
```
  - getUserIds
```
protected long[] getUserIds(java.util.List<com.liferay.portal.model.User> users)
```
  - reindex
```
protected void reindex(com.liferay.portal.model.User user)
```
  - search
```
protected com.liferay.portal.kernel.search.Hits search(long companyId,
                                           java.lang.String firstName,
                                           java.lang.String middleName,
                                           java.lang.String lastName,
                                           java.lang.String fullName,
                                           java.lang.String screenName,
                                           java.lang.String emailAddress,
                                           java.lang.String street,
                                           java.lang.String city,
                                           java.lang.String zip,
                                           java.lang.String region,
                                           java.lang.String country,
                                           int status,
                                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                           boolean andSearch,
                                           int start,
                                           int end,
                                           com.liferay.portal.kernel.search.Sort sort)
                                                throws com.liferay.portal.kernel.exception.SystemException
```
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException
  - sendEmail
```
protected void sendEmail(com.liferay.portal.model.User user,
             java.lang.String password,
             com.liferay.portal.service.ServiceContext serviceContext)
                  throws com.liferay.portal.kernel.exception.SystemException
```
    Throws:
    
    com.liferay.portal.kernel.exception.SystemException
  - setEmailAddress
```
protected void setEmailAddress(com.liferay.portal.model.User user,
                   java.lang.String password,
                   java.lang.String firstName,
                   java.lang.String middleName,
                   java.lang.String lastName,
                   java.lang.String emailAddress)
                        throws com.liferay.portal.kernel.exception.PortalException,
                               com.liferay.portal.kernel.exception.SystemException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
    
    com.liferay.portal.kernel.exception.SystemException
  - updateGroups
```
protected void updateGroups(long userId,
                long[] newGroupIds,
                com.liferay.portal.service.ServiceContext serviceContext,
                boolean indexingEnabled)
                     throws com.liferay.portal.kernel.exception.PortalException,
                            com.liferay.portal.kernel.exception.SystemException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
    
    com.liferay.portal.kernel.exception.SystemException
  - updateOrganizations
```
protected void updateOrganizations(long userId,
                       long[] newOrganizationIds,
                       boolean indexingEnabled)
                            throws com.liferay.portal.kernel.exception.PortalException,
                                   com.liferay.portal.kernel.exception.SystemException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
    
    com.liferay.portal.kernel.exception.SystemException
  - updateUserGroupRoles
```
protected void updateUserGroupRoles(com.liferay.portal.model.User user,
                        long[] groupIds,
                        long[] organizationIds,
                        java.util.List<com.liferay.portal.model.UserGroupRole> userGroupRoles,
                        java.util.List<com.liferay.portal.model.UserGroupRole> previousUserGroupRoles)
                             throws com.liferay.portal.kernel.exception.PortalException,
                                    com.liferay.portal.kernel.exception.SystemException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
    
    com.liferay.portal.kernel.exception.SystemException
  - validate
```
protected void validate(long companyId,
            long userId,
            boolean autoPassword,
            java.lang.String password1,
            java.lang.String password2,
            boolean autoScreenName,
            java.lang.String screenName,
            java.lang.String emailAddress,
            java.lang.String openId,
            java.lang.String firstName,
            java.lang.String middleName,
            java.lang.String lastName,
            long[] organizationIds)
                 throws com.liferay.portal.kernel.exception.PortalException,
                        com.liferay.portal.kernel.exception.SystemException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
    
    com.liferay.portal.kernel.exception.SystemException
  - validate
```
protected void validate(long userId,
            java.lang.String screenName,
            java.lang.String emailAddress,
            java.lang.String openId,
            java.lang.String firstName,
            java.lang.String middleName,
            java.lang.String lastName,
            java.lang.String smsSn)
                 throws com.liferay.portal.kernel.exception.PortalException,
                        com.liferay.portal.kernel.exception.SystemException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
    
    com.liferay.portal.kernel.exception.SystemException
  - validateCompanyMaxUsers
```
protected void validateCompanyMaxUsers(long companyId)
                                throws com.liferay.portal.kernel.exception.PortalException,
                                       com.liferay.portal.kernel.exception.SystemException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
    
    com.liferay.portal.kernel.exception.SystemException
  - validateEmailAddress
```
protected void validateEmailAddress(long companyId,
                        java.lang.String emailAddress)
                             throws com.liferay.portal.kernel.exception.PortalException,
                                    com.liferay.portal.kernel.exception.SystemException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
    
    com.liferay.portal.kernel.exception.SystemException
  - validateEmailAddress
```
protected void validateEmailAddress(com.liferay.portal.model.User user,
                        java.lang.String emailAddress1,
                        java.lang.String emailAddress2)
                             throws com.liferay.portal.kernel.exception.PortalException,
                                    com.liferay.portal.kernel.exception.SystemException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
    
    com.liferay.portal.kernel.exception.SystemException
  - validateFullName
```
protected void validateFullName(long companyId,
                    java.lang.String firstName,
                    java.lang.String middleName,
                    java.lang.String lastName)
                         throws com.liferay.portal.kernel.exception.PortalException,
                                com.liferay.portal.kernel.exception.SystemException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
    
    com.liferay.portal.kernel.exception.SystemException
  - validateOpenId
```
protected void validateOpenId(long companyId,
                  long userId,
                  java.lang.String openId)
                       throws com.liferay.portal.kernel.exception.PortalException,
                              com.liferay.portal.kernel.exception.SystemException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
    
    com.liferay.portal.kernel.exception.SystemException
  - validatePassword
```
protected void validatePassword(long companyId,
                    long userId,
                    java.lang.String password1,
                    java.lang.String password2)
                         throws com.liferay.portal.kernel.exception.PortalException,
                                com.liferay.portal.kernel.exception.SystemException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
    
    com.liferay.portal.kernel.exception.SystemException
  - validateReminderQuery
```
protected void validateReminderQuery(java.lang.String question,
                         java.lang.String answer)
                              throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - validateScreenName
```
protected void validateScreenName(long companyId,
                      long userId,
                      java.lang.String screenName)
                           throws com.liferay.portal.kernel.exception.PortalException,
                                  com.liferay.portal.kernel.exception.SystemException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
    
    com.liferay.portal.kernel.exception.SystemException

Class UserLocalServiceImpl

Field Summary

Fields inherited from class com.liferay.portal.service.base.UserLocalServiceBaseImpl

Constructor Summary

Method Summary

Methods inherited from class com.liferay.portal.service.base.UserLocalServiceBaseImpl

Methods inherited from class com.liferay.portal.service.BaseLocalServiceImpl

Methods inherited from class java.lang.Object

Constructor Detail

UserLocalServiceImpl

Method Detail

addDefaultAdminUser

addDefaultGroups

addDefaultRoles

addDefaultUserGroups

addGroupUsers

addOrganizationUsers

addPasswordPolicyUsers

addRoleUsers

addTeamUsers

addUser

addUserGroupUsers

addUserWithWorkflow

afterPropertiesSet

authenticateByEmailAddress

authenticateByScreenName

authenticateByUserId

authenticateForBasic

authenticateForDigest

authenticateForJAAS

checkLockout

checkLoginFailure

checkLoginFailureByEmailAddress

checkLoginFailureById

checkLoginFailureByScreenName

checkPasswordExpired

clearOrganizationUsers

clearUserGroupUsers

completeUserRegistration

decryptUserId

deletePortrait

deleteRoleUser

deleteUser

deleteUser

deleteUserGroupUser

encryptUserId

fetchUserByEmailAddress

fetchUserByFacebookId

fetchUserById

fetchUserByOpenId

fetchUserByScreenName

getCompanyUsers

getCompanyUsersCount

getDefaultUser

getDefaultUserId

getGroupUserIds

getGroupUsersCount

getInheritedRoleUsers

getNoAnnouncementsDeliveries

getNoContacts

getNoGroups

getOrganizationUserIds

getOrganizationUsersCount

getRoleUserIds

getRoleUsersCount

getSocialUsers

getSocialUsers

getSocialUsers

getSocialUsers

getSocialUsersCount

getSocialUsersCount

getSocialUsersCount

getSocialUsersCount

getUserByContactId

getUserByEmailAddress

getUserByFacebookId

getUserById

getUserById

getUserByOpenId

getUserByPortraitId