Class UserLocalServiceWrapper
- All Implemented Interfaces:
BaseLocalService
,CTService<User>
,PersistedModelLocalService
,ServiceWrapper<UserLocalService>
,UserLocalService
UserLocalService
.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddDefaultAdminUser
(long companyId, String password, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName) Adds a default admin user for the company.boolean
addDefaultGroups
(long userId) Adds the user to the default groups, unless the user is already in these groups.boolean
addDefaultRoles
(long userId) Adds the user to the default regular roles, unless the user already has these regular roles.addDefaultServiceAccountUser
(long companyId) boolean
addDefaultUserGroups
(long userId) Adds the user to the default user groups, unless the user is already in these user groups.boolean
addGroupUser
(long groupId, long userId) boolean
addGroupUser
(long groupId, User user) boolean
addGroupUsers
(long groupId, long[] userIds) boolean
addGroupUsers
(long groupId, List<User> users) boolean
addOrganizationUser
(long organizationId, long userId) boolean
addOrganizationUser
(long organizationId, User user) boolean
addOrganizationUsers
(long organizationId, long[] userIds) boolean
addOrganizationUsers
(long organizationId, List<User> users) addOrUpdateUser
(String externalReferenceCode, long creatorUserId, long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, boolean sendEmail, ServiceContext serviceContext) void
addPasswordPolicyUsers
(long passwordPolicyId, long[] userIds) Assigns the password policy to the users, removing any other currently assigned password policies.boolean
addRoleUser
(long roleId, long userId) boolean
addRoleUser
(long roleId, User user) boolean
addRoleUsers
(long roleId, long[] userIds) boolean
addRoleUsers
(long roleId, List<User> users) boolean
addTeamUser
(long teamId, long userId) boolean
addTeamUser
(long teamId, User user) boolean
addTeamUsers
(long teamId, long[] userIds) boolean
addTeamUsers
(long teamId, List<User> users) addUser
(long creatorUserId, long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, int type, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, ServiceContext serviceContext) Adds a user.Adds the user to the database.boolean
addUserGroupUser
(long userGroupId, long userId) boolean
addUserGroupUser
(long userGroupId, User user) boolean
addUserGroupUsers
(long userGroupId, long[] userIds) boolean
addUserGroupUsers
(long userGroupId, List<User> users) addUserWithWorkflow
(long creatorUserId, long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, int type, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, ServiceContext serviceContext) Adds a user with workflow.int
authenticateByEmailAddress
(long companyId, String emailAddress, String password, Map<String, String[]> headerMap, Map<String, String[]> parameterMap, Map<String, Object> resultsMap) Attempts to authenticate the user by their email address and password, while using the AuthPipeline.int
authenticateByScreenName
(long companyId, String screenName, String password, Map<String, String[]> headerMap, Map<String, String[]> parameterMap, Map<String, Object> resultsMap) Attempts to authenticate the user by their screen name and password, while using the AuthPipeline.int
authenticateByUserId
(long companyId, long userId, String password, Map<String, String[]> headerMap, Map<String, String[]> parameterMap, Map<String, Object> resultsMap) Attempts to authenticate the user by their primary key and password, while using the AuthPipeline.long
authenticateForBasic
(long companyId, String authType, String login, String password) Attempts to authenticate the user using HTTP basic access authentication, without using the AuthPipeline.long
authenticateForDigest
(long companyId, String userName, String realm, String nonce, String method, String uri, String response) Deprecated.As of Cavanaugh (7.4.x), with no direct replacementvoid
checkLockout
(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
(User user) Adds a failed login attempt to the user and updates the user's last failed login date.void
checkLoginFailureByEmailAddress
(long companyId, 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, 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
(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
clearGroupUsers
(long groupId) void
clearOrganizationUsers
(long organizationId) void
clearRoleUsers
(long roleId) void
clearTeamUsers
(long teamId) void
clearUserGroupUsers
(long userGroupId) void
completeUserRegistration
(User user, ServiceContext serviceContext) Completes the user's registration by generating a password and sending the confirmation email.createPersistedModel
(Serializable primaryKeyObj) createUser
(long userId) Creates a new user with the primary key.void
deleteGroupUser
(long groupId, long userId) void
deleteGroupUser
(long groupId, User user) void
deleteGroupUsers
(long groupId, long[] userIds) void
deleteGroupUsers
(long groupId, List<User> users) void
deleteOrganizationUser
(long organizationId, long userId) void
deleteOrganizationUser
(long organizationId, User user) void
deleteOrganizationUsers
(long organizationId, long[] userIds) void
deleteOrganizationUsers
(long organizationId, List<User> users) deletePersistedModel
(PersistedModel persistedModel) void
deletePortrait
(long userId) Deletes the user's portrait image.void
deleteRoleUser
(long roleId, long userId) void
deleteRoleUser
(long roleId, User user) void
deleteRoleUsers
(long roleId, long[] userIds) void
deleteRoleUsers
(long roleId, List<User> users) void
deleteTeamUser
(long teamId, long userId) void
deleteTeamUser
(long teamId, User user) void
deleteTeamUsers
(long teamId, long[] userIds) void
deleteTeamUsers
(long teamId, List<User> users) deleteUser
(long userId) Deletes the user with the primary key from the database.deleteUser
(User user) Deletes the user from the database.void
deleteUserGroupUser
(long userGroupId, long userId) void
deleteUserGroupUser
(long userGroupId, User user) void
deleteUserGroupUsers
(long userGroupId, long[] userIds) void
deleteUserGroupUsers
(long userGroupId, List<User> users) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.<T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.long
dynamicQueryCount
(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.long
dynamicQueryCount
(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.encryptUserId
(String name) Encrypts the primary key of the user.fetchGuestUser
(long companyId) Returns the guest user for the company.fetchUser
(long userId) fetchUserByContactId
(long contactId) Returns the user with the contact ID.fetchUserByEmailAddress
(long companyId, String emailAddress) Returns the user with the email address.fetchUserByExternalReferenceCode
(String externalReferenceCode, long companyId) fetchUserByFacebookId
(long companyId, long facebookId) Deprecated.As of Athanasius (7.3.x), with no direct replacementfetchUserByGoogleUserId
(long companyId, String googleUserId) Returns the user with the Google user ID.fetchUserById
(long userId) Returns the user with the primary key.fetchUserByOpenId
(long companyId, String openId) Deprecated.As of Athanasius (7.3.x), with no direct replacementfetchUserByPortraitId
(long portraitId) Returns the user with the portrait ID.fetchUserByScreenName
(long companyId, String screenName) Returns the user with the screen name.fetchUserByUuidAndCompanyId
(String uuid, long companyId) Returns the user with the matching UUID and company.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.getDefaultUser
(long companyId) Deprecated.As of Cavanaugh (7.4.x), replaced bygetGuestUser(long)
long
getDefaultUserId
(long companyId) Deprecated.As of Cavanaugh (7.4.x), replaced bygetGuestUserId(long)
getExportActionableDynamicQuery
(PortletDataContext portletDataContext) long[]
getGroupPrimaryKeys
(long userId) Returns the groupIds of the groups associated with the user.long[]
getGroupUserIds
(long groupId) Returns the primary keys of all the users belonging to the group.getGroupUsers
(long groupId) getGroupUsers
(long groupId, int start, int end) getGroupUsers
(long groupId, int status, int start, int end, OrderByComparator<User> orderByComparator) Returns the users belonging to a group.getGroupUsers
(long groupId, int start, int end, OrderByComparator<User> orderByComparator) getGroupUsers
(long groupId, int status, OrderByComparator<User> orderByComparator) Returns the users belonging to a group.int
getGroupUsersCount
(long groupId) int
getGroupUsersCount
(long groupId, int status) Returns the number of users with the status belonging to the group.getGuestUser
(long companyId) Returns the guest user for the company.long
getGuestUserId
(long companyId) Returns the primary key of the guest user for the company.getInheritedRoleUsers
(long roleId, int start, int end, OrderByComparator<User> orderByComparator) Returns all the users who have not had any announcements of the type delivered, excluding the default user.Returns all the users who do not belong to any groups, excluding the default user.long[]
getOrganizationPrimaryKeys
(long userId) Returns the organizationIds of the organizations associated with the user.int
getOrganizationsAndUserGroupsUsersCount
(long[] organizationIds, long[] userGroupIds) long[]
getOrganizationUserIds
(long organizationId) Returns the primary keys of all the users belonging to the organization.getOrganizationUsers
(long organizationId) getOrganizationUsers
(long organizationId, int start, int end) getOrganizationUsers
(long organizationId, int status, int start, int end, OrderByComparator<User> orderByComparator) Returns the users belonging to the organization with the status.getOrganizationUsers
(long organizationId, int start, int end, OrderByComparator<User> orderByComparator) getOrganizationUsers
(long organizationId, int status, OrderByComparator<User> orderByComparator) Returns the users belonging to the organization with the status.int
getOrganizationUsersCount
(long organizationId) int
getOrganizationUsersCount
(long organizationId, int status) Returns the number of users with the status belonging to the organization.Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) long[]
getRolePrimaryKeys
(long userId) Returns the roleIds of the roles associated with the user.long[]
getRoleUserIds
(long roleId) Returns the primary keys of all the users belonging to the role.long[]
getRoleUserIds
(long roleId, long type) getRoleUsers
(long roleId) getRoleUsers
(long roleId, int start, int end) getRoleUsers
(long roleId, int start, int end, OrderByComparator<User> orderByComparator) int
getRoleUsersCount
(long roleId) int
getRoleUsersCount
(long roleId, int status) Returns the number of users with the status belonging to the role.getSocialUsers
(long userId, int socialRelationType, String socialRelationTypeComparator, int start, int end, OrderByComparator<User> orderByComparator) getSocialUsers
(long userId1, long userId2, int socialRelationType, int start, int end, OrderByComparator<User> orderByComparator) Returns an ordered range of all the users with a mutual social relation of the type with both of the given users.getSocialUsers
(long userId1, long userId2, int start, int end, OrderByComparator<User> orderByComparator) Returns an ordered range of all the users with a mutual social relation with both of the given users.int
getSocialUsersCount
(long userId, int socialRelationType, String socialRelationTypeComparator) Returns the number of users with a social relation 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 socialRelationType) Returns the number of users with a mutual social relation of the type with both of the given users.long[]
getTeamPrimaryKeys
(long userId) Returns the teamIds of the teams associated with the user.getTeamUsers
(long teamId) getTeamUsers
(long teamId, int start, int end) getTeamUsers
(long teamId, int start, int end, OrderByComparator<User> orderByComparator) int
getTeamUsersCount
(long teamId) getUser
(long userId) Returns the user with the primary key.getUserByContactId
(long contactId) Returns the user with the contact ID.getUserByEmailAddress
(long companyId, String emailAddress) Returns the user with the email address.getUserByExternalReferenceCode
(String externalReferenceCode, long companyId) getUserByFacebookId
(long companyId, long facebookId) Deprecated.As of Athanasius (7.3.x), with no direct replacementgetUserByGoogleUserId
(long companyId, String googleUserId) Returns the user with the Google user ID.getUserById
(long userId) Returns the user with the primary key.getUserById
(long companyId, long userId) Returns the user with the primary key from the company.getUserByOpenId
(long companyId, String openId) Deprecated.As of Athanasius (7.3.x), with no direct replacementgetUserByPortraitId
(long portraitId) Returns the user with the portrait ID.getUserByScreenName
(long companyId, String screenName) Returns the user with the screen name.getUserByUuidAndCompanyId
(String uuid, long companyId) Returns the user with the matching UUID and company.long[]
getUserGroupPrimaryKeys
(long userId) Returns the userGroupIds of the user groups associated with the user.getUserGroupUsers
(long userGroupId) getUserGroupUsers
(long userGroupId, int start, int end) getUserGroupUsers
(long userGroupId, int start, int end, OrderByComparator<User> orderByComparator) int
getUserGroupUsersCount
(long userGroupId) int
getUserGroupUsersCount
(long userGroupId, int status) Returns the number of users with the status belonging to the user group.long
getUserIdByEmailAddress
(long companyId, String emailAddress) Returns the primary key of the user with the email address.long
getUserIdByScreenName
(long companyId, String screenName) Returns the primary key of the user with the screen name.getUsers
(int start, int end) Returns a range of all the users.getUsers
(long companyId, int status, int start, int end, OrderByComparator<User> orderByComparator) getUsersByRoleId
(long roleId, int start, int end) getUsersByRoleName
(long companyId, String roleName, int start, int end) int
Returns the number of users.int
getUsersCount
(long companyId, int status) boolean
hasGroupUser
(long groupId, long userId) boolean
hasGroupUsers
(long groupId) boolean
hasOrganizationUser
(long organizationId, long userId) boolean
hasOrganizationUsers
(long organizationId) boolean
hasPasswordPolicyUser
(long passwordPolicyId, long userId) Returnstrue
if the password policy has been assigned to the user.boolean
hasRoleUser
(long roleId, long userId) boolean
hasRoleUser
(long companyId, String name, long userId, boolean inherited) Returnstrue
if the user has the role with the name, optionally through inheritance.boolean
hasRoleUsers
(long roleId) boolean
hasTeamUser
(long teamId, long userId) boolean
hasTeamUsers
(long teamId) boolean
hasUserGroupUser
(long userGroupId, long userId) boolean
hasUserGroupUsers
(long userGroupId) boolean
isPasswordExpired
(User user) Returnstrue
if the user's password is expired.loadGetGuestUser
(long companyId) Returns the guest user for the company.search
(long companyId, String keywords, int status, LinkedHashMap<String, Object> params, int start, int end, Sort sort) Returns an ordered range of all the users who match the keywords and status, using the indexer.search
(long companyId, String keywords, int status, LinkedHashMap<String, Object> params, int start, int end, Sort[] sorts) search
(long companyId, String keywords, int status, LinkedHashMap<String, Object> params, int start, int end, OrderByComparator<User> orderByComparator) Returns an ordered range of all the users who match the keywords and status, without using the indexer.search
(long companyId, String firstName, String middleName, String lastName, String screenName, String emailAddress, int status, LinkedHashMap<String, Object> params, boolean andSearch, int start, int end, 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.search
(long companyId, String firstName, String middleName, String lastName, String screenName, String emailAddress, int status, LinkedHashMap<String, Object> params, boolean andSearch, int start, int end, Sort[] sorts) search
(long companyId, String firstName, String middleName, String lastName, String screenName, String emailAddress, int status, LinkedHashMap<String, Object> params, boolean andSearch, int start, int end, OrderByComparator<User> orderByComparator) 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.searchBySocial
(long[] groupIds, long userId, int[] socialRelationTypes, String keywords, int start, int end) searchBySocial
(long userId, int[] socialRelationTypes, String keywords, int start, int end) searchBySocial
(long companyId, long[] groupIds, long[] userGroupIds, String keywords, int start, int end) searchBySocial
(long companyId, long[] groupIds, long[] userGroupIds, String keywords, int start, int end, OrderByComparator<User> orderByComparator) int
searchCount
(long companyId, String keywords, int status, LinkedHashMap<String, Object> params) Returns the number of users who match the keywords and status.int
searchCount
(long companyId, String firstName, String middleName, String lastName, String screenName, String emailAddress, int status, LinkedHashMap<String, 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.searchCounts
(long companyId, int status, long[] groupIds) searchUsers
(long companyId, String keywords, int status, LinkedHashMap<String, Object> params, int start, int end, Sort sort) searchUsers
(long companyId, String keywords, int status, LinkedHashMap<String, Object> params, int start, int end, Sort[] sorts) searchUsers
(long companyId, String firstName, String middleName, String lastName, String screenName, String emailAddress, int status, LinkedHashMap<String, Object> params, boolean andSearch, int start, int end, Sort sort) searchUsers
(long companyId, String firstName, String middleName, String lastName, String screenName, String emailAddress, int status, LinkedHashMap<String, Object> params, boolean andSearch, int start, int end, Sort[] sorts) void
sendEmailAddressVerification
(User user, String emailAddress, ServiceContext serviceContext) Sends an email address verification to the user.boolean
sendEmailUserCreationAttempt
(long companyId, String emailAddress, String fromName, String fromAddress, String subject, String body, ServiceContext serviceContext) boolean
sendPassword
(long companyId, String emailAddress, String fromName, String fromAddress, String subject, String body, ServiceContext serviceContext) boolean
sendPasswordByEmailAddress
(long companyId, String emailAddress) Sends a password notification email to the user matching the email address.boolean
sendPasswordByScreenName
(long companyId, String screenName) Sends a password notification email to the user matching the screen name.boolean
sendPasswordByUserId
(long userId) Sends a password notification email to the user matching the ID.boolean
sendPasswordLockout
(long companyId, String emailAddress, String fromName, String fromAddress, String subject, String body, ServiceContext serviceContext) void
setGroupUsers
(long groupId, long[] userIds) void
setOrganizationUsers
(long organizationId, long[] userIds) void
setRoleUsers
(long roleId, long[] userIds) void
setTeamUsers
(long teamId, long[] userIds) void
setUserGroupUsers
(long userGroupId, long[] userIds) void
setWrappedService
(UserLocalService userLocalService) void
unsetGroupTeamsUsers
(long groupId, long[] userIds) Removes the users from the teams of a group.void
unsetGroupUsers
(long groupId, long[] userIds, 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, long[] userIds) Removes the users from the role.void
unsetRoleUsers
(long roleId, List<User> users) 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.updateAgreedToTermsOfUse
(long userId, boolean agreedToTermsOfUse) Updates whether the user has agreed to the terms of use.void
updateAsset
(long userId, User user, long[] assetCategoryIds, 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.updateCreateDate
(long userId, Date createDate) Updates the user's creation date.updateEmailAddress
(long userId, String password, String emailAddress1, String emailAddress2) Updates the user's email address.updateEmailAddress
(long userId, String password, String emailAddress1, String emailAddress2, ServiceContext serviceContext) Updates the user's email address or sends verification email.updateEmailAddressVerified
(long userId, boolean emailAddressVerified) Updates whether the user has verified email address.updateExternalReferenceCode
(long userId, String externalReferenceCode) updateExternalReferenceCode
(User user, String externalReferenceCode) updateFacebookId
(long userId, long facebookId) Deprecated.As of Athanasius (7.3.x), with no direct replacementupdateGoogleUserId
(long userId, String googleUserId) Updates the user's Google user ID.void
updateGroups
(long userId, long[] newGroupIds, ServiceContext serviceContext) Sets the groups the user is in, removing and adding groups as necessary.updateIncompleteUser
(long creatorUserId, long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, boolean updateUserInformation, boolean sendEmail, 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.updateJobTitle
(long userId, String jobTitle) Updates the user's job title.updateLanguageId
(long userId, String languageId) updateLastLogin
(long userId, String loginIP) Updates the user's last login with the current time and the IP address.updateLastLogin
(User user, String loginIP) updateLockout
(User user, boolean lockout) Updates whether the user is locked out from logging in.updateLockoutByEmailAddress
(long companyId, String emailAddress, boolean lockout) Updates whether the user is locked out from logging in.updateLockoutById
(long userId, boolean lockout) Updates whether the user is locked out from logging in.updateLockoutByScreenName
(long companyId, String screenName, boolean lockout) Updates whether the user is locked out from logging in.updateModifiedDate
(long userId, Date modifiedDate) Updates the user's modified date.updateOpenId
(long userId, String openId) Deprecated.As of Athanasius (7.3.x), with no direct replacementvoid
updateOrganizations
(long userId, long[] newOrganizationIds, ServiceContext serviceContext) Sets the organizations that the user is in, removing and adding organizations as necessary.updatePassword
(long userId, String password1, String password2, boolean passwordReset) Updates the user's password without tracking or validation of the change.updatePassword
(long userId, String password1, String password2, boolean passwordReset, boolean silentUpdate) Updates the user's password, optionally with tracking and validation of the change.updatePasswordManually
(long userId, String password, boolean passwordEncrypted, boolean passwordReset, Date passwordModifiedDate) Updates the user's password with manually input information.updatePasswordReset
(long userId, boolean passwordReset) Updates whether the user should be asked to reset their password the next time they login.updatePortrait
(long userId, byte[] bytes) Updates the user's portrait image.updateReminderQuery
(long userId, String question, String answer) Updates the user's password reset question and answer.updateScreenName
(long userId, String screenName) Updates the user's screen name.updateStatus
(long userId, int status, ServiceContext serviceContext) Updates the user's workflow status.updateStatus
(User user, int status, ServiceContext serviceContext) updateUser
(long userId, String oldPassword, String newPassword1, String newPassword2, boolean passwordReset, String reminderQueryQuestion, String reminderQueryAnswer, String screenName, String emailAddress, boolean hasPortrait, byte[] portraitBytes, String languageId, String timeZoneId, String greeting, String comments, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String smsSn, String facebookSn, String jabberSn, String skypeSn, String twitterSn, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, List<UserGroupRole> userGroupRoles, long[] userGroupIds, ServiceContext serviceContext) Updates the user.updateUser
(User user) Updates the user in the database or adds it if it does not yet exist.<R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<CTPersistence<User>, R, E> updateUnsafeFunction) void
validateMaxUsers
(long companyId) void
verifyEmailAddress
(String ticketKey) Verifies the email address of the ticket.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel
-
Constructor Details
-
UserLocalServiceWrapper
public UserLocalServiceWrapper() -
UserLocalServiceWrapper
-
-
Method Details
-
addDefaultAdminUser
public User addDefaultAdminUser(long companyId, String password, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName) throws PortalException Adds a default admin user for the company.- Specified by:
addDefaultAdminUser
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companypassword
- the password of the userscreenName
- the user's screen nameemailAddress
- the user's email addresslocale
- the user's localefirstName
- the user's first namemiddleName
- the user's middle namelastName
- the user's last name- Returns:
- the new default admin user
- Throws:
PortalException
-
addDefaultGroups
Adds the user to the default groups, unless the user is already in these groups. The default groups can be specified inportal.properties
with the keyadmin.default.group.names
.- Specified by:
addDefaultGroups
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the user- Returns:
true
if user was added to default groups;false
if user was already a member- Throws:
PortalException
-
addDefaultRoles
Adds the user to the default regular roles, unless the user already has these regular roles. The default regular roles can be specified inportal.properties
with the keyadmin.default.role.names
.- Specified by:
addDefaultRoles
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the user- Returns:
true
if user was given default roles;false
if user already has default roles- Throws:
PortalException
-
addDefaultServiceAccountUser
- Specified by:
addDefaultServiceAccountUser
in interfaceUserLocalService
- Throws:
PortalException
-
addDefaultUserGroups
Adds the user to the default user groups, unless the user is already in these user groups. The default user groups can be specified inportal.properties
with the propertyadmin.default.user.group.names
.- Specified by:
addDefaultUserGroups
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the user- Returns:
true
if user was added to default user groups;false
if user is already a user group member- Throws:
PortalException
-
addGroupUser
public boolean addGroupUser(long groupId, long userId) - Specified by:
addGroupUser
in interfaceUserLocalService
-
addGroupUser
- Specified by:
addGroupUser
in interfaceUserLocalService
-
addGroupUsers
- Specified by:
addGroupUsers
in interfaceUserLocalService
- Throws:
PortalException
PortalException
-
addGroupUsers
- Specified by:
addGroupUsers
in interfaceUserLocalService
- Throws:
PortalException
PortalException
-
addOrganizationUser
public boolean addOrganizationUser(long organizationId, long userId) - Specified by:
addOrganizationUser
in interfaceUserLocalService
-
addOrganizationUser
- Specified by:
addOrganizationUser
in interfaceUserLocalService
-
addOrganizationUsers
- Specified by:
addOrganizationUsers
in interfaceUserLocalService
- Throws:
PortalException
PortalException
-
addOrganizationUsers
- Specified by:
addOrganizationUsers
in interfaceUserLocalService
- Throws:
PortalException
PortalException
-
addOrUpdateUser
public User addOrUpdateUser(String externalReferenceCode, long creatorUserId, long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, boolean sendEmail, ServiceContext serviceContext) throws PortalException - Specified by:
addOrUpdateUser
in interfaceUserLocalService
- Throws:
PortalException
-
addPasswordPolicyUsers
public void addPasswordPolicyUsers(long passwordPolicyId, long[] userIds) Assigns the password policy to the users, removing any other currently assigned password policies.- Specified by:
addPasswordPolicyUsers
in interfaceUserLocalService
- Parameters:
passwordPolicyId
- the primary key of the password policyuserIds
- the primary keys of the users
-
addRoleUser
public boolean addRoleUser(long roleId, long userId) - Specified by:
addRoleUser
in interfaceUserLocalService
-
addRoleUser
- Specified by:
addRoleUser
in interfaceUserLocalService
-
addRoleUsers
- Specified by:
addRoleUsers
in interfaceUserLocalService
- Throws:
PortalException
PortalException
-
addRoleUsers
- Specified by:
addRoleUsers
in interfaceUserLocalService
- Throws:
PortalException
PortalException
-
addTeamUser
public boolean addTeamUser(long teamId, long userId) - Specified by:
addTeamUser
in interfaceUserLocalService
-
addTeamUser
- Specified by:
addTeamUser
in interfaceUserLocalService
-
addTeamUsers
- Specified by:
addTeamUsers
in interfaceUserLocalService
- Throws:
PortalException
PortalException
-
addTeamUsers
- Specified by:
addTeamUsers
in interfaceUserLocalService
- Throws:
PortalException
PortalException
-
addUser
public User addUser(long creatorUserId, long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, int type, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, ServiceContext serviceContext) throws PortalException 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.
- Specified by:
addUser
in interfaceUserLocalService
- Parameters:
creatorUserId
- the primary key of the creatorcompanyId
- the primary key of the user's companyautoPassword
- whether a password should be automatically generated for the userpassword1
- the user's passwordpassword2
- the user's password confirmationautoScreenName
- whether a screen name should be automatically generated for the userscreenName
- the user's screen nameemailAddress
- the user's email addresslocale
- the user's localefirstName
- the user's first namemiddleName
- the user's middle namelastName
- the user's last nameprefixListTypeId
- the user's name prefix IDsuffixListTypeId
- the user's name suffix IDmale
- whether the user is malebirthdayMonth
- the user's birthday month (0-based, meaning 0 for January)birthdayDay
- the user's birthday daybirthdayYear
- the user's birthday yearjobTitle
- the user's job titletype
- the user's typegroupIds
- the primary keys of the user's groupsorganizationIds
- the primary keys of the user's organizationsroleIds
- the primary keys of the roles this user possessesuserGroupIds
- the primary keys of the user's user groupssendEmail
- whether to send the user an email notification about their new accountserviceContext
- the service context to be applied (optionallynull
). Can set the UUID (with theuuid
attribute), asset category IDs, asset tag names, and expando bridge attributes for the user.- Returns:
- the new user
- Throws:
PortalException
-
addUser
Adds the user to the database. Also notifies the appropriate model listeners.Important: Inspect UserLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Specified by:
addUser
in interfaceUserLocalService
- Parameters:
user
- the user- Returns:
- the user that was added
-
addUserGroupUser
public boolean addUserGroupUser(long userGroupId, long userId) - Specified by:
addUserGroupUser
in interfaceUserLocalService
-
addUserGroupUser
- Specified by:
addUserGroupUser
in interfaceUserLocalService
-
addUserGroupUsers
- Specified by:
addUserGroupUsers
in interfaceUserLocalService
- Throws:
PortalException
PortalException
-
addUserGroupUsers
- Specified by:
addUserGroupUsers
in interfaceUserLocalService
- Throws:
PortalException
PortalException
-
addUserWithWorkflow
public User addUserWithWorkflow(long creatorUserId, long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, int type, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, ServiceContext serviceContext) throws PortalException 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.
- Specified by:
addUserWithWorkflow
in interfaceUserLocalService
- Parameters:
creatorUserId
- the primary key of the creatorcompanyId
- the primary key of the user's companyautoPassword
- whether a password should be automatically generated for the userpassword1
- the user's passwordpassword2
- the user's password confirmationautoScreenName
- whether a screen name should be automatically generated for the userscreenName
- the user's screen nameemailAddress
- the user's email addresslocale
- the user's localefirstName
- the user's first namemiddleName
- the user's middle namelastName
- the user's last nameprefixListTypeId
- the user's name prefix IDsuffixListTypeId
- the user's name suffix IDmale
- whether the user is malebirthdayMonth
- the user's birthday month (0-based, meaning 0 for January)birthdayDay
- the user's birthday daybirthdayYear
- the user's birthday yearjobTitle
- the user's job titletype
- the user's typegroupIds
- the primary keys of the user's groupsorganizationIds
- the primary keys of the user's organizationsroleIds
- the primary keys of the roles this user possessesuserGroupIds
- the primary keys of the user's user groupssendEmail
- whether to send the user an email notification about their new accountserviceContext
- the service context to be applied (optionallynull
). Can set the UUID (with theuuid
attribute), asset category IDs, asset tag names, and expando bridge attributes for the user.- Returns:
- the new user
- Throws:
PortalException
-
authenticateByEmailAddress
public int authenticateByEmailAddress(long companyId, String emailAddress, String password, Map<String, String[]> headerMap, Map<String, throws PortalExceptionString[]> parameterMap, Map<String, Object> resultsMap) Attempts to authenticate the user by their email address and password, while using the AuthPipeline.- Specified by:
authenticateByEmailAddress
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyemailAddress
- the user's email addresspassword
- the user's passwordheaderMap
- the header map from the authentication requestparameterMap
- the parameter map from the authentication requestresultsMap
- the map of authentication results (may be nil). After a successful authentication the user's primary key will be placed under the keyuserId
.- Returns:
- the authentication status. This can be
Authenticator#FAILURE
indicating that the user's credentials are invalid,Authenticator#SUCCESS
indicating a successful login, orAuthenticator#DNE
indicating that a user with that login does not exist. - Throws:
PortalException
- See Also:
-
AuthPipeline
-
authenticateByScreenName
public int authenticateByScreenName(long companyId, String screenName, String password, Map<String, String[]> headerMap, Map<String, throws PortalExceptionString[]> parameterMap, Map<String, Object> resultsMap) Attempts to authenticate the user by their screen name and password, while using the AuthPipeline.- Specified by:
authenticateByScreenName
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyscreenName
- the user's screen namepassword
- the user's passwordheaderMap
- the header map from the authentication requestparameterMap
- the parameter map from the authentication requestresultsMap
- the map of authentication results (may be nil). After a successful authentication the user's primary key will be placed under the keyuserId
.- Returns:
- the authentication status. This can be
Authenticator#FAILURE
indicating that the user's credentials are invalid,Authenticator#SUCCESS
indicating a successful login, orAuthenticator#DNE
indicating that a user with that login does not exist. - Throws:
PortalException
- See Also:
-
AuthPipeline
-
authenticateByUserId
public int authenticateByUserId(long companyId, long userId, String password, Map<String, String[]> headerMap, Map<String, throws PortalExceptionString[]> parameterMap, Map<String, Object> resultsMap) Attempts to authenticate the user by their primary key and password, while using the AuthPipeline.- Specified by:
authenticateByUserId
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyuserId
- the user's primary keypassword
- the user's passwordheaderMap
- the header map from the authentication requestparameterMap
- the parameter map from the authentication requestresultsMap
- the map of authentication results (may be nil). After a successful authentication the user's primary key will be placed under the keyuserId
.- Returns:
- the authentication status. This can be
Authenticator#FAILURE
indicating that the user's credentials are invalid,Authenticator#SUCCESS
indicating a successful login, orAuthenticator#DNE
indicating that a user with that login does not exist. - Throws:
PortalException
- See Also:
-
AuthPipeline
-
authenticateForBasic
public long authenticateForBasic(long companyId, String authType, String login, String password) throws PortalException Attempts to authenticate the user using HTTP basic access authentication, without using the AuthPipeline. Primarily used for authenticating users oftunnel-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
- Specified by:
authenticateForBasic
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyauthType
- the type of authentication to performlogin
- either the user's email address, screen name, or primary key depending on the value ofauthType
password
- the user's password- Returns:
- the user's primary key if authentication is successful;
0
otherwise - Throws:
PortalException
-
-
authenticateForDigest
@Deprecated public long authenticateForDigest(long companyId, String userName, String realm, String nonce, String method, String uri, String response) throws PortalException Deprecated.As of Cavanaugh (7.4.x), with no direct replacementAttempts to authenticate the user using HTTP digest access authentication, without using the AuthPipeline. Primarily used for authenticating users oftunnel-web
.- Specified by:
authenticateForDigest
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyrealm
- unusednonce
- the number used oncemethod
- the request methoduri
- the request URIresponse
- the authentication response hash- Returns:
- the user's primary key if authentication is successful;
0
otherwise - Throws:
PortalException
-
checkLockout
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.- Specified by:
checkLockout
in interfaceUserLocalService
- Parameters:
user
- the user- Throws:
PortalException
-
checkLoginFailure
Adds a failed login attempt to the user and updates the user's last failed login date.- Specified by:
checkLoginFailure
in interfaceUserLocalService
- Parameters:
user
- the user
-
checkLoginFailureByEmailAddress
public void checkLoginFailureByEmailAddress(long companyId, String emailAddress) throws PortalException Adds a failed login attempt to the user with the email address and updates the user's last failed login date.- Specified by:
checkLoginFailureByEmailAddress
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyemailAddress
- the user's email address- Throws:
PortalException
-
checkLoginFailureById
Adds a failed login attempt to the user and updates the user's last failed login date.- Specified by:
checkLoginFailureById
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the user- Throws:
PortalException
-
checkLoginFailureByScreenName
Adds a failed login attempt to the user with the screen name and updates the user's last failed login date.- Specified by:
checkLoginFailureByScreenName
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyscreenName
- the user's screen name- Throws:
PortalException
-
checkPasswordExpired
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.- Specified by:
checkPasswordExpired
in interfaceUserLocalService
- Parameters:
user
- the user- Throws:
PortalException
-
clearGroupUsers
public void clearGroupUsers(long groupId) - Specified by:
clearGroupUsers
in interfaceUserLocalService
-
clearOrganizationUsers
public void clearOrganizationUsers(long organizationId) - Specified by:
clearOrganizationUsers
in interfaceUserLocalService
-
clearRoleUsers
public void clearRoleUsers(long roleId) - Specified by:
clearRoleUsers
in interfaceUserLocalService
-
clearTeamUsers
public void clearTeamUsers(long teamId) - Specified by:
clearTeamUsers
in interfaceUserLocalService
-
clearUserGroupUsers
public void clearUserGroupUsers(long userGroupId) - Specified by:
clearUserGroupUsers
in interfaceUserLocalService
-
completeUserRegistration
public void completeUserRegistration(User user, ServiceContext serviceContext) throws PortalException Completes the user's registration by generating a password and sending the confirmation email.- Specified by:
completeUserRegistration
in interfaceUserLocalService
- Parameters:
user
- the userserviceContext
- the service context to be applied. You automatically generate a password for the user by setting attributeautoPassword
totrue
. You can send a confirmation email to the user by setting attributesendEmail
totrue
.- Throws:
PortalException
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Specified by:
createPersistedModel
in interfaceUserLocalService
- Throws:
PortalException
PortalException
-
createUser
Creates a new user with the primary key. Does not add the user to the database.- Specified by:
createUser
in interfaceUserLocalService
- Parameters:
userId
- the primary key for the new user- Returns:
- the new user
-
deleteGroupUser
public void deleteGroupUser(long groupId, long userId) - Specified by:
deleteGroupUser
in interfaceUserLocalService
-
deleteGroupUser
- Specified by:
deleteGroupUser
in interfaceUserLocalService
-
deleteGroupUsers
- Specified by:
deleteGroupUsers
in interfaceUserLocalService
-
deleteGroupUsers
public void deleteGroupUsers(long groupId, long[] userIds) - Specified by:
deleteGroupUsers
in interfaceUserLocalService
-
deleteOrganizationUser
public void deleteOrganizationUser(long organizationId, long userId) - Specified by:
deleteOrganizationUser
in interfaceUserLocalService
-
deleteOrganizationUser
- Specified by:
deleteOrganizationUser
in interfaceUserLocalService
-
deleteOrganizationUsers
- Specified by:
deleteOrganizationUsers
in interfaceUserLocalService
-
deleteOrganizationUsers
public void deleteOrganizationUsers(long organizationId, long[] userIds) - Specified by:
deleteOrganizationUsers
in interfaceUserLocalService
-
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Specified by:
deletePersistedModel
in interfaceUserLocalService
- Throws:
PortalException
PortalException
-
deletePortrait
Deletes the user's portrait image.- Specified by:
deletePortrait
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the user- Throws:
PortalException
-
deleteRoleUser
- Specified by:
deleteRoleUser
in interfaceUserLocalService
- Throws:
PortalException
PortalException
-
deleteRoleUser
- Specified by:
deleteRoleUser
in interfaceUserLocalService
- Throws:
PortalException
PortalException
-
deleteRoleUsers
- Specified by:
deleteRoleUsers
in interfaceUserLocalService
-
deleteRoleUsers
public void deleteRoleUsers(long roleId, long[] userIds) - Specified by:
deleteRoleUsers
in interfaceUserLocalService
-
deleteTeamUser
public void deleteTeamUser(long teamId, long userId) - Specified by:
deleteTeamUser
in interfaceUserLocalService
-
deleteTeamUser
- Specified by:
deleteTeamUser
in interfaceUserLocalService
-
deleteTeamUsers
- Specified by:
deleteTeamUsers
in interfaceUserLocalService
-
deleteTeamUsers
public void deleteTeamUsers(long teamId, long[] userIds) - Specified by:
deleteTeamUsers
in interfaceUserLocalService
-
deleteUser
Deletes the user with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect UserLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Specified by:
deleteUser
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the user- Returns:
- the user that was removed
- Throws:
PortalException
- if a user with the primary key could not be foundPortalException
-
deleteUser
Deletes the user from the database. Also notifies the appropriate model listeners.Important: Inspect UserLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Specified by:
deleteUser
in interfaceUserLocalService
- Parameters:
user
- the user- Returns:
- the user that was removed
- Throws:
PortalException
PortalException
-
deleteUserGroupUser
- Specified by:
deleteUserGroupUser
in interfaceUserLocalService
- Throws:
PortalException
PortalException
-
deleteUserGroupUser
- Specified by:
deleteUserGroupUser
in interfaceUserLocalService
- Throws:
PortalException
PortalException
-
deleteUserGroupUsers
- Specified by:
deleteUserGroupUsers
in interfaceUserLocalService
-
deleteUserGroupUsers
public void deleteUserGroupUsers(long userGroupId, long[] userIds) - Specified by:
deleteUserGroupUsers
in interfaceUserLocalService
-
dslQuery
public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
- Specified by:
dslQuery
in interfaceUserLocalService
-
dslQueryCount
public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
- Specified by:
dslQueryCount
in interfaceUserLocalService
-
dynamicQuery
- Specified by:
dynamicQuery
in interfaceUserLocalService
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Specified by:
dynamicQuery
in interfaceUserLocalService
- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
Performs a dynamic query on the database and returns a range of the matching rows.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.UserModelImpl
.- Specified by:
dynamicQuery
in interfaceUserLocalService
- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.UserModelImpl
.- Specified by:
dynamicQuery
in interfaceUserLocalService
- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Specified by:
dynamicQueryCount
in interfaceUserLocalService
- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Specified by:
dynamicQueryCount
in interfaceUserLocalService
- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
encryptUserId
Encrypts the primary key of the user. Used when encrypting the user's credentials for storage in an automatic login cookie.- Specified by:
encryptUserId
in interfaceUserLocalService
- Parameters:
name
- the primary key of the user- Returns:
- the user's encrypted primary key
- Throws:
PortalException
-
fetchGuestUser
Returns the guest user for the company.- Specified by:
fetchGuestUser
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the company- Returns:
- the guest user for the company, or
null
if a user with the company key could not be found
-
fetchUser
- Specified by:
fetchUser
in interfaceUserLocalService
-
fetchUserByContactId
Returns the user with the contact ID.- Specified by:
fetchUserByContactId
in interfaceUserLocalService
- Parameters:
contactId
- the user's contact ID- Returns:
- the user with the contact ID, or
null
if a user with the contact ID could not be found
-
fetchUserByEmailAddress
Returns the user with the email address.- Specified by:
fetchUserByEmailAddress
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyemailAddress
- 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
-
fetchUserByExternalReferenceCode
- Specified by:
fetchUserByExternalReferenceCode
in interfaceUserLocalService
-
fetchUserByFacebookId
Deprecated.As of Athanasius (7.3.x), with no direct replacementReturns the user with the Facebook ID.- Specified by:
fetchUserByFacebookId
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyfacebookId
- 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
-
fetchUserByGoogleUserId
Returns the user with the Google user ID.- Specified by:
fetchUserByGoogleUserId
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companygoogleUserId
- the user's Google user ID- Returns:
- the user with the Google user ID, or
null
if a user with the Google user ID could not be found
-
fetchUserById
Returns the user with the primary key.- Specified by:
fetchUserById
in interfaceUserLocalService
- 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
-
fetchUserByOpenId
Deprecated.As of Athanasius (7.3.x), with no direct replacementReturns the user with the OpenID.- Specified by:
fetchUserByOpenId
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyopenId
- the user's OpenID- Returns:
- the user with the OpenID, or
null
if a user with the OpenID could not be found
-
fetchUserByPortraitId
Returns the user with the portrait ID.- Specified by:
fetchUserByPortraitId
in interfaceUserLocalService
- Parameters:
portraitId
- the user's portrait ID- Returns:
- the user with the portrait ID, or
null
if a user with the portrait ID could not be found
-
fetchUserByScreenName
Returns the user with the screen name.- Specified by:
fetchUserByScreenName
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyscreenName
- 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
-
fetchUserByUuidAndCompanyId
Returns the user with the matching UUID and company.- Specified by:
fetchUserByUuidAndCompanyId
in interfaceUserLocalService
- Parameters:
uuid
- the user's UUIDcompanyId
- the primary key of the company- Returns:
- the matching user, or
null
if a matching user could not be found
-
getActionableDynamicQuery
- Specified by:
getActionableDynamicQuery
in interfaceUserLocalService
-
getCompanyUsers
Returns a range of all the users belonging to the company.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Specified by:
getCompanyUsers
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the companystart
- the lower bound of the range of usersend
- the upper bound of the range of users (not inclusive)- Returns:
- the range of users belonging to the company
-
getCompanyUsersCount
public int getCompanyUsersCount(long companyId) Returns the number of users belonging to the company.- Specified by:
getCompanyUsersCount
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the company- Returns:
- the number of users belonging to the company
-
getDefaultUser
Deprecated.As of Cavanaugh (7.4.x), replaced bygetGuestUser(long)
- Specified by:
getDefaultUser
in interfaceUserLocalService
- Throws:
PortalException
-
getDefaultUserId
Deprecated.As of Cavanaugh (7.4.x), replaced bygetGuestUserId(long)
- Specified by:
getDefaultUserId
in interfaceUserLocalService
- Throws:
PortalException
-
getExportActionableDynamicQuery
public ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) - Specified by:
getExportActionableDynamicQuery
in interfaceUserLocalService
-
getGroupPrimaryKeys
public long[] getGroupPrimaryKeys(long userId) Returns the groupIds of the groups associated with the user.- Specified by:
getGroupPrimaryKeys
in interfaceUserLocalService
- Parameters:
userId
- the userId of the user- Returns:
- long[] the groupIds of groups associated with the user
-
getGroupUserIds
public long[] getGroupUserIds(long groupId) Returns the primary keys of all the users belonging to the group.- Specified by:
getGroupUserIds
in interfaceUserLocalService
- Parameters:
groupId
- the primary key of the group- Returns:
- the primary keys of the users belonging to the group
-
getGroupUsers
- Specified by:
getGroupUsers
in interfaceUserLocalService
-
getGroupUsers
- Specified by:
getGroupUsers
in interfaceUserLocalService
- Throws:
PortalException
PortalException
-
getGroupUsers
public List<User> getGroupUsers(long groupId, int status, int start, int end, OrderByComparator<User> orderByComparator) throws PortalException Returns the users belonging to a group.- Specified by:
getGroupUsers
in interfaceUserLocalService
- Parameters:
groupId
- the primary key of the groupstatus
- the workflow statusstart
- the lower bound of the range of usersend
- the upper bound of the range of users (not inclusive)orderByComparator
- the comparator to order the users by (optionallynull
)- Returns:
- the matching users
- Throws:
PortalException
-
getGroupUsers
public List<User> getGroupUsers(long groupId, int start, int end, OrderByComparator<User> orderByComparator) - Specified by:
getGroupUsers
in interfaceUserLocalService
-
getGroupUsers
public List<User> getGroupUsers(long groupId, int status, OrderByComparator<User> orderByComparator) throws PortalException Returns the users belonging to a group.- Specified by:
getGroupUsers
in interfaceUserLocalService
- Parameters:
groupId
- the primary key of the groupstatus
- the workflow statusorderByComparator
- the comparator to order the users by (optionallynull
)- Returns:
- the matching users
- Throws:
PortalException
-
getGroupUsersCount
public int getGroupUsersCount(long groupId) - Specified by:
getGroupUsersCount
in interfaceUserLocalService
-
getGroupUsersCount
Returns the number of users with the status belonging to the group.- Specified by:
getGroupUsersCount
in interfaceUserLocalService
- Parameters:
groupId
- the primary key of the groupstatus
- the workflow status- Returns:
- the number of users with the status belonging to the group
- Throws:
PortalException
-
getGuestUser
Returns the guest user for the company.- Specified by:
getGuestUser
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the company- Returns:
- the guest user for the company
- Throws:
PortalException
-
getGuestUserId
Returns the primary key of the guest user for the company.- Specified by:
getGuestUserId
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the company- Returns:
- the primary key of the guest user for the company
- Throws:
PortalException
-
getIndexableActionableDynamicQuery
- Specified by:
getIndexableActionableDynamicQuery
in interfaceUserLocalService
-
getInheritedRoleUsers
public List<User> getInheritedRoleUsers(long roleId, int start, int end, OrderByComparator<User> orderByComparator) throws PortalException - Specified by:
getInheritedRoleUsers
in interfaceUserLocalService
- Throws:
PortalException
-
getNoAnnouncementsDeliveries
Returns all the users who have not had any announcements of the type delivered, excluding the default user.- Specified by:
getNoAnnouncementsDeliveries
in interfaceUserLocalService
- Parameters:
type
- the type of announcement- Returns:
- the users who have not had any annoucements of the type delivered
-
getNoGroups
Returns all the users who do not belong to any groups, excluding the default user.- Specified by:
getNoGroups
in interfaceUserLocalService
- Returns:
- the users who do not belong to any groups
-
getOrganizationPrimaryKeys
public long[] getOrganizationPrimaryKeys(long userId) Returns the organizationIds of the organizations associated with the user.- Specified by:
getOrganizationPrimaryKeys
in interfaceUserLocalService
- Parameters:
userId
- the userId of the user- Returns:
- long[] the organizationIds of organizations associated with the user
-
getOrganizationsAndUserGroupsUsersCount
public int getOrganizationsAndUserGroupsUsersCount(long[] organizationIds, long[] userGroupIds) - Specified by:
getOrganizationsAndUserGroupsUsersCount
in interfaceUserLocalService
-
getOrganizationUserIds
public long[] getOrganizationUserIds(long organizationId) Returns the primary keys of all the users belonging to the organization.- Specified by:
getOrganizationUserIds
in interfaceUserLocalService
- Parameters:
organizationId
- the primary key of the organization- Returns:
- the primary keys of the users belonging to the organization
-
getOrganizationUsers
- Specified by:
getOrganizationUsers
in interfaceUserLocalService
-
getOrganizationUsers
public List<User> getOrganizationUsers(long organizationId, int start, int end) throws PortalException - Specified by:
getOrganizationUsers
in interfaceUserLocalService
- Throws:
PortalException
PortalException
-
getOrganizationUsers
public List<User> getOrganizationUsers(long organizationId, int status, int start, int end, OrderByComparator<User> orderByComparator) throws PortalException Returns the users belonging to the organization with the status.- Specified by:
getOrganizationUsers
in interfaceUserLocalService
- Parameters:
organizationId
- the primary key of the organizationstatus
- the workflow statusstart
- the lower bound of the range of usersend
- the upper bound of the range of users (not inclusive)orderByComparator
- the comparator to order the users by (optionallynull
)- Returns:
- the matching users
- Throws:
PortalException
-
getOrganizationUsers
public List<User> getOrganizationUsers(long organizationId, int start, int end, OrderByComparator<User> orderByComparator) - Specified by:
getOrganizationUsers
in interfaceUserLocalService
-
getOrganizationUsers
public List<User> getOrganizationUsers(long organizationId, int status, OrderByComparator<User> orderByComparator) throws PortalException Returns the users belonging to the organization with the status.- Specified by:
getOrganizationUsers
in interfaceUserLocalService
- Parameters:
organizationId
- the primary key of the organizationstatus
- the workflow statusorderByComparator
- the comparator to order the users by (optionallynull
)- Returns:
- the matching users
- Throws:
PortalException
-
getOrganizationUsersCount
public int getOrganizationUsersCount(long organizationId) - Specified by:
getOrganizationUsersCount
in interfaceUserLocalService
-
getOrganizationUsersCount
Returns the number of users with the status belonging to the organization.- Specified by:
getOrganizationUsersCount
in interfaceUserLocalService
- Parameters:
organizationId
- the primary key of the organizationstatus
- the workflow status- Returns:
- the number of users with the status belonging to the organization
- Throws:
PortalException
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Specified by:
getOSGiServiceIdentifier
in interfaceUserLocalService
- Returns:
- the OSGi service identifier
-
getPersistedModel
- Specified by:
getPersistedModel
in interfacePersistedModelLocalService
- Specified by:
getPersistedModel
in interfaceUserLocalService
- Throws:
PortalException
PortalException
-
getRolePrimaryKeys
public long[] getRolePrimaryKeys(long userId) Returns the roleIds of the roles associated with the user.- Specified by:
getRolePrimaryKeys
in interfaceUserLocalService
- Parameters:
userId
- the userId of the user- Returns:
- long[] the roleIds of roles associated with the user
-
getRoleUserIds
public long[] getRoleUserIds(long roleId) Returns the primary keys of all the users belonging to the role.- Specified by:
getRoleUserIds
in interfaceUserLocalService
- Parameters:
roleId
- the primary key of the role- Returns:
- the primary keys of the users belonging to the role
-
getRoleUserIds
public long[] getRoleUserIds(long roleId, long type) - Specified by:
getRoleUserIds
in interfaceUserLocalService
-
getRoleUsers
- Specified by:
getRoleUsers
in interfaceUserLocalService
-
getRoleUsers
- Specified by:
getRoleUsers
in interfaceUserLocalService
-
getRoleUsers
public List<User> getRoleUsers(long roleId, int start, int end, OrderByComparator<User> orderByComparator) - Specified by:
getRoleUsers
in interfaceUserLocalService
-
getRoleUsersCount
public int getRoleUsersCount(long roleId) - Specified by:
getRoleUsersCount
in interfaceUserLocalService
-
getRoleUsersCount
Returns the number of users with the status belonging to the role.- Specified by:
getRoleUsersCount
in interfaceUserLocalService
- Parameters:
roleId
- the primary key of the rolestatus
- the workflow status- Returns:
- the number of users with the status belonging to the role
- Throws:
PortalException
-
getSocialUsers
public List<User> getSocialUsers(long userId, int socialRelationType, String socialRelationTypeComparator, int start, int end, OrderByComparator<User> orderByComparator) throws PortalException - Specified by:
getSocialUsers
in interfaceUserLocalService
- Throws:
PortalException
-
getSocialUsers
public List<User> getSocialUsers(long userId1, long userId2, int socialRelationType, int start, int end, OrderByComparator<User> orderByComparator) throws PortalException 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Specified by:
getSocialUsers
in interfaceUserLocalService
- Parameters:
userId1
- the primary key of the first useruserId2
- the primary key of the second usersocialRelationType
- the type of social relation. The possible types can be found inSocialRelationConstants
.start
- the lower bound of the range of usersend
- the upper bound of the range of users (not inclusive)orderByComparator
- the comparator to order the users by (optionallynull
)- Returns:
- the ordered range of users with a mutual social relation of the type with the user
- Throws:
PortalException
-
getSocialUsers
public List<User> getSocialUsers(long userId1, long userId2, int start, int end, OrderByComparator<User> orderByComparator) throws PortalException 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Specified by:
getSocialUsers
in interfaceUserLocalService
- Parameters:
userId1
- the primary key of the first useruserId2
- the primary key of the second userstart
- the lower bound of the range of usersend
- the upper bound of the range of users (not inclusive)orderByComparator
- the comparator to order the users by (optionallynull
)- Returns:
- the ordered range of users with a mutual social relation with the user
- Throws:
PortalException
-
getSocialUsersCount
public int getSocialUsersCount(long userId, int socialRelationType, String socialRelationTypeComparator) throws PortalException Returns the number of users with a social relation with the user.- Specified by:
getSocialUsersCount
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the usersocialRelationType
- the type of social relation. The possible types can be found inSocialRelationConstants
.- Returns:
- the number of users with a social relation with the user
- Throws:
PortalException
-
getSocialUsersCount
Returns the number of users with a mutual social relation with both of the given users.- Specified by:
getSocialUsersCount
in interfaceUserLocalService
- Parameters:
userId1
- the primary key of the first useruserId2
- the primary key of the second user- Returns:
- the number of users with a mutual social relation with the user
- Throws:
PortalException
-
getSocialUsersCount
public int getSocialUsersCount(long userId1, long userId2, int socialRelationType) throws PortalException Returns the number of users with a mutual social relation of the type with both of the given users.- Specified by:
getSocialUsersCount
in interfaceUserLocalService
- Parameters:
userId1
- the primary key of the first useruserId2
- the primary key of the second usersocialRelationType
- the type of social relation. The possible types can be found inSocialRelationConstants
.- Returns:
- the number of users with a mutual social relation of the type with the user
- Throws:
PortalException
-
getTeamPrimaryKeys
public long[] getTeamPrimaryKeys(long userId) Returns the teamIds of the teams associated with the user.- Specified by:
getTeamPrimaryKeys
in interfaceUserLocalService
- Parameters:
userId
- the userId of the user- Returns:
- long[] the teamIds of teams associated with the user
-
getTeamUsers
- Specified by:
getTeamUsers
in interfaceUserLocalService
-
getTeamUsers
- Specified by:
getTeamUsers
in interfaceUserLocalService
-
getTeamUsers
public List<User> getTeamUsers(long teamId, int start, int end, OrderByComparator<User> orderByComparator) - Specified by:
getTeamUsers
in interfaceUserLocalService
-
getTeamUsersCount
public int getTeamUsersCount(long teamId) - Specified by:
getTeamUsersCount
in interfaceUserLocalService
-
getUser
Returns the user with the primary key.- Specified by:
getUser
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the user- Returns:
- the user
- Throws:
PortalException
- if a user with the primary key could not be foundPortalException
-
getUserByContactId
Returns the user with the contact ID.- Specified by:
getUserByContactId
in interfaceUserLocalService
- Parameters:
contactId
- the user's contact ID- Returns:
- the user with the contact ID
- Throws:
PortalException
-
getUserByEmailAddress
Returns the user with the email address.- Specified by:
getUserByEmailAddress
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyemailAddress
- the user's email address- Returns:
- the user with the email address
- Throws:
PortalException
-
getUserByExternalReferenceCode
public User getUserByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Specified by:
getUserByExternalReferenceCode
in interfaceUserLocalService
- Throws:
PortalException
-
getUserByFacebookId
Deprecated.As of Athanasius (7.3.x), with no direct replacementReturns the user with the Facebook ID.- Specified by:
getUserByFacebookId
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyfacebookId
- the user's Facebook ID- Returns:
- the user with the Facebook ID
- Throws:
PortalException
-
getUserByGoogleUserId
Returns the user with the Google user ID.- Specified by:
getUserByGoogleUserId
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companygoogleUserId
- the user's Google user ID- Returns:
- the user with the Google user ID
- Throws:
PortalException
-
getUserById
Returns the user with the primary key.- Specified by:
getUserById
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the user- Returns:
- the user with the primary key
- Throws:
PortalException
-
getUserById
Returns the user with the primary key from the company.- Specified by:
getUserById
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyuserId
- the primary key of the user- Returns:
- the user with the primary key
- Throws:
PortalException
-
getUserByOpenId
Deprecated.As of Athanasius (7.3.x), with no direct replacementReturns the user with the OpenID.- Specified by:
getUserByOpenId
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyopenId
- the user's OpenID- Returns:
- the user with the OpenID
- Throws:
PortalException
-
getUserByPortraitId
Returns the user with the portrait ID.- Specified by:
getUserByPortraitId
in interfaceUserLocalService
- Parameters:
portraitId
- the user's portrait ID- Returns:
- the user with the portrait ID
- Throws:
PortalException
-
getUserByScreenName
Returns the user with the screen name.- Specified by:
getUserByScreenName
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyscreenName
- the user's screen name- Returns:
- the user with the screen name
- Throws:
PortalException
-
getUserByUuidAndCompanyId
Returns the user with the matching UUID and company.- Specified by:
getUserByUuidAndCompanyId
in interfaceUserLocalService
- Parameters:
uuid
- the user's UUIDcompanyId
- the primary key of the company- Returns:
- the matching user
- Throws:
PortalException
- if a matching user could not be foundPortalException
-
getUserGroupPrimaryKeys
public long[] getUserGroupPrimaryKeys(long userId) Returns the userGroupIds of the user groups associated with the user.- Specified by:
getUserGroupPrimaryKeys
in interfaceUserLocalService
- Parameters:
userId
- the userId of the user- Returns:
- long[] the userGroupIds of user groups associated with the user
-
getUserGroupUsers
- Specified by:
getUserGroupUsers
in interfaceUserLocalService
-
getUserGroupUsers
- Specified by:
getUserGroupUsers
in interfaceUserLocalService
-
getUserGroupUsers
public List<User> getUserGroupUsers(long userGroupId, int start, int end, OrderByComparator<User> orderByComparator) - Specified by:
getUserGroupUsers
in interfaceUserLocalService
-
getUserGroupUsersCount
public int getUserGroupUsersCount(long userGroupId) - Specified by:
getUserGroupUsersCount
in interfaceUserLocalService
-
getUserGroupUsersCount
Returns the number of users with the status belonging to the user group.- Specified by:
getUserGroupUsersCount
in interfaceUserLocalService
- Parameters:
userGroupId
- the primary key of the user groupstatus
- the workflow status- Returns:
- the number of users with the status belonging to the user group
- Throws:
PortalException
-
getUserIdByEmailAddress
Returns the primary key of the user with the email address.- Specified by:
getUserIdByEmailAddress
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyemailAddress
- the user's email address- Returns:
- the primary key of the user with the email address
- Throws:
PortalException
-
getUserIdByScreenName
Returns the primary key of the user with the screen name.- Specified by:
getUserIdByScreenName
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyscreenName
- the user's screen name- Returns:
- the primary key of the user with the screen name
- Throws:
PortalException
-
getUsers
Returns a range of all the users.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.UserModelImpl
.- Specified by:
getUsers
in interfaceUserLocalService
- Parameters:
start
- the lower bound of the range of usersend
- the upper bound of the range of users (not inclusive)- Returns:
- the range of users
-
getUsers
public List<User> getUsers(long companyId, int status, int start, int end, OrderByComparator<User> orderByComparator) - Specified by:
getUsers
in interfaceUserLocalService
-
getUsersByRoleId
- Specified by:
getUsersByRoleId
in interfaceUserLocalService
- Throws:
PortalException
-
getUsersByRoleName
public List<User> getUsersByRoleName(long companyId, String roleName, int start, int end) throws PortalException - Specified by:
getUsersByRoleName
in interfaceUserLocalService
- Throws:
PortalException
-
getUsersCount
public int getUsersCount()Returns the number of users.- Specified by:
getUsersCount
in interfaceUserLocalService
- Returns:
- the number of users
-
getUsersCount
public int getUsersCount(long companyId, int status) - Specified by:
getUsersCount
in interfaceUserLocalService
-
hasGroupUser
public boolean hasGroupUser(long groupId, long userId) - Specified by:
hasGroupUser
in interfaceUserLocalService
-
hasGroupUsers
public boolean hasGroupUsers(long groupId) - Specified by:
hasGroupUsers
in interfaceUserLocalService
-
hasOrganizationUser
public boolean hasOrganizationUser(long organizationId, long userId) - Specified by:
hasOrganizationUser
in interfaceUserLocalService
-
hasOrganizationUsers
public boolean hasOrganizationUsers(long organizationId) - Specified by:
hasOrganizationUsers
in interfaceUserLocalService
-
hasPasswordPolicyUser
public boolean hasPasswordPolicyUser(long passwordPolicyId, long userId) Returnstrue
if the password policy has been assigned to the user.- Specified by:
hasPasswordPolicyUser
in interfaceUserLocalService
- Parameters:
passwordPolicyId
- the primary key of the password policyuserId
- the primary key of the user- Returns:
true
if the password policy is assigned to the user;false
otherwise
-
hasRoleUser
public boolean hasRoleUser(long roleId, long userId) - Specified by:
hasRoleUser
in interfaceUserLocalService
-
hasRoleUser
public boolean hasRoleUser(long companyId, String name, long userId, boolean inherited) throws PortalException Returnstrue
if the user has the role with the name, optionally through inheritance.- Specified by:
hasRoleUser
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the role's companyname
- the name of the role (must be a regular role, not an organization, site or provider role)userId
- the primary key of the userinherited
- whether to include roles inherited from organizations, sites, etc.- Returns:
true
if the user has the role;false
otherwise- Throws:
PortalException
-
hasRoleUsers
public boolean hasRoleUsers(long roleId) - Specified by:
hasRoleUsers
in interfaceUserLocalService
-
hasTeamUser
public boolean hasTeamUser(long teamId, long userId) - Specified by:
hasTeamUser
in interfaceUserLocalService
-
hasTeamUsers
public boolean hasTeamUsers(long teamId) - Specified by:
hasTeamUsers
in interfaceUserLocalService
-
hasUserGroupUser
public boolean hasUserGroupUser(long userGroupId, long userId) - Specified by:
hasUserGroupUser
in interfaceUserLocalService
-
hasUserGroupUsers
public boolean hasUserGroupUsers(long userGroupId) - Specified by:
hasUserGroupUsers
in interfaceUserLocalService
-
isPasswordExpired
Returnstrue
if the user's password is expired.- Specified by:
isPasswordExpired
in interfaceUserLocalService
- Parameters:
user
- the user- Returns:
true
if the user's password is expired;false
otherwise- Throws:
PortalException
-
loadGetGuestUser
Returns the guest user for the company.- Specified by:
loadGetGuestUser
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the company- Returns:
- the guest user for the company
- Throws:
PortalException
-
search
public List<User> search(long companyId, String keywords, int status, LinkedHashMap<String, Object> params, int start, int end, OrderByComparator<User> orderByComparator) 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 versionsearch(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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Specified by:
search
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companykeywords
- the keywords (space separated), which may occur in the user's first name, middle name, last name, screen name, or email addressstatus
- the workflow statusparams
- the finder parameters (optionallynull
). For more information seeUserFinder
.start
- the lower bound of the range of usersend
- the upper bound of the range of users (not inclusive)orderByComparator
- the comparator to order the users by (optionallynull
)- Returns:
- the matching users
- See Also:
-
search
public Hits search(long companyId, String keywords, int status, LinkedHashMap<String, Object> params, int start, int end, Sort sort) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Specified by:
search
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companykeywords
- the keywords (space separated), which may occur in the user's first name, middle name, last name, screen name, or email addressstatus
- the workflow statusparams
- the indexer parameters (optionallynull
).start
- the lower bound of the range of usersend
- the upper bound of the range of users (not inclusive)sort
- the field and direction to sort by (optionallynull
)- Returns:
- the matching users
-
search
public Hits search(long companyId, String keywords, int status, LinkedHashMap<String, Object> params, int start, int end, Sort[] sorts) - Specified by:
search
in interfaceUserLocalService
-
search
public List<User> search(long companyId, String firstName, String middleName, String lastName, String screenName, String emailAddress, int status, LinkedHashMap<String, Object> params, boolean andSearch, int start, int end, OrderByComparator<User> orderByComparator) 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 versionsearch(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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Specified by:
search
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyfirstName
- the first name keywords (space separated)middleName
- the middle name keywordslastName
- the last name keywordsscreenName
- the screen name keywordsemailAddress
- the email address keywordsstatus
- the workflow statusparams
- the finder parameters (optionallynull
). For more information seeUserFinder
.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 usersend
- the upper bound of the range of users (not inclusive)orderByComparator
- the comparator to order the users by (optionallynull
)- Returns:
- the matching users
- See Also:
-
search
public Hits search(long companyId, String firstName, String middleName, String lastName, String screenName, String emailAddress, int status, LinkedHashMap<String, Object> params, boolean andSearch, int start, int end, 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. 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Specified by:
search
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyfirstName
- the first name keywords (space separated)middleName
- the middle name keywordslastName
- the last name keywordsscreenName
- the screen name keywordsemailAddress
- the email address keywordsstatus
- the workflow statusparams
- the indexer parameters (optionallynull
).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 usersend
- the upper bound of the range of users (not inclusive)sort
- the field and direction to sort by (optionallynull
)- Returns:
- the matching users
-
search
public Hits search(long companyId, String firstName, String middleName, String lastName, String screenName, String emailAddress, int status, LinkedHashMap<String, Object> params, boolean andSearch, int start, int end, Sort[] sorts) - Specified by:
search
in interfaceUserLocalService
-
searchBySocial
public List<User> searchBySocial(long userId, int[] socialRelationTypes, String keywords, int start, int end) throws PortalException - Specified by:
searchBySocial
in interfaceUserLocalService
- Throws:
PortalException
-
searchBySocial
public List<User> searchBySocial(long companyId, long[] groupIds, long[] userGroupIds, String keywords, int start, int end) - Specified by:
searchBySocial
in interfaceUserLocalService
-
searchBySocial
public List<User> searchBySocial(long companyId, long[] groupIds, long[] userGroupIds, String keywords, int start, int end, OrderByComparator<User> orderByComparator) - Specified by:
searchBySocial
in interfaceUserLocalService
-
searchBySocial
public List<User> searchBySocial(long[] groupIds, long userId, int[] socialRelationTypes, String keywords, int start, int end) throws PortalException - Specified by:
searchBySocial
in interfaceUserLocalService
- Throws:
PortalException
-
searchCount
public int searchCount(long companyId, String keywords, int status, LinkedHashMap<String, Object> params) Returns the number of users who match the keywords and status.- Specified by:
searchCount
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companykeywords
- the keywords (space separated), which may occur in the user's first name, middle name, last name, screen name, or email addressstatus
- the workflow statusparams
- the finder parameters (optionallynull
). For more information seeUserFinder
.- Returns:
- the number matching users
-
searchCount
public int searchCount(long companyId, String firstName, String middleName, String lastName, String screenName, String emailAddress, int status, LinkedHashMap<String, 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.- Specified by:
searchCount
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyfirstName
- the first name keywords (space separated)middleName
- the middle name keywordslastName
- the last name keywordsscreenName
- the screen name keywordsemailAddress
- the email address keywordsstatus
- the workflow statusparams
- the finder parameters (optionallynull
). For more information seeUserFinder
.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
-
searchCounts
- Specified by:
searchCounts
in interfaceUserLocalService
-
searchUsers
public BaseModelSearchResult<User> searchUsers(long companyId, String keywords, int status, LinkedHashMap<String, Object> params, int start, int end, Sort sort) throws PortalException- Specified by:
searchUsers
in interfaceUserLocalService
- Throws:
PortalException
-
searchUsers
public BaseModelSearchResult<User> searchUsers(long companyId, String keywords, int status, LinkedHashMap<String, Object> params, int start, int end, Sort[] sorts) throws PortalException- Specified by:
searchUsers
in interfaceUserLocalService
- Throws:
PortalException
-
searchUsers
public BaseModelSearchResult<User> searchUsers(long companyId, String firstName, String middleName, String lastName, String screenName, String emailAddress, int status, LinkedHashMap<String, Object> params, boolean andSearch, int start, int end, Sort sort) throws PortalException- Specified by:
searchUsers
in interfaceUserLocalService
- Throws:
PortalException
-
searchUsers
public BaseModelSearchResult<User> searchUsers(long companyId, String firstName, String middleName, String lastName, String screenName, String emailAddress, int status, LinkedHashMap<String, Object> params, boolean andSearch, int start, int end, Sort[] sorts) throws PortalException- Specified by:
searchUsers
in interfaceUserLocalService
- Throws:
PortalException
-
sendEmailAddressVerification
public void sendEmailAddressVerification(User user, String emailAddress, ServiceContext serviceContext) throws PortalException Sends an email address verification to the user.- Specified by:
sendEmailAddressVerification
in interfaceUserLocalService
- Parameters:
user
- the verification email recipientemailAddress
- the recipient's email addressserviceContext
- 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:
PortalException
-
sendEmailUserCreationAttempt
public boolean sendEmailUserCreationAttempt(long companyId, String emailAddress, String fromName, String fromAddress, String subject, String body, ServiceContext serviceContext) throws PortalException - Specified by:
sendEmailUserCreationAttempt
in interfaceUserLocalService
- Throws:
PortalException
-
sendPassword
public boolean sendPassword(long companyId, String emailAddress, String fromName, String fromAddress, String subject, String body, ServiceContext serviceContext) throws PortalException - Specified by:
sendPassword
in interfaceUserLocalService
- Throws:
PortalException
-
sendPasswordByEmailAddress
public boolean sendPasswordByEmailAddress(long companyId, String emailAddress) throws PortalException Sends a password notification email to the user matching the email address. The portal's settings determine whether a password is sent explicitly or whether a link for resetting the user's password is sent. The method sends the email asynchronously and returns before the email is sent.The content of the notification email is specified with the
admin.email.password
portal property keys. They can be overridden via aportal-ext.properties
file or modified through the Portal Settings UI.- Specified by:
sendPasswordByEmailAddress
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyemailAddress
- the user's email address- Returns:
true
if the notification email includes a new password;false
if the notification email only contains a reset link- Throws:
PortalException
-
sendPasswordByScreenName
Sends a password notification email to the user matching the screen name. The portal's settings determine whether a password is sent explicitly or whether a link for resetting the user's password is sent. The method sends the email asynchronously and returns before the email is sent.The content of the notification email is specified with the
admin.email.password
portal property keys. They can be overridden via aportal-ext.properties
file or modified through the Portal Settings UI.- Specified by:
sendPasswordByScreenName
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyscreenName
- the user's screen name- Returns:
true
if the notification email includes a new password;false
if the notification email only contains a reset link- Throws:
PortalException
-
sendPasswordByUserId
Sends a password notification email to the user matching the ID. The portal's settings determine whether a password is sent explicitly or whether a link for resetting the user's password is sent. The method sends the email asynchronously and returns before the email is sent.The content of the notification email is specified with the
admin.email.password
portal property keys. They can be overridden via aportal-ext.properties
file or modified through the Portal Settings UI.- Specified by:
sendPasswordByUserId
in interfaceUserLocalService
- Parameters:
userId
- the user's primary key- Returns:
true
if the notification email includes a new password;false
if the notification email only contains a reset link- Throws:
PortalException
-
sendPasswordLockout
public boolean sendPasswordLockout(long companyId, String emailAddress, String fromName, String fromAddress, String subject, String body, ServiceContext serviceContext) throws PortalException - Specified by:
sendPasswordLockout
in interfaceUserLocalService
- Throws:
PortalException
-
setGroupUsers
public void setGroupUsers(long groupId, long[] userIds) - Specified by:
setGroupUsers
in interfaceUserLocalService
-
setOrganizationUsers
public void setOrganizationUsers(long organizationId, long[] userIds) - Specified by:
setOrganizationUsers
in interfaceUserLocalService
-
setRoleUsers
- Specified by:
setRoleUsers
in interfaceUserLocalService
- Throws:
PortalException
PortalException
-
setTeamUsers
public void setTeamUsers(long teamId, long[] userIds) - Specified by:
setTeamUsers
in interfaceUserLocalService
-
setUserGroupUsers
- Specified by:
setUserGroupUsers
in interfaceUserLocalService
- Throws:
PortalException
PortalException
-
unsetGroupTeamsUsers
Removes the users from the teams of a group.- Specified by:
unsetGroupTeamsUsers
in interfaceUserLocalService
- Parameters:
groupId
- the primary key of the groupuserIds
- the primary keys of the users- Throws:
PortalException
-
unsetGroupUsers
public void unsetGroupUsers(long groupId, long[] userIds, ServiceContext serviceContext) throws PortalException Removes the users from the group.- Specified by:
unsetGroupUsers
in interfaceUserLocalService
- Parameters:
groupId
- the primary key of the groupuserIds
- the primary keys of the usersserviceContext
- the service context to be applied (optionallynull
)- Throws:
PortalException
-
unsetOrganizationUsers
Removes the users from the organization.- Specified by:
unsetOrganizationUsers
in interfaceUserLocalService
- Parameters:
organizationId
- the primary key of the organizationuserIds
- the primary keys of the users- Throws:
PortalException
-
unsetPasswordPolicyUsers
public void unsetPasswordPolicyUsers(long passwordPolicyId, long[] userIds) Removes the users from the password policy.- Specified by:
unsetPasswordPolicyUsers
in interfaceUserLocalService
- Parameters:
passwordPolicyId
- the primary key of the password policyuserIds
- the primary keys of the users
-
unsetRoleUsers
Removes the users from the role.- Specified by:
unsetRoleUsers
in interfaceUserLocalService
- Parameters:
roleId
- the primary key of the roleusers
- the users- Throws:
PortalException
-
unsetRoleUsers
Removes the users from the role.- Specified by:
unsetRoleUsers
in interfaceUserLocalService
- Parameters:
roleId
- the primary key of the roleuserIds
- the primary keys of the users- Throws:
PortalException
-
unsetTeamUsers
Removes the users from the team.- Specified by:
unsetTeamUsers
in interfaceUserLocalService
- Parameters:
teamId
- the primary key of the teamuserIds
- the primary keys of the users- Throws:
PortalException
-
unsetUserGroupUsers
Removes the users from the user group.- Specified by:
unsetUserGroupUsers
in interfaceUserLocalService
- Parameters:
userGroupId
- the primary key of the user groupuserIds
- the primary keys of the users- Throws:
PortalException
-
updateAgreedToTermsOfUse
public User updateAgreedToTermsOfUse(long userId, boolean agreedToTermsOfUse) throws PortalException Updates whether the user has agreed to the terms of use.- Specified by:
updateAgreedToTermsOfUse
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the useragreedToTermsOfUse
- whether the user has agreet to the terms of use- Returns:
- the user
- Throws:
PortalException
-
updateAsset
public void updateAsset(long userId, User user, long[] assetCategoryIds, String[] assetTagNames) throws PortalException Updates the user's asset with the new asset categories and tag names, removing and adding asset categories and tag names as necessary.- Specified by:
updateAsset
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the useruser
- ID the primary key of the userassetCategoryIds
- the primary key's of the new asset categoriesassetTagNames
- the new asset tag names- Throws:
PortalException
-
updateCreateDate
Updates the user's creation date.- Specified by:
updateCreateDate
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the usercreateDate
- the new creation date- Returns:
- the user
- Throws:
PortalException
-
updateEmailAddress
public User updateEmailAddress(long userId, String password, String emailAddress1, String emailAddress2) throws PortalException Updates the user's email address.- Specified by:
updateEmailAddress
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the userpassword
- the user's passwordemailAddress1
- the user's new email addressemailAddress2
- the user's new email address confirmation- Returns:
- the user
- Throws:
PortalException
-
updateEmailAddress
public User updateEmailAddress(long userId, String password, String emailAddress1, String emailAddress2, ServiceContext serviceContext) throws PortalException Updates the user's email address or sends verification email.- Specified by:
updateEmailAddress
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the userpassword
- the user's passwordemailAddress1
- the user's new email addressemailAddress2
- the user's new email address confirmationserviceContext
- 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:
PortalException
-
updateEmailAddressVerified
public User updateEmailAddressVerified(long userId, boolean emailAddressVerified) throws PortalException Updates whether the user has verified email address.- Specified by:
updateEmailAddressVerified
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the useremailAddressVerified
- whether the user has verified email address- Returns:
- the user
- Throws:
PortalException
-
updateExternalReferenceCode
public User updateExternalReferenceCode(long userId, String externalReferenceCode) throws PortalException - Specified by:
updateExternalReferenceCode
in interfaceUserLocalService
- Throws:
PortalException
-
updateExternalReferenceCode
public User updateExternalReferenceCode(User user, String externalReferenceCode) throws PortalException - Specified by:
updateExternalReferenceCode
in interfaceUserLocalService
- Throws:
PortalException
-
updateFacebookId
Deprecated.As of Athanasius (7.3.x), with no direct replacementUpdates the user's Facebook ID.- Specified by:
updateFacebookId
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the userfacebookId
- the user's new Facebook ID- Returns:
- the user
- Throws:
PortalException
-
updateGoogleUserId
Updates the user's Google user ID.- Specified by:
updateGoogleUserId
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the usergoogleUserId
- the new Google user ID- Returns:
- the user
- Throws:
PortalException
-
updateGroups
public void updateGroups(long userId, long[] newGroupIds, ServiceContext serviceContext) throws PortalException Sets the groups the user is in, removing and adding groups as necessary.- Specified by:
updateGroups
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the usernewGroupIds
- the primary keys of the groupsserviceContext
- the service context to be applied (optionallynull
)- Throws:
PortalException
-
updateIncompleteUser
public User updateIncompleteUser(long creatorUserId, long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, boolean updateUserInformation, boolean sendEmail, ServiceContext serviceContext) throws PortalException 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.- Specified by:
updateIncompleteUser
in interfaceUserLocalService
- Parameters:
creatorUserId
- the primary key of the creatorcompanyId
- the primary key of the user's companyautoPassword
- whether a password should be automatically generated for the userpassword1
- the user's passwordpassword2
- the user's password confirmationautoScreenName
- whether a screen name should be automatically generated for the userscreenName
- the user's screen nameemailAddress
- the user's email addresslocale
- the user's localefirstName
- the user's first namemiddleName
- the user's middle namelastName
- the user's last nameprefixListTypeId
- the user's name prefix IDsuffixListTypeId
- the user's name suffix IDmale
- whether the user is malebirthdayMonth
- the user's birthday month (0-based, meaning 0 for January)birthdayDay
- the user's birthday daybirthdayYear
- the user's birthday yearjobTitle
- the user's job titleupdateUserInformation
- whether to update the user's informationsendEmail
- whether to send the user an email notification about their new accountserviceContext
- the service context to be applied (optionallynull
). Can set expando bridge attributes for the user.- Returns:
- the user
- Throws:
PortalException
-
updateJobTitle
Updates the user's job title.- Specified by:
updateJobTitle
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the userjobTitle
- the user's job title- Returns:
- the user
- Throws:
PortalException
-
updateLanguageId
- Specified by:
updateLanguageId
in interfaceUserLocalService
- Throws:
PortalException
-
updateLastLogin
Updates the user's last login with the current time and the IP address.- Specified by:
updateLastLogin
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the userloginIP
- the IP address the user logged in from- Returns:
- the user
- Throws:
PortalException
-
updateLastLogin
- Specified by:
updateLastLogin
in interfaceUserLocalService
- Throws:
PortalException
-
updateLockout
Updates whether the user is locked out from logging in.- Specified by:
updateLockout
in interfaceUserLocalService
- Parameters:
user
- the userlockout
- whether the user is locked out- Returns:
- the user
- Throws:
PortalException
-
updateLockoutByEmailAddress
public User updateLockoutByEmailAddress(long companyId, String emailAddress, boolean lockout) throws PortalException Updates whether the user is locked out from logging in.- Specified by:
updateLockoutByEmailAddress
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyemailAddress
- the user's email addresslockout
- whether the user is locked out- Returns:
- the user
- Throws:
PortalException
-
updateLockoutById
Updates whether the user is locked out from logging in.- Specified by:
updateLockoutById
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the userlockout
- whether the user is locked out- Returns:
- the user
- Throws:
PortalException
-
updateLockoutByScreenName
public User updateLockoutByScreenName(long companyId, String screenName, boolean lockout) throws PortalException Updates whether the user is locked out from logging in.- Specified by:
updateLockoutByScreenName
in interfaceUserLocalService
- Parameters:
companyId
- the primary key of the user's companyscreenName
- the user's screen namelockout
- whether the user is locked out- Returns:
- the user
- Throws:
PortalException
-
updateModifiedDate
Updates the user's modified date.- Specified by:
updateModifiedDate
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the usermodifiedDate
- the new modified date- Returns:
- the user
- Throws:
PortalException
-
updateOpenId
Deprecated.As of Athanasius (7.3.x), with no direct replacementUpdates the user's OpenID.- Specified by:
updateOpenId
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the useropenId
- the new OpenID- Returns:
- the user
- Throws:
PortalException
-
updateOrganizations
public void updateOrganizations(long userId, long[] newOrganizationIds, ServiceContext serviceContext) throws PortalException Sets the organizations that the user is in, removing and adding organizations as necessary.- Specified by:
updateOrganizations
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the usernewOrganizationIds
- the primary keys of the organizationsserviceContext
- the service context to be applied. Must set whether user indexing is enabled.- Throws:
PortalException
-
updatePassword
public User updatePassword(long userId, String password1, String password2, boolean passwordReset) throws PortalException Updates the user's password without tracking or validation of the change.- Specified by:
updatePassword
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the userpassword1
- the user's new passwordpassword2
- the user's new password confirmationpasswordReset
- whether the user should be asked to reset their password the next time they log in- Returns:
- the user
- Throws:
PortalException
-
updatePassword
public User updatePassword(long userId, String password1, String password2, boolean passwordReset, boolean silentUpdate) throws PortalException Updates the user's password, optionally with tracking and validation of the change.- Specified by:
updatePassword
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the userpassword1
- the user's new passwordpassword2
- the user's new password confirmationpasswordReset
- whether the user should be asked to reset their password the next time they loginsilentUpdate
- whether the password should be updated without being tracked, or validated. Primarily used for password imports.- Returns:
- the user
- Throws:
PortalException
-
updatePasswordManually
public User updatePasswordManually(long userId, String password, boolean passwordEncrypted, boolean passwordReset, Date passwordModifiedDate) throws PortalException Updates the user's password with manually input information. This method should only be used when performing maintenance.- Specified by:
updatePasswordManually
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the userpassword
- the user's new passwordpasswordEncrypted
- the user's new encrypted passwordpasswordReset
- whether the user should be asked to reset their password the next time they loginpasswordModifiedDate
- the new password modified date- Returns:
- the user
- Throws:
PortalException
-
updatePasswordReset
Updates whether the user should be asked to reset their password the next time they login.- Specified by:
updatePasswordReset
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the userpasswordReset
- whether the user should be asked to reset their password the next time they login- Returns:
- the user
- Throws:
PortalException
-
updatePortrait
Updates the user's portrait image.- Specified by:
updatePortrait
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the userbytes
- the new portrait image data- Returns:
- the user
- Throws:
PortalException
-
updateReminderQuery
Updates the user's password reset question and answer.- Specified by:
updateReminderQuery
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the userquestion
- the user's new password reset questionanswer
- the user's new password reset answer- Returns:
- the user
- Throws:
PortalException
-
updateScreenName
Updates the user's screen name.- Specified by:
updateScreenName
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the userscreenName
- the user's new screen name- Returns:
- the user
- Throws:
PortalException
-
updateStatus
public User updateStatus(long userId, int status, ServiceContext serviceContext) throws PortalException Updates the user's workflow status.- Specified by:
updateStatus
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the userstatus
- the user's new workflow statusserviceContext
- the service context to be applied. You can specify an unencrypted custom password (used by an LDAP listener) for the user via attributepasswordUnencrypted
.- Returns:
- the user
- Throws:
PortalException
-
updateStatus
public User updateStatus(User user, int status, ServiceContext serviceContext) throws PortalException - Specified by:
updateStatus
in interfaceUserLocalService
- Throws:
PortalException
-
updateUser
public User updateUser(long userId, String oldPassword, String newPassword1, String newPassword2, boolean passwordReset, String reminderQueryQuestion, String reminderQueryAnswer, String screenName, String emailAddress, boolean hasPortrait, byte[] portraitBytes, String languageId, String timeZoneId, String greeting, String comments, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String smsSn, String facebookSn, String jabberSn, String skypeSn, String twitterSn, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, List<UserGroupRole> userGroupRoles, long[] userGroupIds, ServiceContext serviceContext) throws PortalException Updates the user.- Specified by:
updateUser
in interfaceUserLocalService
- Parameters:
userId
- the primary key of the useroldPassword
- the user's old passwordnewPassword1
- the user's new password (optionallynull
)newPassword2
- the user's new password confirmation (optionallynull
)passwordReset
- whether the user should be asked to reset their password the next time they loginreminderQueryQuestion
- the user's new password reset questionreminderQueryAnswer
- the user's new password reset answerscreenName
- the user's new screen nameemailAddress
- the user's new email addresshasPortrait
- if the user has a custom portrait imageportraitBytes
- the new portrait image datalanguageId
- the user's new language IDtimeZoneId
- the user's new time zone IDgreeting
- the user's new greetingcomments
- the user's new commentsfirstName
- the user's new first namemiddleName
- the user's new middle namelastName
- the user's new last nameprefixListTypeId
- the user's new name prefix IDsuffixListTypeId
- the user's new name suffix IDmale
- whether user is malebirthdayMonth
- the user's new birthday month (0-based, meaning 0 for January)birthdayDay
- the user's new birthday daybirthdayYear
- the user's birthday yearsmsSn
- the user's new SMS screen namefacebookSn
- the user's new Facebook screen namejabberSn
- the user's new Jabber screen nameskypeSn
- the user's new Skype screen nametwitterSn
- the user's new Twitter screen namejobTitle
- the user's new job titlegroupIds
- the primary keys of the user's groupsorganizationIds
- the primary keys of the user's organizationsroleIds
- the primary keys of the user's rolesuserGroupRoles
- the user user's group rolesuserGroupIds
- the primary keys of the user's user groupsserviceContext
- the service context to be applied (optionallynull
). Can set the UUID (with theuuid
attribute), asset category IDs, asset tag names, and expando bridge attributes for the user.- Returns:
- the user
- Throws:
PortalException
-
updateUser
Updates the user in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect UserLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Specified by:
updateUser
in interfaceUserLocalService
- Parameters:
user
- the user- Returns:
- the user that was updated
-
validateMaxUsers
- Specified by:
validateMaxUsers
in interfaceUserLocalService
- Throws:
PortalException
-
verifyEmailAddress
Verifies the email address of the ticket.- Specified by:
verifyEmailAddress
in interfaceUserLocalService
- Parameters:
ticketKey
- the ticket key- Throws:
PortalException
-
getBasePersistence
- Specified by:
getBasePersistence
in interfacePersistedModelLocalService
-
getCTPersistence
- Specified by:
getCTPersistence
in interfaceCTService<User>
- Specified by:
getCTPersistence
in interfaceUserLocalService
-
getModelClass
- Specified by:
getModelClass
in interfaceCTService<User>
- Specified by:
getModelClass
in interfaceUserLocalService
-
updateWithUnsafeFunction
public <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<User>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceCTService<User>
- Specified by:
updateWithUnsafeFunction
in interfaceUserLocalService
- Throws:
E extends Throwable
-
getWrappedService
- Specified by:
getWrappedService
in interfaceServiceWrapper<UserLocalService>
-
setWrappedService
- Specified by:
setWrappedService
in interfaceServiceWrapper<UserLocalService>
-