public class UserLocalServiceWrapper extends Object implements ServiceWrapper<UserLocalService>, UserLocalService
UserLocalService
.UserLocalService
Constructor and Description |
---|
UserLocalServiceWrapper() |
UserLocalServiceWrapper(UserLocalService userLocalService) |
Modifier and Type | Method and Description |
---|---|
User |
addDefaultAdminUser(long companyId,
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.
|
boolean |
addDefaultUserGroups(long userId)
Adds the user to the default user groups, unless the user is already in
these user groups.
|
void |
addGroupUser(long groupId,
long userId) |
void |
addGroupUser(long groupId,
User user) |
void |
addGroupUsers(long groupId,
List<User> users) |
void |
addGroupUsers(long groupId,
long[] userIds) |
void |
addOrganizationUser(long organizationId,
long userId) |
void |
addOrganizationUser(long organizationId,
User user) |
void |
addOrganizationUsers(long organizationId,
List<User> users) |
void |
addOrganizationUsers(long organizationId,
long[] userIds) |
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 prefixId,
long suffixId,
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.
|
void |
addRoleUser(long roleId,
long userId) |
void |
addRoleUser(long roleId,
User user) |
void |
addRoleUsers(long roleId,
List<User> users) |
void |
addRoleUsers(long roleId,
long[] userIds) |
void |
addTeamUser(long teamId,
long userId) |
void |
addTeamUser(long teamId,
User user) |
void |
addTeamUsers(long teamId,
List<User> users) |
void |
addTeamUsers(long teamId,
long[] userIds) |
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 prefixId,
long suffixId,
boolean male,
int birthdayMonth,
int birthdayDay,
int birthdayYear,
String jobTitle,
long[] groupIds,
long[] organizationIds,
long[] roleIds,
long[] userGroupIds,
boolean sendEmail,
ServiceContext serviceContext)
Adds a user.
|
User |
addUser(long creatorUserId,
long companyId,
boolean autoPassword,
String password1,
String password2,
boolean autoScreenName,
String screenName,
String emailAddress,
long facebookId,
String openId,
Locale locale,
String firstName,
String middleName,
String lastName,
long prefixId,
long suffixId,
boolean male,
int birthdayMonth,
int birthdayDay,
int birthdayYear,
String jobTitle,
long[] groupIds,
long[] organizationIds,
long[] roleIds,
long[] userGroupIds,
boolean sendEmail,
ServiceContext serviceContext)
|
User |
addUser(User user)
Adds the user to the database.
|
void |
addUserGroupUser(long userGroupId,
long userId) |
void |
addUserGroupUser(long userGroupId,
User user) |
void |
addUserGroupUsers(long userGroupId,
List<User> users) |
void |
addUserGroupUsers(long userGroupId,
long[] userIds) |
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 prefixId,
long suffixId,
boolean male,
int birthdayMonth,
int birthdayDay,
int birthdayYear,
String jobTitle,
long[] groupIds,
long[] organizationIds,
long[] roleIds,
long[] userGroupIds,
boolean sendEmail,
ServiceContext serviceContext)
Adds a user with workflow.
|
User |
addUserWithWorkflow(long creatorUserId,
long companyId,
boolean autoPassword,
String password1,
String password2,
boolean autoScreenName,
String screenName,
String emailAddress,
long facebookId,
String openId,
Locale locale,
String firstName,
String middleName,
String lastName,
long prefixId,
long suffixId,
boolean male,
int birthdayMonth,
int birthdayDay,
int birthdayYear,
String jobTitle,
long[] groupIds,
long[] organizationIds,
long[] roleIds,
long[] userGroupIds,
boolean sendEmail,
ServiceContext serviceContext)
|
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 replacement
|
boolean |
authenticateForJAAS(long userId,
String encPassword)
Deprecated.
As of Cavanaugh (7.4.x), with no replacement
|
void |
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.
|
PersistedModel |
createPersistedModel(Serializable primaryKeyObj) |
User |
createUser(long userId)
Creates a new user with the primary key.
|
KeyValuePair |
decryptUserId(long companyId,
String name,
String password)
Decrypts the user's primary key and password from their encrypted forms.
|
void |
deleteGroupUser(long groupId,
long userId) |
void |
deleteGroupUser(long groupId,
User user) |
void |
deleteGroupUsers(long groupId,
List<User> users) |
void |
deleteGroupUsers(long groupId,
long[] userIds) |
void |
deleteOrganizationUser(long organizationId,
long userId) |
void |
deleteOrganizationUser(long organizationId,
User user) |
void |
deleteOrganizationUsers(long organizationId,
List<User> users) |
void |
deleteOrganizationUsers(long organizationId,
long[] userIds) |
PersistedModel |
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,
List<User> users) |
void |
deleteRoleUsers(long roleId,
long[] userIds) |
void |
deleteTeamUser(long teamId,
long userId) |
void |
deleteTeamUser(long teamId,
User user) |
void |
deleteTeamUsers(long teamId,
List<User> users) |
void |
deleteTeamUsers(long teamId,
long[] userIds) |
User |
deleteUser(long userId)
Deletes the user with the primary key from the database.
|
User |
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,
List<User> users) |
void |
deleteUserGroupUsers(long userGroupId,
long[] userIds) |
<T> T |
dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
int |
dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
DynamicQuery |
dynamicQuery() |
<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.
|
String |
encryptUserId(String name)
Encrypts the primary key of the user.
|
User |
fetchDefaultUser(long companyId)
Returns the default user for the company.
|
User |
fetchUser(long userId) |
User |
fetchUserByContactId(long contactId)
Returns the user with the contact ID.
|
User |
fetchUserByEmailAddress(long companyId,
String emailAddress)
Returns the user with the email address.
|
User |
fetchUserByExternalReferenceCode(long companyId,
String externalReferenceCode)
Returns the user with the matching external reference code and company.
|
User |
fetchUserByFacebookId(long companyId,
long facebookId)
Deprecated.
As of Athanasius (7.3.x), with no direct replacement
|
User |
fetchUserByGoogleUserId(long companyId,
String googleUserId)
Returns the user with the Google user ID.
|
User |
fetchUserById(long userId)
Returns the user with the primary key.
|
User |
fetchUserByOpenId(long companyId,
String openId)
Deprecated.
As of Athanasius (7.3.x), with no direct replacement
|
User |
fetchUserByPortraitId(long portraitId)
Returns the user with the portrait ID.
|
User |
fetchUserByReferenceCode(long companyId,
String externalReferenceCode)
Deprecated.
As of Cavanaugh (7.4.x), replaced by
fetchUserByExternalReferenceCode(long, String) |
User |
fetchUserByScreenName(long companyId,
String screenName)
Returns the user with the screen name.
|
User |
fetchUserByUuidAndCompanyId(String uuid,
long companyId)
Returns the user with the matching UUID and company.
|
ActionableDynamicQuery |
getActionableDynamicQuery() |
List<User> |
getCompanyUsers(long companyId,
int start,
int end)
Returns a range of all the users belonging to the company.
|
int |
getCompanyUsersCount(long companyId)
Returns the number of users belonging to the company.
|
CTPersistence<User> |
getCTPersistence() |
User |
getDefaultUser(long companyId)
Returns the default user for the company.
|
long |
getDefaultUserId(long companyId)
Returns the primary key of the default user for the company.
|
ExportActionableDynamicQuery |
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.
|
List<User> |
getGroupUsers(long groupId) |
List<User> |
getGroupUsers(long groupId,
int start,
int end) |
List<User> |
getGroupUsers(long groupId,
int status,
int start,
int end,
OrderByComparator<User> orderByComparator)
Returns the users belonging to a group.
|
List<User> |
getGroupUsers(long groupId,
int start,
int end,
OrderByComparator<User> orderByComparator) |
List<User> |
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.
|
IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
List<User> |
getInheritedRoleUsers(long roleId,
int start,
int end,
OrderByComparator<User> orderByComparator) |
Class<User> |
getModelClass() |
List<User> |
getNoAnnouncementsDeliveries(String type)
Returns all the users who have not had any announcements of the type
delivered, excluding the default user.
|
List<User> |
getNoGroups()
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.
|
List<User> |
getOrganizationUsers(long organizationId) |
List<User> |
getOrganizationUsers(long organizationId,
int start,
int end) |
List<User> |
getOrganizationUsers(long organizationId,
int status,
int start,
int end,
OrderByComparator<User> orderByComparator)
Returns the users belonging to the organization with the status.
|
List<User> |
getOrganizationUsers(long organizationId,
int start,
int end,
OrderByComparator<User> orderByComparator) |
List<User> |
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.
|
String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
PersistedModel |
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.
|
List<User> |
getRoleUsers(long roleId) |
List<User> |
getRoleUsers(long roleId,
int start,
int end) |
List<User> |
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.
|
List<User> |
getSocialUsers(long userId,
int socialRelationType,
String socialRelationTypeComparator,
int start,
int end,
OrderByComparator<User> orderByComparator) |
List<User> |
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.
|
List<User> |
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.
|
List<User> |
getTeamUsers(long teamId) |
List<User> |
getTeamUsers(long teamId,
int start,
int end) |
List<User> |
getTeamUsers(long teamId,
int start,
int end,
OrderByComparator<User> orderByComparator) |
int |
getTeamUsersCount(long teamId) |
User |
getUser(long userId)
Returns the user with the primary key.
|
User |
getUserByContactId(long contactId)
Returns the user with the contact ID.
|
User |
getUserByEmailAddress(long companyId,
String emailAddress)
Returns the user with the email address.
|
User |
getUserByExternalReferenceCode(long companyId,
String externalReferenceCode)
Returns the user with the matching external reference code and company.
|
User |
getUserByFacebookId(long companyId,
long facebookId)
Deprecated.
As of Athanasius (7.3.x), with no direct replacement
|
User |
getUserByGoogleUserId(long companyId,
String googleUserId)
Returns the user with the Google user ID.
|
User |
getUserById(long userId)
Returns the user with the primary key.
|
User |
getUserById(long companyId,
long userId)
Returns the user with the primary key from the company.
|
User |
getUserByOpenId(long companyId,
String openId)
Deprecated.
As of Athanasius (7.3.x), with no direct replacement
|
User |
getUserByPortraitId(long portraitId)
Returns the user with the portrait ID.
|
User |
getUserByScreenName(long companyId,
String screenName)
Returns the user with the screen name.
|
User |
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.
|
List<User> |
getUserGroupUsers(long userGroupId) |
List<User> |
getUserGroupUsers(long userGroupId,
int start,
int end) |
List<User> |
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.
|
List<User> |
getUsers(int start,
int end)
Returns a range of all the users.
|
List<User> |
getUsers(long companyId,
boolean defaultUser,
int status,
int start,
int end,
OrderByComparator<User> orderByComparator) |
int |
getUsersCount()
Returns the number of users.
|
int |
getUsersCount(long companyId,
boolean defaultUser,
int status) |
UserLocalService |
getWrappedService() |
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)
Returns
true 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)
Returns
true 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)
Returns
true if the user's password is expired. |
User |
loadGetDefaultUser(long companyId)
Returns the default user for the company.
|
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.
|
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.
|
Hits |
search(long companyId,
String keywords,
int status,
LinkedHashMap<String,Object> params,
int start,
int end,
Sort[] sorts) |
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.
|
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.
|
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) |
List<User> |
searchBySocial(long[] groupIds,
long userId,
int[] socialRelationTypes,
String keywords,
int start,
int end) |
List<User> |
searchBySocial(long userId,
int[] socialRelationTypes,
String keywords,
int start,
int end) |
List<User> |
searchBySocial(long companyId,
long[] groupIds,
String keywords,
int start,
int end) |
List<User> |
searchBySocial(long companyId,
long[] groupIds,
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.
|
Map<Long,Integer> |
searchCounts(long companyId,
int status,
long[] groupIds) |
List<User> |
searchSocial(long[] groupIds,
long userId,
int[] socialRelationTypes,
String keywords,
int start,
int end)
Deprecated.
As of Cavanaugh (7.4.x), replaced by
searchBySocial(long[], long, int[], String, int, int) |
List<User> |
searchSocial(long userId,
int[] socialRelationTypes,
String keywords,
int start,
int end)
Deprecated.
As of Cavanaugh (7.4.x), replaced by
searchBySocial(long, int[], String, int, int) |
List<User> |
searchSocial(long companyId,
long[] groupIds,
String keywords,
int start,
int end)
Deprecated.
As of Cavanaugh (7.4.x), replaced by
searchBySocial(long, long[], String, int, int) |
List<User> |
searchSocial(long companyId,
long[] groupIds,
String keywords,
int start,
int end,
OrderByComparator<User> orderByComparator)
Deprecated.
As of Cavanaugh (7.4.x), replaced by
searchBySocial(long, long[], String, int, int,
OrderByComparator) |
BaseModelSearchResult<User> |
searchUsers(long companyId,
String keywords,
int status,
LinkedHashMap<String,Object> params,
int start,
int end,
Sort sort) |
BaseModelSearchResult<User> |
searchUsers(long companyId,
String keywords,
int status,
LinkedHashMap<String,Object> params,
int start,
int end,
Sort[] sorts) |
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) |
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) |
void |
sendEmailAddressVerification(User user,
String emailAddress,
ServiceContext serviceContext)
Sends an email address verification to the user.
|
boolean |
sendPassword(long companyId,
String emailAddress,
String fromName,
String fromAddress,
String subject,
String body,
ServiceContext serviceContext)
Sends the password email to the user with the email address.
|
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.
|
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,
List<User> users)
Removes the users from the role.
|
void |
unsetRoleUsers(long roleId,
long[] userIds)
Removes the users from the role.
|
void |
unsetTeamUsers(long teamId,
long[] userIds)
Removes the users from the team.
|
void |
unsetUserGroupUsers(long userGroupId,
long[] userIds)
Removes the users from the user group.
|
User |
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.
|
User |
updateCreateDate(long userId,
Date createDate)
Updates the user's creation date.
|
User |
updateEmailAddress(long userId,
String password,
String emailAddress1,
String emailAddress2)
Updates the user's email address.
|
User |
updateEmailAddress(long userId,
String password,
String emailAddress1,
String emailAddress2,
ServiceContext serviceContext)
Updates the user's email address or sends verification email.
|
User |
updateEmailAddressVerified(long userId,
boolean emailAddressVerified)
Updates whether the user has verified email address.
|
User |
updateFacebookId(long userId,
long facebookId)
Deprecated.
As of Athanasius (7.3.x), with no direct replacement
|
User |
updateGoogleUserId(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.
|
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 prefixId,
long suffixId,
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.
|
User |
updateIncompleteUser(long creatorUserId,
long companyId,
boolean autoPassword,
String password1,
String password2,
boolean autoScreenName,
String screenName,
String emailAddress,
long facebookId,
String openId,
Locale locale,
String firstName,
String middleName,
String lastName,
long prefixId,
long suffixId,
boolean male,
int birthdayMonth,
int birthdayDay,
int birthdayYear,
String jobTitle,
boolean updateUserInformation,
boolean sendEmail,
ServiceContext serviceContext)
Deprecated.
|
User |
updateJobTitle(long userId,
String jobTitle)
Updates the user's job title.
|
User |
updateLastLogin(long userId,
String loginIP)
Updates the user's last login with the current time and the IP address.
|
User |
updateLockout(User user,
boolean lockout)
Updates whether the user is locked out from logging in.
|
User |
updateLockoutByEmailAddress(long companyId,
String emailAddress,
boolean lockout)
Updates whether the user is locked out from logging in.
|
User |
updateLockoutById(long userId,
boolean lockout)
Updates whether the user is locked out from logging in.
|
User |
updateLockoutByScreenName(long companyId,
String screenName,
boolean lockout)
Updates whether the user is locked out from logging in.
|
User |
updateModifiedDate(long userId,
Date modifiedDate)
Updates the user's modified date.
|
User |
updateOpenId(long userId,
String openId)
Deprecated.
As of Athanasius (7.3.x), with no direct replacement
|
void |
updateOrganizations(long userId,
long[] newOrganizationIds,
ServiceContext serviceContext)
Sets the organizations that the user is in, removing and adding
organizations as necessary.
|
User |
updatePassword(long userId,
String password1,
String password2,
boolean passwordReset)
Updates the user's password without tracking or validation of the change.
|
User |
updatePassword(long userId,
String password1,
String password2,
boolean passwordReset,
boolean silentUpdate)
Updates the user's password, optionally with tracking and validation of
the change.
|
User |
updatePasswordManually(long userId,
String password,
boolean passwordEncrypted,
boolean passwordReset,
Date passwordModifiedDate)
Updates the user's password with manually input information.
|
User |
updatePasswordReset(long userId,
boolean passwordReset)
Updates whether the user should be asked to reset their password the next
time they login.
|
User |
updatePortrait(long userId,
byte[] bytes)
Updates the user's portrait image.
|
User |
updateReminderQuery(long userId,
String question,
String answer)
Updates the user's password reset question and answer.
|
User |
updateScreenName(long userId,
String screenName)
Updates the user's screen name.
|
User |
updateStatus(long userId,
int status,
ServiceContext serviceContext)
Updates the user's workflow status.
|
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 prefixId,
long suffixId,
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.
|
User |
updateUser(long userId,
String oldPassword,
String newPassword1,
String newPassword2,
boolean passwordReset,
String reminderQueryQuestion,
String reminderQueryAnswer,
String screenName,
String emailAddress,
long facebookId,
String openId,
boolean hasPortrait,
byte[] portraitBytes,
String languageId,
String timeZoneId,
String greeting,
String comments,
String firstName,
String middleName,
String lastName,
long prefixId,
long suffixId,
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)
Deprecated.
As of Athanasius (7.3.x), replaced by
updateUser(long, String, String, String, boolean, String,
String, String, String, boolean, byte[], String, String,
String, String, String, String, String, long, long, boolean,
int, int, int, String, String, String, String, String,
String, long[], long[], long[], List, long[], ServiceContext) |
User |
updateUser(User user)
Updates the user in the database or adds it if it does not yet exist.
|
<R,E extends Throwable> |
updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<User>,R,E> updateUnsafeFunction) |
void |
verifyEmailAddress(String ticketKey)
Verifies the email address of the ticket.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getBasePersistence
public UserLocalServiceWrapper()
public UserLocalServiceWrapper(UserLocalService userLocalService)
public User addDefaultAdminUser(long companyId, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName) throws PortalException
addDefaultAdminUser
in interface UserLocalService
companyId
- the primary key of the user's companyscreenName
- 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 namePortalException
public boolean addDefaultGroups(long userId) throws PortalException
portal.properties
with the key
admin.default.group.names
.addDefaultGroups
in interface UserLocalService
userId
- the primary key of the usertrue
if user was added to default groups;
false
if user was already a memberPortalException
public boolean addDefaultRoles(long userId) throws PortalException
portal.properties
with the key
admin.default.role.names
.addDefaultRoles
in interface UserLocalService
userId
- the primary key of the usertrue
if user was given default roles;
false
if user already has default rolesPortalException
public boolean addDefaultUserGroups(long userId) throws PortalException
portal.properties
with the property
admin.default.user.group.names
.addDefaultUserGroups
in interface UserLocalService
userId
- the primary key of the usertrue
if user was added to default user groups;
false
if user is already a user group memberPortalException
public void addGroupUser(long groupId, long userId)
addGroupUser
in interface UserLocalService
public void addGroupUser(long groupId, User user)
addGroupUser
in interface UserLocalService
public void addGroupUsers(long groupId, List<User> users) throws PortalException
addGroupUsers
in interface UserLocalService
PortalException
public void addGroupUsers(long groupId, long[] userIds) throws PortalException
addGroupUsers
in interface UserLocalService
PortalException
public void addOrganizationUser(long organizationId, long userId)
addOrganizationUser
in interface UserLocalService
public void addOrganizationUser(long organizationId, User user)
addOrganizationUser
in interface UserLocalService
public void addOrganizationUsers(long organizationId, List<User> users) throws PortalException
addOrganizationUsers
in interface UserLocalService
PortalException
public void addOrganizationUsers(long organizationId, long[] userIds) throws PortalException
addOrganizationUsers
in interface UserLocalService
PortalException
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 prefixId, long suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, boolean sendEmail, ServiceContext serviceContext) throws PortalException
addOrUpdateUser
in interface UserLocalService
PortalException
public void addPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
addPasswordPolicyUsers
in interface UserLocalService
passwordPolicyId
- the primary key of the password policyuserIds
- the primary keys of the userspublic void addRoleUser(long roleId, long userId)
addRoleUser
in interface UserLocalService
public void addRoleUser(long roleId, User user)
addRoleUser
in interface UserLocalService
public void addRoleUsers(long roleId, List<User> users) throws PortalException
addRoleUsers
in interface UserLocalService
PortalException
public void addRoleUsers(long roleId, long[] userIds) throws PortalException
addRoleUsers
in interface UserLocalService
PortalException
public void addTeamUser(long teamId, long userId)
addTeamUser
in interface UserLocalService
public void addTeamUser(long teamId, User user)
addTeamUser
in interface UserLocalService
public void addTeamUsers(long teamId, List<User> users) throws PortalException
addTeamUsers
in interface UserLocalService
PortalException
public void addTeamUsers(long teamId, long[] userIds) throws PortalException
addTeamUsers
in interface UserLocalService
PortalException
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 prefixId, long suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, ServiceContext serviceContext) throws PortalException
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.
addUser
in interface UserLocalService
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 nameprefixId
- the user's name prefix IDsuffixId
- 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 titlegroupIds
- 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 (optionally
null
). Can set the UUID (with the uuid
attribute), asset category IDs, asset tag names, and expando
bridge attributes for the user.PortalException
@Deprecated public User addUser(long creatorUserId, long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, long facebookId, String openId, Locale locale, String firstName, String middleName, String lastName, long prefixId, long suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, ServiceContext serviceContext) throws PortalException
addUser(long,
long, boolean, String, String, boolean, String, String,
Locale, String, String, String, long, long, boolean, int,
int, int, String, long[], long[], long[], long[], boolean,
ServiceContext)
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.
addUser
in interface UserLocalService
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 addressfacebookId
- the user's facebook IDopenId
- the user's OpenIDlocale
- the user's localefirstName
- the user's first namemiddleName
- the user's middle namelastName
- the user's last nameprefixId
- the user's name prefix IDsuffixId
- 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 titlegroupIds
- 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 (optionally
null
). Can set the UUID (with the
uuid
attribute), asset category IDs, asset tag
names, and expando bridge attributes for the user.PortalException
public User addUser(User user)
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.
addUser
in interface UserLocalService
user
- the userpublic void addUserGroupUser(long userGroupId, long userId)
addUserGroupUser
in interface UserLocalService
public void addUserGroupUser(long userGroupId, User user)
addUserGroupUser
in interface UserLocalService
public void addUserGroupUsers(long userGroupId, List<User> users) throws PortalException
addUserGroupUsers
in interface UserLocalService
PortalException
public void addUserGroupUsers(long userGroupId, long[] userIds) throws PortalException
addUserGroupUsers
in interface UserLocalService
PortalException
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 prefixId, long suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, ServiceContext serviceContext) throws PortalException
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.
addUserWithWorkflow
in interface UserLocalService
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 nameprefixId
- the user's name prefix IDsuffixId
- 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 titlegroupIds
- 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 (optionally
null
). Can set the UUID (with the uuid
attribute), asset category IDs, asset tag names, and expando
bridge attributes for the user.PortalException
@Deprecated public User addUserWithWorkflow(long creatorUserId, long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, long facebookId, String openId, Locale locale, String firstName, String middleName, String lastName, long prefixId, long suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, ServiceContext serviceContext) throws PortalException
addUserWithWorkflow(long, long, boolean, String, String,
boolean, String, String, Locale, String, String, String,
long, long, boolean, int, int, int, String, long[], long[],
long[], long[], boolean, ServiceContext)
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.
addUserWithWorkflow
in interface UserLocalService
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 addressfacebookId
- the user's facebook IDopenId
- the user's OpenIDlocale
- the user's localefirstName
- the user's first namemiddleName
- the user's middle namelastName
- the user's last nameprefixId
- the user's name prefix IDsuffixId
- 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 titlegroupIds
- 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 (optionally
null
). Can set the UUID (with the
uuid
attribute), asset category IDs, asset tag
names, and expando bridge attributes for the user.PortalException
public int authenticateByEmailAddress(long companyId, String emailAddress, String password, Map<String,String[]> headerMap, Map<String,String[]> parameterMap, Map<String,Object> resultsMap) throws PortalException
authenticateByEmailAddress
in interface UserLocalService
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 key userId
.Authenticator#FAILURE
indicating that the user's credentials are
invalid, Authenticator#SUCCESS
indicating a successful
login, or Authenticator#DNE
indicating that a user with
that login does not exist.PortalException
AuthPipeline
public int authenticateByScreenName(long companyId, String screenName, String password, Map<String,String[]> headerMap, Map<String,String[]> parameterMap, Map<String,Object> resultsMap) throws PortalException
authenticateByScreenName
in interface UserLocalService
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 key userId
.Authenticator#FAILURE
indicating that the user's credentials are
invalid, Authenticator#SUCCESS
indicating a successful
login, or Authenticator#DNE
indicating that a user with
that login does not exist.PortalException
AuthPipeline
public int authenticateByUserId(long companyId, long userId, String password, Map<String,String[]> headerMap, Map<String,String[]> parameterMap, Map<String,Object> resultsMap) throws PortalException
authenticateByUserId
in interface UserLocalService
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 key userId
.Authenticator#FAILURE
indicating that the user's credentials are
invalid, Authenticator#SUCCESS
indicating a successful
login, or Authenticator#DNE
indicating that a user with
that login does not exist.PortalException
AuthPipeline
public long authenticateForBasic(long companyId, String authType, String login, String password) throws PortalException
tunnel-web
.
Authentication type specifies what login
contains.The valid
values are:
CompanyConstants.AUTH_TYPE_EA
- login
is the
user's email address
CompanyConstants.AUTH_TYPE_SN
- login
is the
user's screen name
CompanyConstants.AUTH_TYPE_ID
- login
is the
user's primary key
authenticateForBasic
in interface UserLocalService
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 of authType
password
- the user's password0
otherwisePortalException
@Deprecated public long authenticateForDigest(long companyId, String userName, String realm, String nonce, String method, String uri, String response) throws PortalException
tunnel-web
.authenticateForDigest
in interface UserLocalService
companyId
- the primary key of the user's companyrealm
- unusednonce
- the number used oncemethod
- the request methoduri
- the request URIresponse
- the authentication response hash0
otherwisePortalException
@Deprecated public boolean authenticateForJAAS(long userId, String encPassword)
authenticateForJAAS
in interface UserLocalService
userId
- the primary key of the userencPassword
- the encrypted passwordtrue
if authentication is successful;
false
otherwisepublic void checkLockout(User user) throws PortalException
checkLockout
in interface UserLocalService
user
- the userPortalException
public void checkLoginFailure(User user)
checkLoginFailure
in interface UserLocalService
user
- the userpublic void checkLoginFailureByEmailAddress(long companyId, String emailAddress) throws PortalException
checkLoginFailureByEmailAddress
in interface UserLocalService
companyId
- the primary key of the user's companyemailAddress
- the user's email addressPortalException
public void checkLoginFailureById(long userId) throws PortalException
checkLoginFailureById
in interface UserLocalService
userId
- the primary key of the userPortalException
public void checkLoginFailureByScreenName(long companyId, String screenName) throws PortalException
checkLoginFailureByScreenName
in interface UserLocalService
companyId
- the primary key of the user's companyscreenName
- the user's screen namePortalException
public void checkPasswordExpired(User user) throws PortalException
checkPasswordExpired
in interface UserLocalService
user
- the userPortalException
public void clearGroupUsers(long groupId)
clearGroupUsers
in interface UserLocalService
public void clearOrganizationUsers(long organizationId)
clearOrganizationUsers
in interface UserLocalService
public void clearRoleUsers(long roleId)
clearRoleUsers
in interface UserLocalService
public void clearTeamUsers(long teamId)
clearTeamUsers
in interface UserLocalService
public void clearUserGroupUsers(long userGroupId)
clearUserGroupUsers
in interface UserLocalService
public void completeUserRegistration(User user, ServiceContext serviceContext) throws PortalException
completeUserRegistration
in interface UserLocalService
user
- the userserviceContext
- the service context to be applied. You can specify
an unencrypted custom password for the user via attribute
passwordUnencrypted
. You automatically generate a
password for the user by setting attribute
autoPassword
to true
. You can send a
confirmation email to the user by setting attribute
sendEmail
to true
.PortalException
public PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
createPersistedModel
in interface PersistedModelLocalService
createPersistedModel
in interface UserLocalService
PortalException
public User createUser(long userId)
createUser
in interface UserLocalService
userId
- the primary key for the new userpublic KeyValuePair decryptUserId(long companyId, String name, String password) throws PortalException
decryptUserId
in interface UserLocalService
companyId
- the primary key of the user's companyname
- the encrypted primary key of the userpassword
- the encrypted password of the userPortalException
public void deleteGroupUser(long groupId, long userId)
deleteGroupUser
in interface UserLocalService
public void deleteGroupUser(long groupId, User user)
deleteGroupUser
in interface UserLocalService
public void deleteGroupUsers(long groupId, List<User> users)
deleteGroupUsers
in interface UserLocalService
public void deleteGroupUsers(long groupId, long[] userIds)
deleteGroupUsers
in interface UserLocalService
public void deleteOrganizationUser(long organizationId, long userId)
deleteOrganizationUser
in interface UserLocalService
public void deleteOrganizationUser(long organizationId, User user)
deleteOrganizationUser
in interface UserLocalService
public void deleteOrganizationUsers(long organizationId, List<User> users)
deleteOrganizationUsers
in interface UserLocalService
public void deleteOrganizationUsers(long organizationId, long[] userIds)
deleteOrganizationUsers
in interface UserLocalService
public PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
deletePersistedModel
in interface PersistedModelLocalService
deletePersistedModel
in interface UserLocalService
PortalException
public void deletePortrait(long userId) throws PortalException
deletePortrait
in interface UserLocalService
userId
- the primary key of the userPortalException
public void deleteRoleUser(long roleId, long userId) throws PortalException
deleteRoleUser
in interface UserLocalService
PortalException
public void deleteRoleUser(long roleId, User user) throws PortalException
deleteRoleUser
in interface UserLocalService
PortalException
public void deleteRoleUsers(long roleId, List<User> users)
deleteRoleUsers
in interface UserLocalService
public void deleteRoleUsers(long roleId, long[] userIds)
deleteRoleUsers
in interface UserLocalService
public void deleteTeamUser(long teamId, long userId)
deleteTeamUser
in interface UserLocalService
public void deleteTeamUser(long teamId, User user)
deleteTeamUser
in interface UserLocalService
public void deleteTeamUsers(long teamId, List<User> users)
deleteTeamUsers
in interface UserLocalService
public void deleteTeamUsers(long teamId, long[] userIds)
deleteTeamUsers
in interface UserLocalService
public User deleteUser(long userId) throws PortalException
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.
deleteUser
in interface UserLocalService
userId
- the primary key of the userPortalException
- if a user with the primary key could not be foundpublic User deleteUser(User user) throws PortalException
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.
deleteUser
in interface UserLocalService
user
- the userPortalException
public void deleteUserGroupUser(long userGroupId, long userId) throws PortalException
deleteUserGroupUser
in interface UserLocalService
PortalException
public void deleteUserGroupUser(long userGroupId, User user) throws PortalException
deleteUserGroupUser
in interface UserLocalService
PortalException
public void deleteUserGroupUsers(long userGroupId, List<User> users)
deleteUserGroupUsers
in interface UserLocalService
public void deleteUserGroupUsers(long userGroupId, long[] userIds)
deleteUserGroupUsers
in interface UserLocalService
public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
dslQuery
in interface PersistedModelLocalService
dslQuery
in interface UserLocalService
public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
dslQueryCount
in interface PersistedModelLocalService
dslQueryCount
in interface UserLocalService
public DynamicQuery dynamicQuery()
dynamicQuery
in interface UserLocalService
public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery
in interface UserLocalService
dynamicQuery
- the dynamic querypublic <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. If orderByComparator
is specified, then the query will include the given ORDER BY logic. If orderByComparator
is absent, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.UserModelImpl
.
dynamicQuery
in interface UserLocalService
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. If orderByComparator
is specified, then the query will include the given ORDER BY logic. If orderByComparator
is absent, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.UserModelImpl
.
dynamicQuery
in interface UserLocalService
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 (optionally null
)public long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQueryCount
in interface UserLocalService
dynamicQuery
- the dynamic querypublic long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
dynamicQueryCount
in interface UserLocalService
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic String encryptUserId(String name) throws PortalException
encryptUserId
in interface UserLocalService
name
- the primary key of the userPortalException
public User fetchDefaultUser(long companyId)
fetchDefaultUser
in interface UserLocalService
companyId
- the primary key of the companynull
if a user
with the company key could not be foundpublic User fetchUser(long userId)
fetchUser
in interface UserLocalService
public User fetchUserByContactId(long contactId)
fetchUserByContactId
in interface UserLocalService
contactId
- the user's contact IDnull
if a user with
the contact ID could not be foundpublic User fetchUserByEmailAddress(long companyId, String emailAddress)
fetchUserByEmailAddress
in interface UserLocalService
companyId
- the primary key of the user's companyemailAddress
- the user's email addressnull
if a user
with the email address could not be foundpublic User fetchUserByExternalReferenceCode(long companyId, String externalReferenceCode)
fetchUserByExternalReferenceCode
in interface UserLocalService
companyId
- the primary key of the companyexternalReferenceCode
- the user's external reference codenull
if a matching user could not be found@Deprecated public User fetchUserByFacebookId(long companyId, long facebookId)
fetchUserByFacebookId
in interface UserLocalService
companyId
- the primary key of the user's companyfacebookId
- the user's Facebook IDnull
if a user
with the Facebook ID could not be foundpublic User fetchUserByGoogleUserId(long companyId, String googleUserId)
fetchUserByGoogleUserId
in interface UserLocalService
companyId
- the primary key of the user's companygoogleUserId
- the user's Google user IDnull
if a user
with the Google user ID could not be foundpublic User fetchUserById(long userId)
fetchUserById
in interface UserLocalService
userId
- the primary key of the usernull
if a user
with the primary key could not be found@Deprecated public User fetchUserByOpenId(long companyId, String openId)
fetchUserByOpenId
in interface UserLocalService
companyId
- the primary key of the user's companyopenId
- the user's OpenIDnull
if a user with
the OpenID could not be foundpublic User fetchUserByPortraitId(long portraitId)
fetchUserByPortraitId
in interface UserLocalService
portraitId
- the user's portrait IDnull
if a user
with the portrait ID could not be found@Deprecated public User fetchUserByReferenceCode(long companyId, String externalReferenceCode)
fetchUserByExternalReferenceCode(long, String)
fetchUserByReferenceCode
in interface UserLocalService
public User fetchUserByScreenName(long companyId, String screenName)
fetchUserByScreenName
in interface UserLocalService
companyId
- the primary key of the user's companyscreenName
- the user's screen namenull
if a user
with the screen name could not be foundpublic User fetchUserByUuidAndCompanyId(String uuid, long companyId)
fetchUserByUuidAndCompanyId
in interface UserLocalService
uuid
- the user's UUIDcompanyId
- the primary key of the companynull
if a matching user could not be foundpublic ActionableDynamicQuery getActionableDynamicQuery()
getActionableDynamicQuery
in interface UserLocalService
public List<User> getCompanyUsers(long companyId, int start, int end)
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
getCompanyUsers
in interface UserLocalService
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)public int getCompanyUsersCount(long companyId)
getCompanyUsersCount
in interface UserLocalService
companyId
- the primary key of the companypublic User getDefaultUser(long companyId) throws PortalException
getDefaultUser
in interface UserLocalService
companyId
- the primary key of the companyPortalException
public long getDefaultUserId(long companyId) throws PortalException
getDefaultUserId
in interface UserLocalService
companyId
- the primary key of the companyPortalException
public ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
getExportActionableDynamicQuery
in interface UserLocalService
public long[] getGroupPrimaryKeys(long userId)
getGroupPrimaryKeys
in interface UserLocalService
userId
- the userId of the userpublic long[] getGroupUserIds(long groupId)
getGroupUserIds
in interface UserLocalService
groupId
- the primary key of the grouppublic List<User> getGroupUsers(long groupId)
getGroupUsers
in interface UserLocalService
public List<User> getGroupUsers(long groupId, int start, int end) throws PortalException
getGroupUsers
in interface UserLocalService
PortalException
public List<User> getGroupUsers(long groupId, int status, int start, int end, OrderByComparator<User> orderByComparator) throws PortalException
getGroupUsers
in interface UserLocalService
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
(optionally null
)PortalException
public List<User> getGroupUsers(long groupId, int start, int end, OrderByComparator<User> orderByComparator)
getGroupUsers
in interface UserLocalService
public List<User> getGroupUsers(long groupId, int status, OrderByComparator<User> orderByComparator) throws PortalException
getGroupUsers
in interface UserLocalService
groupId
- the primary key of the groupstatus
- the workflow statusorderByComparator
- the comparator to order the users by
(optionally null
)PortalException
public int getGroupUsersCount(long groupId)
getGroupUsersCount
in interface UserLocalService
public int getGroupUsersCount(long groupId, int status) throws PortalException
getGroupUsersCount
in interface UserLocalService
groupId
- the primary key of the groupstatus
- the workflow statusPortalException
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
getIndexableActionableDynamicQuery
in interface UserLocalService
public List<User> getInheritedRoleUsers(long roleId, int start, int end, OrderByComparator<User> orderByComparator) throws PortalException
getInheritedRoleUsers
in interface UserLocalService
PortalException
public List<User> getNoAnnouncementsDeliveries(String type)
getNoAnnouncementsDeliveries
in interface UserLocalService
type
- the type of announcementpublic List<User> getNoGroups()
getNoGroups
in interface UserLocalService
public long[] getOrganizationPrimaryKeys(long userId)
getOrganizationPrimaryKeys
in interface UserLocalService
userId
- the userId of the userpublic int getOrganizationsAndUserGroupsUsersCount(long[] organizationIds, long[] userGroupIds)
getOrganizationsAndUserGroupsUsersCount
in interface UserLocalService
public long[] getOrganizationUserIds(long organizationId)
getOrganizationUserIds
in interface UserLocalService
organizationId
- the primary key of the organizationpublic List<User> getOrganizationUsers(long organizationId)
getOrganizationUsers
in interface UserLocalService
public List<User> getOrganizationUsers(long organizationId, int start, int end) throws PortalException
getOrganizationUsers
in interface UserLocalService
PortalException
public List<User> getOrganizationUsers(long organizationId, int status, int start, int end, OrderByComparator<User> orderByComparator) throws PortalException
getOrganizationUsers
in interface UserLocalService
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
(optionally null
)PortalException
public List<User> getOrganizationUsers(long organizationId, int start, int end, OrderByComparator<User> orderByComparator)
getOrganizationUsers
in interface UserLocalService
public List<User> getOrganizationUsers(long organizationId, int status, OrderByComparator<User> orderByComparator) throws PortalException
getOrganizationUsers
in interface UserLocalService
organizationId
- the primary key of the organizationstatus
- the workflow statusorderByComparator
- the comparator to order the users by
(optionally null
)PortalException
public int getOrganizationUsersCount(long organizationId)
getOrganizationUsersCount
in interface UserLocalService
public int getOrganizationUsersCount(long organizationId, int status) throws PortalException
getOrganizationUsersCount
in interface UserLocalService
organizationId
- the primary key of the organizationstatus
- the workflow statusPortalException
public String getOSGiServiceIdentifier()
getOSGiServiceIdentifier
in interface UserLocalService
public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
getPersistedModel
in interface PersistedModelLocalService
getPersistedModel
in interface UserLocalService
PortalException
public long[] getRolePrimaryKeys(long userId)
getRolePrimaryKeys
in interface UserLocalService
userId
- the userId of the userpublic long[] getRoleUserIds(long roleId)
getRoleUserIds
in interface UserLocalService
roleId
- the primary key of the rolepublic List<User> getRoleUsers(long roleId)
getRoleUsers
in interface UserLocalService
public List<User> getRoleUsers(long roleId, int start, int end)
getRoleUsers
in interface UserLocalService
public List<User> getRoleUsers(long roleId, int start, int end, OrderByComparator<User> orderByComparator)
getRoleUsers
in interface UserLocalService
public int getRoleUsersCount(long roleId)
getRoleUsersCount
in interface UserLocalService
public int getRoleUsersCount(long roleId, int status) throws PortalException
getRoleUsersCount
in interface UserLocalService
roleId
- the primary key of the rolestatus
- the workflow statusPortalException
public List<User> getSocialUsers(long userId, int socialRelationType, String socialRelationTypeComparator, int start, int end, OrderByComparator<User> orderByComparator) throws PortalException
getSocialUsers
in interface UserLocalService
PortalException
public List<User> getSocialUsers(long userId1, long userId2, int socialRelationType, int start, int end, OrderByComparator<User> orderByComparator) throws PortalException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
getSocialUsers
in interface UserLocalService
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 in SocialRelationConstants
.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
(optionally null
)PortalException
public List<User> getSocialUsers(long userId1, long userId2, int start, int end, OrderByComparator<User> orderByComparator) throws PortalException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
getSocialUsers
in interface UserLocalService
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
(optionally null
)PortalException
public int getSocialUsersCount(long userId, int socialRelationType, String socialRelationTypeComparator) throws PortalException
getSocialUsersCount
in interface UserLocalService
userId
- the primary key of the usersocialRelationType
- the type of social relation. The possible
types can be found in SocialRelationConstants
.PortalException
public int getSocialUsersCount(long userId1, long userId2) throws PortalException
getSocialUsersCount
in interface UserLocalService
userId1
- the primary key of the first useruserId2
- the primary key of the second userPortalException
public int getSocialUsersCount(long userId1, long userId2, int socialRelationType) throws PortalException
getSocialUsersCount
in interface UserLocalService
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 in SocialRelationConstants
.PortalException
public long[] getTeamPrimaryKeys(long userId)
getTeamPrimaryKeys
in interface UserLocalService
userId
- the userId of the userpublic List<User> getTeamUsers(long teamId)
getTeamUsers
in interface UserLocalService
public List<User> getTeamUsers(long teamId, int start, int end)
getTeamUsers
in interface UserLocalService
public List<User> getTeamUsers(long teamId, int start, int end, OrderByComparator<User> orderByComparator)
getTeamUsers
in interface UserLocalService
public int getTeamUsersCount(long teamId)
getTeamUsersCount
in interface UserLocalService
public User getUser(long userId) throws PortalException
getUser
in interface UserLocalService
userId
- the primary key of the userPortalException
- if a user with the primary key could not be foundpublic User getUserByContactId(long contactId) throws PortalException
getUserByContactId
in interface UserLocalService
contactId
- the user's contact IDPortalException
public User getUserByEmailAddress(long companyId, String emailAddress) throws PortalException
getUserByEmailAddress
in interface UserLocalService
companyId
- the primary key of the user's companyemailAddress
- the user's email addressPortalException
public User getUserByExternalReferenceCode(long companyId, String externalReferenceCode) throws PortalException
getUserByExternalReferenceCode
in interface UserLocalService
companyId
- the primary key of the companyexternalReferenceCode
- the user's external reference codePortalException
- if a matching user could not be found@Deprecated public User getUserByFacebookId(long companyId, long facebookId) throws PortalException
getUserByFacebookId
in interface UserLocalService
companyId
- the primary key of the user's companyfacebookId
- the user's Facebook IDPortalException
public User getUserByGoogleUserId(long companyId, String googleUserId) throws PortalException
getUserByGoogleUserId
in interface UserLocalService
companyId
- the primary key of the user's companygoogleUserId
- the user's Google user IDPortalException
public User getUserById(long userId) throws PortalException
getUserById
in interface UserLocalService
userId
- the primary key of the userPortalException
public User getUserById(long companyId, long userId) throws PortalException
getUserById
in interface UserLocalService
companyId
- the primary key of the user's companyuserId
- the primary key of the userPortalException
@Deprecated public User getUserByOpenId(long companyId, String openId) throws PortalException
getUserByOpenId
in interface UserLocalService
companyId
- the primary key of the user's companyopenId
- the user's OpenIDPortalException
public User getUserByPortraitId(long portraitId) throws PortalException
getUserByPortraitId
in interface UserLocalService
portraitId
- the user's portrait IDPortalException
public User getUserByScreenName(long companyId, String screenName) throws PortalException
getUserByScreenName
in interface UserLocalService
companyId
- the primary key of the user's companyscreenName
- the user's screen namePortalException
public User getUserByUuidAndCompanyId(String uuid, long companyId) throws PortalException
getUserByUuidAndCompanyId
in interface UserLocalService
uuid
- the user's UUIDcompanyId
- the primary key of the companyPortalException
- if a matching user could not be foundpublic long[] getUserGroupPrimaryKeys(long userId)
getUserGroupPrimaryKeys
in interface UserLocalService
userId
- the userId of the userpublic List<User> getUserGroupUsers(long userGroupId)
getUserGroupUsers
in interface UserLocalService
public List<User> getUserGroupUsers(long userGroupId, int start, int end)
getUserGroupUsers
in interface UserLocalService
public List<User> getUserGroupUsers(long userGroupId, int start, int end, OrderByComparator<User> orderByComparator)
getUserGroupUsers
in interface UserLocalService
public int getUserGroupUsersCount(long userGroupId)
getUserGroupUsersCount
in interface UserLocalService
public int getUserGroupUsersCount(long userGroupId, int status) throws PortalException
getUserGroupUsersCount
in interface UserLocalService
userGroupId
- the primary key of the user groupstatus
- the workflow statusPortalException
public long getUserIdByEmailAddress(long companyId, String emailAddress) throws PortalException
getUserIdByEmailAddress
in interface UserLocalService
companyId
- the primary key of the user's companyemailAddress
- the user's email addressPortalException
public long getUserIdByScreenName(long companyId, String screenName) throws PortalException
getUserIdByScreenName
in interface UserLocalService
companyId
- the primary key of the user's companyscreenName
- the user's screen namePortalException
public List<User> getUsers(int start, int end)
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. If orderByComparator
is specified, then the query will include the given ORDER BY logic. If orderByComparator
is absent, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.UserModelImpl
.
getUsers
in interface UserLocalService
start
- the lower bound of the range of usersend
- the upper bound of the range of users (not inclusive)public List<User> getUsers(long companyId, boolean defaultUser, int status, int start, int end, OrderByComparator<User> orderByComparator)
getUsers
in interface UserLocalService
public int getUsersCount()
getUsersCount
in interface UserLocalService
public int getUsersCount(long companyId, boolean defaultUser, int status)
getUsersCount
in interface UserLocalService
public boolean hasGroupUser(long groupId, long userId)
hasGroupUser
in interface UserLocalService
public boolean hasGroupUsers(long groupId)
hasGroupUsers
in interface UserLocalService
public boolean hasOrganizationUser(long organizationId, long userId)
hasOrganizationUser
in interface UserLocalService
public boolean hasOrganizationUsers(long organizationId)
hasOrganizationUsers
in interface UserLocalService
public boolean hasPasswordPolicyUser(long passwordPolicyId, long userId)
true
if the password policy has been assigned to the
user.hasPasswordPolicyUser
in interface UserLocalService
passwordPolicyId
- the primary key of the password policyuserId
- the primary key of the usertrue
if the password policy is assigned to the user;
false
otherwisepublic boolean hasRoleUser(long roleId, long userId)
hasRoleUser
in interface UserLocalService
public boolean hasRoleUser(long companyId, String name, long userId, boolean inherited) throws PortalException
true
if the user has the role with the name,
optionally through inheritance.hasRoleUser
in interface UserLocalService
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.true
if the user has the role; false
otherwisePortalException
public boolean hasRoleUsers(long roleId)
hasRoleUsers
in interface UserLocalService
public boolean hasTeamUser(long teamId, long userId)
hasTeamUser
in interface UserLocalService
public boolean hasTeamUsers(long teamId)
hasTeamUsers
in interface UserLocalService
public boolean hasUserGroupUser(long userGroupId, long userId)
hasUserGroupUser
in interface UserLocalService
public boolean hasUserGroupUsers(long userGroupId)
hasUserGroupUsers
in interface UserLocalService
public boolean isPasswordExpired(User user) throws PortalException
true
if the user's password is expired.isPasswordExpired
in interface UserLocalService
user
- the usertrue
if the user's password is expired;
false
otherwisePortalException
public User loadGetDefaultUser(long companyId) throws PortalException
loadGetDefaultUser
in interface UserLocalService
companyId
- the primary key of the companyPortalException
public List<User> search(long companyId, String keywords, int status, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<User> orderByComparator)
search(long, String, int, LinkedHashMap, int, int, Sort)
instead of this method wherever possible for performance reasons.
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
search
in interface UserLocalService
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 (optionally null
). For
more information see UserFinder
.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
(optionally null
)UserFinder
public Hits search(long companyId, String keywords, int status, LinkedHashMap<String,Object> params, int start, int end, Sort sort)
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
search
in interface UserLocalService
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 (optionally null
).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 (optionally
null
)public Hits search(long companyId, String keywords, int status, LinkedHashMap<String,Object> params, int start, int end, Sort[] sorts)
search
in interface UserLocalService
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)
search(long, String,
String, String, String, String, int, LinkedHashMap, boolean, int, int,
Sort)
instead of this method wherever possible for performance reasons.
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
search
in interface UserLocalService
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 (optionally null
). For
more information see UserFinder
.andSearch
- whether every field must match its keywords, or just
one field. For example, "users with the first name 'bob' and
last name 'smith'" vs "users with the first name 'bob'
or the last name 'smith'".start
- the lower bound of the range of usersend
- the upper bound of the range of users (not inclusive)orderByComparator
- the comparator to order the users by
(optionally null
)UserFinder
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)
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
search
in interface UserLocalService
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 (optionally null
).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 (optionally
null
)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)
search
in interface UserLocalService
public List<User> searchBySocial(long userId, int[] socialRelationTypes, String keywords, int start, int end) throws PortalException
searchBySocial
in interface UserLocalService
PortalException
public List<User> searchBySocial(long companyId, long[] groupIds, String keywords, int start, int end)
searchBySocial
in interface UserLocalService
public List<User> searchBySocial(long companyId, long[] groupIds, String keywords, int start, int end, OrderByComparator<User> orderByComparator)
searchBySocial
in interface UserLocalService
public List<User> searchBySocial(long[] groupIds, long userId, int[] socialRelationTypes, String keywords, int start, int end) throws PortalException
searchBySocial
in interface UserLocalService
PortalException
public int searchCount(long companyId, String keywords, int status, LinkedHashMap<String,Object> params)
searchCount
in interface UserLocalService
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 (optionally null
). For
more information see UserFinder
.public int searchCount(long companyId, String firstName, String middleName, String lastName, String screenName, String emailAddress, int status, LinkedHashMap<String,Object> params, boolean andSearch)
searchCount
in interface UserLocalService
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 (optionally null
). For
more information see UserFinder
.andSearch
- whether every field must match its keywords, or just
one field. For example, "users with the first name 'bob' and
last name 'smith'" vs "users with the first name 'bob'
or the last name 'smith'".public Map<Long,Integer> searchCounts(long companyId, int status, long[] groupIds)
searchCounts
in interface UserLocalService
@Deprecated public List<User> searchSocial(long userId, int[] socialRelationTypes, String keywords, int start, int end) throws PortalException
searchBySocial(long, int[], String, int, int)
searchSocial
in interface UserLocalService
PortalException
@Deprecated public List<User> searchSocial(long companyId, long[] groupIds, String keywords, int start, int end)
searchBySocial(long, long[], String, int, int)
searchSocial
in interface UserLocalService
@Deprecated public List<User> searchSocial(long companyId, long[] groupIds, String keywords, int start, int end, OrderByComparator<User> orderByComparator)
searchBySocial(long, long[], String, int, int,
OrderByComparator)
searchSocial
in interface UserLocalService
@Deprecated public List<User> searchSocial(long[] groupIds, long userId, int[] socialRelationTypes, String keywords, int start, int end) throws PortalException
searchBySocial(long[], long, int[], String, int, int)
searchSocial
in interface UserLocalService
PortalException
public BaseModelSearchResult<User> searchUsers(long companyId, String keywords, int status, LinkedHashMap<String,Object> params, int start, int end, Sort sort) throws PortalException
searchUsers
in interface UserLocalService
PortalException
public BaseModelSearchResult<User> searchUsers(long companyId, String keywords, int status, LinkedHashMap<String,Object> params, int start, int end, Sort[] sorts) throws PortalException
searchUsers
in interface UserLocalService
PortalException
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
searchUsers
in interface UserLocalService
PortalException
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
searchUsers
in interface UserLocalService
PortalException
public void sendEmailAddressVerification(User user, String emailAddress, ServiceContext serviceContext) throws PortalException
sendEmailAddressVerification
in interface UserLocalService
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.PortalException
public boolean sendPassword(long companyId, String emailAddress, String fromName, String fromAddress, String subject, String body, ServiceContext serviceContext) throws PortalException
portal.properties
with the
admin.email.password
keys.sendPassword
in interface UserLocalService
companyId
- the primary key of the user's companyemailAddress
- the user's email addressfromName
- the name of the individual that the email should be fromfromAddress
- the address of the individual that the email should be
fromsubject
- the email subject. If null
, the subject
specified in portal.properties
will be used.body
- the email body. If null
, the body specified in
portal.properties
will be used.serviceContext
- the service context to be appliedPortalException
public boolean sendPasswordByEmailAddress(long companyId, String emailAddress) throws PortalException
The content of the notification email is specified with the
admin.email.password
portal property keys. They can be
overridden via a portal-ext.properties
file or modified
through the Portal Settings UI.
sendPasswordByEmailAddress
in interface UserLocalService
companyId
- the primary key of the user's companyemailAddress
- the user's email addresstrue
if the notification email includes a new
password; false
if the notification email only
contains a reset linkPortalException
public boolean sendPasswordByScreenName(long companyId, String screenName) throws PortalException
The content of the notification email is specified with the
admin.email.password
portal property keys. They can be
overridden via a portal-ext.properties
file or modified
through the Portal Settings UI.
sendPasswordByScreenName
in interface UserLocalService
companyId
- the primary key of the user's companyscreenName
- the user's screen nametrue
if the notification email includes a new
password; false
if the notification email only
contains a reset linkPortalException
public boolean sendPasswordByUserId(long userId) throws PortalException
The content of the notification email is specified with the
admin.email.password
portal property keys. They can be
overridden via a portal-ext.properties
file or modified
through the Portal Settings UI.
sendPasswordByUserId
in interface UserLocalService
userId
- the user's primary keytrue
if the notification email includes a new
password; false
if the notification email only
contains a reset linkPortalException
public void setGroupUsers(long groupId, long[] userIds)
setGroupUsers
in interface UserLocalService
public void setOrganizationUsers(long organizationId, long[] userIds)
setOrganizationUsers
in interface UserLocalService
public void setRoleUsers(long roleId, long[] userIds) throws PortalException
setRoleUsers
in interface UserLocalService
PortalException
public void setTeamUsers(long teamId, long[] userIds)
setTeamUsers
in interface UserLocalService
public void setUserGroupUsers(long userGroupId, long[] userIds) throws PortalException
setUserGroupUsers
in interface UserLocalService
PortalException
public void unsetGroupTeamsUsers(long groupId, long[] userIds) throws PortalException
unsetGroupTeamsUsers
in interface UserLocalService
groupId
- the primary key of the groupuserIds
- the primary keys of the usersPortalException
public void unsetGroupUsers(long groupId, long[] userIds, ServiceContext serviceContext) throws PortalException
unsetGroupUsers
in interface UserLocalService
groupId
- the primary key of the groupuserIds
- the primary keys of the usersserviceContext
- the service context to be applied (optionally
null
)PortalException
public void unsetOrganizationUsers(long organizationId, long[] userIds) throws PortalException
unsetOrganizationUsers
in interface UserLocalService
organizationId
- the primary key of the organizationuserIds
- the primary keys of the usersPortalException
public void unsetPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
unsetPasswordPolicyUsers
in interface UserLocalService
passwordPolicyId
- the primary key of the password policyuserIds
- the primary keys of the userspublic void unsetRoleUsers(long roleId, List<User> users) throws PortalException
unsetRoleUsers
in interface UserLocalService
roleId
- the primary key of the roleusers
- the usersPortalException
public void unsetRoleUsers(long roleId, long[] userIds) throws PortalException
unsetRoleUsers
in interface UserLocalService
roleId
- the primary key of the roleuserIds
- the primary keys of the usersPortalException
public void unsetTeamUsers(long teamId, long[] userIds) throws PortalException
unsetTeamUsers
in interface UserLocalService
teamId
- the primary key of the teamuserIds
- the primary keys of the usersPortalException
public void unsetUserGroupUsers(long userGroupId, long[] userIds) throws PortalException
unsetUserGroupUsers
in interface UserLocalService
userGroupId
- the primary key of the user groupuserIds
- the primary keys of the usersPortalException
public User updateAgreedToTermsOfUse(long userId, boolean agreedToTermsOfUse) throws PortalException
updateAgreedToTermsOfUse
in interface UserLocalService
userId
- the primary key of the useragreedToTermsOfUse
- whether the user has agreet to the terms of
usePortalException
public void updateAsset(long userId, User user, long[] assetCategoryIds, String[] assetTagNames) throws PortalException
updateAsset
in interface UserLocalService
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 namesPortalException
public User updateCreateDate(long userId, Date createDate) throws PortalException
updateCreateDate
in interface UserLocalService
userId
- the primary key of the usercreateDate
- the new creation datePortalException
public User updateEmailAddress(long userId, String password, String emailAddress1, String emailAddress2) throws PortalException
updateEmailAddress
in interface UserLocalService
userId
- the primary key of the userpassword
- the user's passwordemailAddress1
- the user's new email addressemailAddress2
- the user's new email address confirmationPortalException
public User updateEmailAddress(long userId, String password, String emailAddress1, String emailAddress2, ServiceContext serviceContext) throws PortalException
updateEmailAddress
in interface UserLocalService
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.PortalException
public User updateEmailAddressVerified(long userId, boolean emailAddressVerified) throws PortalException
updateEmailAddressVerified
in interface UserLocalService
userId
- the primary key of the useremailAddressVerified
- whether the user has verified email addressPortalException
@Deprecated public User updateFacebookId(long userId, long facebookId) throws PortalException
updateFacebookId
in interface UserLocalService
userId
- the primary key of the userfacebookId
- the user's new Facebook IDPortalException
public User updateGoogleUserId(long userId, String googleUserId) throws PortalException
updateGoogleUserId
in interface UserLocalService
userId
- the primary key of the usergoogleUserId
- the new Google user IDPortalException
public void updateGroups(long userId, long[] newGroupIds, ServiceContext serviceContext) throws PortalException
updateGroups
in interface UserLocalService
userId
- the primary key of the usernewGroupIds
- the primary keys of the groupsserviceContext
- the service context to be applied (optionally
null
)PortalException
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 prefixId, long suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, boolean updateUserInformation, boolean sendEmail, ServiceContext serviceContext) throws PortalException
updateIncompleteUser
in interface UserLocalService
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 nameprefixId
- the user's name prefix IDsuffixId
- 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 (optionally
null
). Can set expando bridge attributes for the
user.PortalException
@Deprecated public User updateIncompleteUser(long creatorUserId, long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, long facebookId, String openId, Locale locale, String firstName, String middleName, String lastName, long prefixId, long suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, boolean updateUserInformation, boolean sendEmail, ServiceContext serviceContext) throws PortalException
updateIncompleteUser(long, long, boolean, String, String,
boolean, String, String, Locale, String, String, String,
long, long, boolean, int, int, int, String, boolean, boolean,
ServiceContext)
updateIncompleteUser
in interface UserLocalService
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 addressfacebookId
- the user's facebook IDopenId
- the user's OpenIDlocale
- the user's localefirstName
- the user's first namemiddleName
- the user's middle namelastName
- the user's last nameprefixId
- the user's name prefix IDsuffixId
- 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 (optionally
null
). Can set expando bridge attributes for the
user.PortalException
public User updateJobTitle(long userId, String jobTitle) throws PortalException
updateJobTitle
in interface UserLocalService
userId
- the primary key of the userjobTitle
- the user's job titlePortalException
public User updateLastLogin(long userId, String loginIP) throws PortalException
updateLastLogin
in interface UserLocalService
userId
- the primary key of the userloginIP
- the IP address the user logged in fromPortalException
public User updateLockout(User user, boolean lockout) throws PortalException
updateLockout
in interface UserLocalService
user
- the userlockout
- whether the user is locked outPortalException
public User updateLockoutByEmailAddress(long companyId, String emailAddress, boolean lockout) throws PortalException
updateLockoutByEmailAddress
in interface UserLocalService
companyId
- the primary key of the user's companyemailAddress
- the user's email addresslockout
- whether the user is locked outPortalException
public User updateLockoutById(long userId, boolean lockout) throws PortalException
updateLockoutById
in interface UserLocalService
userId
- the primary key of the userlockout
- whether the user is locked outPortalException
public User updateLockoutByScreenName(long companyId, String screenName, boolean lockout) throws PortalException
updateLockoutByScreenName
in interface UserLocalService
companyId
- the primary key of the user's companyscreenName
- the user's screen namelockout
- whether the user is locked outPortalException
public User updateModifiedDate(long userId, Date modifiedDate) throws PortalException
updateModifiedDate
in interface UserLocalService
userId
- the primary key of the usermodifiedDate
- the new modified datePortalException
@Deprecated public User updateOpenId(long userId, String openId) throws PortalException
updateOpenId
in interface UserLocalService
userId
- the primary key of the useropenId
- the new OpenIDPortalException
public void updateOrganizations(long userId, long[] newOrganizationIds, ServiceContext serviceContext) throws PortalException
updateOrganizations
in interface UserLocalService
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.PortalException
public User updatePassword(long userId, String password1, String password2, boolean passwordReset) throws PortalException
updatePassword
in interface UserLocalService
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 inPortalException
public User updatePassword(long userId, String password1, String password2, boolean passwordReset, boolean silentUpdate) throws PortalException
updatePassword
in interface UserLocalService
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.PortalException
public User updatePasswordManually(long userId, String password, boolean passwordEncrypted, boolean passwordReset, Date passwordModifiedDate) throws PortalException
updatePasswordManually
in interface UserLocalService
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 datePortalException
public User updatePasswordReset(long userId, boolean passwordReset) throws PortalException
updatePasswordReset
in interface UserLocalService
userId
- the primary key of the userpasswordReset
- whether the user should be asked to reset their
password the next time they loginPortalException
public User updatePortrait(long userId, byte[] bytes) throws PortalException
updatePortrait
in interface UserLocalService
userId
- the primary key of the userbytes
- the new portrait image dataPortalException
public User updateReminderQuery(long userId, String question, String answer) throws PortalException
updateReminderQuery
in interface UserLocalService
userId
- the primary key of the userquestion
- the user's new password reset questionanswer
- the user's new password reset answerPortalException
public User updateScreenName(long userId, String screenName) throws PortalException
updateScreenName
in interface UserLocalService
userId
- the primary key of the userscreenName
- the user's new screen namePortalException
public User updateStatus(long userId, int status, ServiceContext serviceContext) throws PortalException
updateStatus
in interface UserLocalService
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 attribute passwordUnencrypted
.PortalException
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 prefixId, long suffixId, 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
updateUser
in interface UserLocalService
userId
- the primary key of the useroldPassword
- the user's old passwordnewPassword1
- the user's new password (optionally
null
)newPassword2
- the user's new password confirmation (optionally
null
)passwordReset
- whether the user should be asked to reset their
password the next time they 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 nameprefixId
- the user's new name prefix IDsuffixId
- 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 (optionally
null
). Can set the UUID (with the uuid
attribute), asset category IDs, asset tag names, and expando
bridge attributes for the user.PortalException
@Deprecated public User updateUser(long userId, String oldPassword, String newPassword1, String newPassword2, boolean passwordReset, String reminderQueryQuestion, String reminderQueryAnswer, String screenName, String emailAddress, long facebookId, String openId, boolean hasPortrait, byte[] portraitBytes, String languageId, String timeZoneId, String greeting, String comments, String firstName, String middleName, String lastName, long prefixId, long suffixId, 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
updateUser(long, String, String, String, boolean, String,
String, String, String, boolean, byte[], String, String,
String, String, String, String, String, long, long, boolean,
int, int, int, String, String, String, String, String,
String, long[], long[], long[], List, long[], ServiceContext)
updateUser
in interface UserLocalService
userId
- the primary key of the useroldPassword
- the user's old passwordnewPassword1
- the user's new password (optionally
null
)newPassword2
- the user's new password confirmation (optionally
null
)passwordReset
- whether the user should be asked to reset their
password the next time they 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 addressfacebookId
- the user's new Facebook IDopenId
- the user's new OpenIDhasPortrait
- 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 nameprefixId
- the user's new name prefix IDsuffixId
- 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 (optionally
null
). Can set the UUID (with the
uuid
attribute), asset category IDs, asset tag
names, and expando bridge attributes for the user.PortalException
public User updateUser(User user)
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.
updateUser
in interface UserLocalService
user
- the userpublic void verifyEmailAddress(String ticketKey) throws PortalException
verifyEmailAddress
in interface UserLocalService
ticketKey
- the ticket keyPortalException
public CTPersistence<User> getCTPersistence()
getCTPersistence
in interface CTService<User>
getCTPersistence
in interface UserLocalService
public Class<User> getModelClass()
getModelClass
in interface CTService<User>
getModelClass
in interface UserLocalService
public <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<User>,R,E> updateUnsafeFunction) throws E extends Throwable
updateWithUnsafeFunction
in interface CTService<User>
updateWithUnsafeFunction
in interface UserLocalService
E extends Throwable
public UserLocalService getWrappedService()
getWrappedService
in interface ServiceWrapper<UserLocalService>
public void setWrappedService(UserLocalService userLocalService)
setWrappedService
in interface ServiceWrapper<UserLocalService>