|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.service.UserLocalServiceUtil
@ProviderType public class UserLocalServiceUtil
Provides the local service utility for User. This utility wraps
com.liferay.portal.service.impl.UserLocalServiceImpl and is the
primary access point for service operations in application layer code running
on the local server. Methods of this service will not have security checks
based on the propagated JAAS credentials because this service can only be
accessed from within the same VM.
UserLocalService,
UserLocalServiceBaseImpl,
com.liferay.portal.service.impl.UserLocalServiceImpl| Constructor Summary | |
|---|---|
UserLocalServiceUtil()
|
|
| Method Summary | ||
|---|---|---|
static User |
addDefaultAdminUser(long companyId,
String screenName,
String emailAddress,
Locale locale,
String firstName,
String middleName,
String lastName)
Adds a default admin user for the company. |
|
static void |
addDefaultGroups(long userId)
Adds the user to the default groups, unless the user is already in these groups. |
|
static void |
addDefaultRoles(long userId)
Adds the user to the default roles, unless the user already has these roles. |
|
static void |
addDefaultUserGroups(long userId)
Adds the user to the default user groups, unless the user is already in these user groups. |
|
static void |
addGroupUser(long groupId,
long userId)
|
|
static void |
addGroupUser(long groupId,
User user)
|
|
static void |
addGroupUsers(long groupId,
List<User> Users)
|
|
static void |
addGroupUsers(long groupId,
long[] userIds)
|
|
static void |
addOrganizationUser(long organizationId,
long userId)
|
|
static void |
addOrganizationUser(long organizationId,
User user)
|
|
static void |
addOrganizationUsers(long organizationId,
List<User> Users)
|
|
static void |
addOrganizationUsers(long organizationId,
long[] userIds)
|
|
static void |
addPasswordPolicyUsers(long passwordPolicyId,
long[] userIds)
Assigns the password policy to the users, removing any other currently assigned password policies. |
|
static void |
addRoleUser(long roleId,
long userId)
|
|
static void |
addRoleUser(long roleId,
User user)
|
|
static void |
addRoleUsers(long roleId,
List<User> Users)
|
|
static void |
addRoleUsers(long roleId,
long[] userIds)
|
|
static void |
addTeamUser(long teamId,
long userId)
|
|
static void |
addTeamUser(long teamId,
User user)
|
|
static void |
addTeamUsers(long teamId,
List<User> Users)
|
|
static void |
addTeamUsers(long teamId,
long[] userIds)
|
|
static 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)
Adds a user. |
|
static User |
addUser(User user)
Adds the user to the database. |
|
static void |
addUserGroupUser(long userGroupId,
long userId)
|
|
static void |
addUserGroupUser(long userGroupId,
User user)
|
|
static void |
addUserGroupUsers(long userGroupId,
List<User> Users)
|
|
static void |
addUserGroupUsers(long userGroupId,
long[] userIds)
|
|
static 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)
Adds a user with workflow. |
|
static 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. |
|
static 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. |
|
static 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. |
|
static long |
authenticateForBasic(long companyId,
String authType,
String login,
String password)
Attempts to authenticate the user using HTTP basic access authentication, without using the AuthPipeline. |
|
static long |
authenticateForDigest(long companyId,
String username,
String realm,
String nonce,
String method,
String uri,
String response)
Attempts to authenticate the user using HTTP digest access authentication, without using the AuthPipeline. |
|
static boolean |
authenticateForJAAS(long userId,
String encPassword)
Attempts to authenticate the user using JAAS credentials, without using the AuthPipeline. |
|
static 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. |
|
static void |
checkLoginFailure(User user)
Adds a failed login attempt to the user and updates the user's last failed login date. |
|
static 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. |
|
static void |
checkLoginFailureById(long userId)
Adds a failed login attempt to the user and updates the user's last failed login date. |
|
static 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. |
|
static 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. |
|
static void |
clearGroupUsers(long groupId)
|
|
static void |
clearOrganizationUsers(long organizationId)
|
|
static void |
clearRoleUsers(long roleId)
|
|
static void |
clearTeamUsers(long teamId)
|
|
static void |
clearUserGroupUsers(long userGroupId)
|
|
static void |
completeUserRegistration(User user,
ServiceContext serviceContext)
Completes the user's registration by generating a password and sending the confirmation email. |
|
static User |
createUser(long userId)
Creates a new user with the primary key. |
|
static KeyValuePair |
decryptUserId(long companyId,
String name,
String password)
Decrypts the user's primary key and password from their encrypted forms. |
|
static void |
deleteGroupUser(long groupId,
long userId)
|
|
static void |
deleteGroupUser(long groupId,
User user)
|
|
static void |
deleteGroupUsers(long groupId,
List<User> Users)
|
|
static void |
deleteGroupUsers(long groupId,
long[] userIds)
|
|
static void |
deleteOrganizationUser(long organizationId,
long userId)
|
|
static void |
deleteOrganizationUser(long organizationId,
User user)
|
|
static void |
deleteOrganizationUsers(long organizationId,
List<User> Users)
|
|
static void |
deleteOrganizationUsers(long organizationId,
long[] userIds)
|
|
static PersistedModel |
deletePersistedModel(PersistedModel persistedModel)
|
|
static void |
deletePortrait(long userId)
Deletes the user's portrait image. |
|
static void |
deleteRoleUser(long roleId,
long userId)
|
|
static void |
deleteRoleUser(long roleId,
User user)
|
|
static void |
deleteRoleUsers(long roleId,
List<User> Users)
|
|
static void |
deleteRoleUsers(long roleId,
long[] userIds)
|
|
static void |
deleteTeamUser(long teamId,
long userId)
|
|
static void |
deleteTeamUser(long teamId,
User user)
|
|
static void |
deleteTeamUsers(long teamId,
List<User> Users)
|
|
static void |
deleteTeamUsers(long teamId,
long[] userIds)
|
|
static User |
deleteUser(long userId)
Deletes the user with the primary key from the database. |
|
static User |
deleteUser(User user)
Deletes the user from the database. |
|
static void |
deleteUserGroupUser(long userGroupId,
long userId)
|
|
static void |
deleteUserGroupUser(long userGroupId,
User user)
|
|
static void |
deleteUserGroupUsers(long userGroupId,
List<User> Users)
|
|
static void |
deleteUserGroupUsers(long userGroupId,
long[] userIds)
|
|
static DynamicQuery |
dynamicQuery()
|
|
static
|
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
|
static
|
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
|
static
|
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. |
|
static long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query. |
|
static long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows matching the dynamic query. |
|
static String |
encryptUserId(String name)
Encrypts the primary key of the user. |
|
static User |
fetchUser(long userId)
|
|
static User |
fetchUserByContactId(long contactId)
Returns the user with the contact ID. |
|
static User |
fetchUserByEmailAddress(long companyId,
String emailAddress)
Returns the user with the email address. |
|
static User |
fetchUserByFacebookId(long companyId,
long facebookId)
Returns the user with the Facebook ID. |
|
static User |
fetchUserById(long userId)
Returns the user with the primary key. |
|
static User |
fetchUserByOpenId(long companyId,
String openId)
Returns the user with the OpenID. |
|
static User |
fetchUserByPortraitId(long portraitId)
Returns the user with the portrait ID. |
|
static User |
fetchUserByScreenName(long companyId,
String screenName)
Returns the user with the screen name. |
|
static User |
fetchUserByUuidAndCompanyId(String uuid,
long companyId)
Returns the user with the matching UUID and company. |
|
static ActionableDynamicQuery |
getActionableDynamicQuery()
|
|
static List<User> |
getCompanyUsers(long companyId,
int start,
int end)
Returns a range of all the users belonging to the company. |
|
static int |
getCompanyUsersCount(long companyId)
Returns the number of users belonging to the company. |
|
static User |
getDefaultUser(long companyId)
Returns the default user for the company. |
|
static long |
getDefaultUserId(long companyId)
Returns the primary key of the default user for the company. |
|
static ExportActionableDynamicQuery |
getExportActionableDynamicQuery(PortletDataContext portletDataContext)
|
|
static long[] |
getGroupPrimaryKeys(long userId)
Returns the groupIds of the groups associated with the user. |
|
static long[] |
getGroupUserIds(long groupId)
Returns the primary keys of all the users belonging to the group. |
|
static List<User> |
getGroupUsers(long groupId)
|
|
static List<User> |
getGroupUsers(long groupId,
int start,
int end)
|
|
static List<User> |
getGroupUsers(long groupId,
int start,
int end,
OrderByComparator<User> orderByComparator)
|
|
static int |
getGroupUsersCount(long groupId)
|
|
static int |
getGroupUsersCount(long groupId,
int status)
Returns the number of users with the status belonging to the group. |
|
static IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery()
|
|
static List<User> |
getInheritedRoleUsers(long roleId,
int start,
int end,
OrderByComparator<User> obc)
|
|
static List<User> |
getNoAnnouncementsDeliveries(String type)
Returns all the users who have not had any announcements of the type delivered, excluding the default user. |
|
static List<User> |
getNoContacts()
Returns all the users who do not have any contacts. |
|
static List<User> |
getNoGroups()
Returns all the users who do not belong to any groups, excluding the default user. |
|
static long[] |
getOrganizationPrimaryKeys(long userId)
Returns the organizationIds of the organizations associated with the user. |
|
static long[] |
getOrganizationUserIds(long organizationId)
Returns the primary keys of all the users belonging to the organization. |
|
static List<User> |
getOrganizationUsers(long organizationId)
|
|
static List<User> |
getOrganizationUsers(long organizationId,
int start,
int end)
|
|
static List<User> |
getOrganizationUsers(long organizationId,
int start,
int end,
OrderByComparator<User> orderByComparator)
|
|
static int |
getOrganizationUsersCount(long organizationId)
|
|
static int |
getOrganizationUsersCount(long organizationId,
int status)
Returns the number of users with the status belonging to the organization. |
|
static String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier. |
|
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
|
static long[] |
getRolePrimaryKeys(long userId)
Returns the roleIds of the roles associated with the user. |
|
static long[] |
getRoleUserIds(long roleId)
Returns the primary keys of all the users belonging to the role. |
|
static List<User> |
getRoleUsers(long roleId)
|
|
static List<User> |
getRoleUsers(long roleId,
int start,
int end)
|
|
static List<User> |
getRoleUsers(long roleId,
int start,
int end,
OrderByComparator<User> orderByComparator)
|
|
static int |
getRoleUsersCount(long roleId)
|
|
static int |
getRoleUsersCount(long roleId,
int status)
Returns the number of users with the status belonging to the role. |
|
static UserLocalService |
getService()
|
|
static List<User> |
getSocialUsers(long userId,
int socialRelationType,
int start,
int end,
OrderByComparator<User> obc)
Deprecated. As of 7.0.0, replaced by getSocialUsers(long, int,
String, int, int, OrderByComparator) |
|
static List<User> |
getSocialUsers(long userId,
int start,
int end,
OrderByComparator<User> obc)
Deprecated. As of 7.0.0, replaced by getSocialUsers(long, int,
String, int, int, OrderByComparator) |
|
static List<User> |
getSocialUsers(long userId,
int socialRelationType,
String socialRelationTypeComparator,
int start,
int end,
OrderByComparator<User> obc)
|
|
static List<User> |
getSocialUsers(long userId1,
long userId2,
int socialRelationType,
int start,
int end,
OrderByComparator<User> obc)
Returns an ordered range of all the users with a mutual social relation of the type with both of the given users. |
|
static List<User> |
getSocialUsers(long userId1,
long userId2,
int start,
int end,
OrderByComparator<User> obc)
Returns an ordered range of all the users with a mutual social relation with both of the given users. |
|
static int |
getSocialUsersCount(long userId)
Deprecated. As of 7.0.0, replaced by getSocialUsersCount(long,
int, String) |
|
static int |
getSocialUsersCount(long userId,
int socialRelationType)
Deprecated. As of 7.0.0, replaced by getSocialUsersCount(long,
int, String) |
|
static int |
getSocialUsersCount(long userId,
int socialRelationType,
String socialRelationTypeComparator)
Returns the number of users with a social relation with the user. |
|
static int |
getSocialUsersCount(long userId1,
long userId2)
Returns the number of users with a mutual social relation with both of the given users. |
|
static 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. |
|
static long[] |
getTeamPrimaryKeys(long userId)
Returns the teamIds of the teams associated with the user. |
|
static List<User> |
getTeamUsers(long teamId)
|
|
static List<User> |
getTeamUsers(long teamId,
int start,
int end)
|
|
static List<User> |
getTeamUsers(long teamId,
int start,
int end,
OrderByComparator<User> orderByComparator)
|
|
static int |
getTeamUsersCount(long teamId)
|
|
static User |
getUser(long userId)
Returns the user with the primary key. |
|
static User |
getUserByContactId(long contactId)
Returns the user with the contact ID. |
|
static User |
getUserByEmailAddress(long companyId,
String emailAddress)
Returns the user with the email address. |
|
static User |
getUserByFacebookId(long companyId,
long facebookId)
Returns the user with the Facebook ID. |
|
static User |
getUserById(long userId)
Returns the user with the primary key. |
|
static User |
getUserById(long companyId,
long userId)
Returns the user with the primary key from the company. |
|
static User |
getUserByOpenId(long companyId,
String openId)
Returns the user with the OpenID. |
|
static User |
getUserByPortraitId(long portraitId)
Returns the user with the portrait ID. |
|
static User |
getUserByScreenName(long companyId,
String screenName)
Returns the user with the screen name. |
|
static User |
getUserByUuid(String uuid)
Deprecated. As of 6.2.0, replaced by getUserByUuidAndCompanyId(String, long) |
|
static User |
getUserByUuidAndCompanyId(String uuid,
long companyId)
Returns the user with the matching UUID and company. |
|
static long[] |
getUserGroupPrimaryKeys(long userId)
Returns the userGroupIds of the user groups associated with the user. |
|
static List<User> |
getUserGroupUsers(long userGroupId)
|
|
static List<User> |
getUserGroupUsers(long userGroupId,
int start,
int end)
|
|
static List<User> |
getUserGroupUsers(long userGroupId,
int start,
int end,
OrderByComparator<User> orderByComparator)
|
|
static int |
getUserGroupUsersCount(long userGroupId)
|
|
static int |
getUserGroupUsersCount(long userGroupId,
int status)
Returns the number of users with the status belonging to the user group. |
|
static long |
getUserIdByEmailAddress(long companyId,
String emailAddress)
Returns the primary key of the user with the email address. |
|
static long |
getUserIdByScreenName(long companyId,
String screenName)
Returns the primary key of the user with the screen name. |
|
static List<User> |
getUsers(int start,
int end)
Returns a range of all the users. |
|
static int |
getUsersCount()
Returns the number of users. |
|
static boolean |
hasGroupUser(long groupId,
long userId)
|
|
static boolean |
hasGroupUsers(long groupId)
|
|
static boolean |
hasOrganizationUser(long organizationId,
long userId)
|
|
static boolean |
hasOrganizationUsers(long organizationId)
|
|
static boolean |
hasPasswordPolicyUser(long passwordPolicyId,
long userId)
Returns true if the password policy has been assigned to the
user. |
|
static boolean |
hasRoleUser(long roleId,
long userId)
|
|
static boolean |
hasRoleUser(long companyId,
String name,
long userId,
boolean inherited)
Returns true if the user has the role with the name,
optionally through inheritance. |
|
static boolean |
hasRoleUsers(long roleId)
|
|
static boolean |
hasTeamUser(long teamId,
long userId)
|
|
static boolean |
hasTeamUsers(long teamId)
|
|
static boolean |
hasUserGroupUser(long userGroupId,
long userId)
|
|
static boolean |
hasUserGroupUsers(long userGroupId)
|
|
static boolean |
isPasswordExpired(User user)
Returns true if the user's password is expired. |
|
static boolean |
isPasswordExpiringSoon(User user)
Returns true if the password policy is configured to warn
the user that his password is expiring and the remaining time until
expiration is equal or less than the configured warning time. |
|
static User |
loadGetDefaultUser(long companyId)
Returns the default user for the company. |
|
static List<User> |
search(long companyId,
String keywords,
int status,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator<User> obc)
Returns an ordered range of all the users who match the keywords and status, without using the indexer. |
|
static 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. |
|
static Hits |
search(long companyId,
String keywords,
int status,
LinkedHashMap<String,Object> params,
int start,
int end,
Sort[] sorts)
|
|
static 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> obc)
Returns an ordered range of all the users with the status, and whose first name, middle name, last name, screen name, and email address match the keywords specified for them, without using the indexer. |
|
static 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. |
|
static 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)
|
|
static int |
searchCount(long companyId,
String keywords,
int status,
LinkedHashMap<String,Object> params)
Returns the number of users who match the keywords and status. |
|
static 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. |
|
static Map<Long,Integer> |
searchCounts(long companyId,
int status,
long[] groupIds)
|
|
static List<User> |
searchSocial(long[] groupIds,
long userId,
int[] socialRelationTypes,
String keywords,
int start,
int end)
|
|
static List<User> |
searchSocial(long userId,
int[] socialRelationTypes,
String keywords,
int start,
int end)
|
|
static List<User> |
searchSocial(long companyId,
long[] groupIds,
String keywords,
int start,
int end)
|
|
static BaseModelSearchResult<User> |
searchUsers(long companyId,
String keywords,
int status,
LinkedHashMap<String,Object> params,
int start,
int end,
Sort sort)
|
|
static BaseModelSearchResult<User> |
searchUsers(long companyId,
String keywords,
int status,
LinkedHashMap<String,Object> params,
int start,
int end,
Sort[] sorts)
|
|
static 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)
|
|
static 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)
|
|
static void |
sendEmailAddressVerification(User user,
String emailAddress,
ServiceContext serviceContext)
Sends an email address verification to the user. |
|
static 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. |
|
static boolean |
sendPasswordByEmailAddress(long companyId,
String emailAddress)
Sends a password notification email to the user matching the email address. |
|
static boolean |
sendPasswordByScreenName(long companyId,
String screenName)
Sends a password notification email to the user matching the screen name. |
|
static boolean |
sendPasswordByUserId(long userId)
Sends a password notification email to the user matching the ID. |
|
static void |
setGroupUsers(long groupId,
long[] userIds)
|
|
static void |
setOrganizationUsers(long organizationId,
long[] userIds)
|
|
static void |
setRoleUsers(long roleId,
long[] userIds)
|
|
static void |
setTeamUsers(long teamId,
long[] userIds)
|
|
static void |
setUserGroupUsers(long userGroupId,
long[] userIds)
|
|
static void |
unsetGroupTeamsUsers(long groupId,
long[] userIds)
Removes the users from the teams of a group. |
|
static void |
unsetGroupUsers(long groupId,
long[] userIds,
ServiceContext serviceContext)
Removes the users from the group. |
|
static void |
unsetOrganizationUsers(long organizationId,
long[] userIds)
Removes the users from the organization. |
|
static void |
unsetPasswordPolicyUsers(long passwordPolicyId,
long[] userIds)
Removes the users from the password policy. |
|
static void |
unsetRoleUsers(long roleId,
List<User> users)
Removes the users from the role. |
|
static void |
unsetRoleUsers(long roleId,
long[] userIds)
Removes the users from the role. |
|
static void |
unsetTeamUsers(long teamId,
long[] userIds)
Removes the users from the team. |
|
static void |
unsetUserGroupUsers(long userGroupId,
long[] userIds)
Removes the users from the user group. |
|
static User |
updateAgreedToTermsOfUse(long userId,
boolean agreedToTermsOfUse)
Updates whether the user has agreed to the terms of use. |
|
static 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. |
|
static User |
updateCreateDate(long userId,
Date createDate)
Updates the user's creation date. |
|
static User |
updateEmailAddress(long userId,
String password,
String emailAddress1,
String emailAddress2)
Updates the user's email address. |
|
static User |
updateEmailAddress(long userId,
String password,
String emailAddress1,
String emailAddress2,
ServiceContext serviceContext)
Updates the user's email address or sends verification email. |
|
static User |
updateEmailAddressVerified(long userId,
boolean emailAddressVerified)
Updates whether the user has verified email address. |
|
static User |
updateFacebookId(long userId,
long facebookId)
Updates the user's Facebook ID. |
|
static void |
updateGroups(long userId,
long[] newGroupIds,
ServiceContext serviceContext)
Sets the groups the user is in, removing and adding groups as necessary. |
|
static 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)
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. |
|
static User |
updateJobTitle(long userId,
String jobTitle)
Updates the user's job title. |
|
static User |
updateLastLogin(long userId,
String loginIP)
Updates the user's last login with the current time and the IP address. |
|
static User |
updateLockout(User user,
boolean lockout)
Updates whether the user is locked out from logging in. |
|
static User |
updateLockoutByEmailAddress(long companyId,
String emailAddress,
boolean lockout)
Updates whether the user is locked out from logging in. |
|
static User |
updateLockoutById(long userId,
boolean lockout)
Updates whether the user is locked out from logging in. |
|
static User |
updateLockoutByScreenName(long companyId,
String screenName,
boolean lockout)
Updates whether the user is locked out from logging in. |
|
static User |
updateModifiedDate(long userId,
Date modifiedDate)
Updates the user's modified date. |
|
static User |
updateOpenId(long userId,
String openId)
Updates the user's OpenID. |
|
static void |
updateOrganizations(long userId,
long[] newOrganizationIds,
ServiceContext serviceContext)
Sets the organizations that the user is in, removing and adding organizations as necessary. |
|
static User |
updatePassword(long userId,
String password1,
String password2,
boolean passwordReset)
Updates the user's password without tracking or validation of the change. |
|
static 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. |
|
static User |
updatePasswordManually(long userId,
String password,
boolean passwordEncrypted,
boolean passwordReset,
Date passwordModifiedDate)
Updates the user's password with manually input information. |
|
static User |
updatePasswordReset(long userId,
boolean passwordReset)
Updates whether the user should be asked to reset their password the next time they login. |
|
static User |
updatePortrait(long userId,
byte[] bytes)
Updates the user's portrait image. |
|
static User |
updateReminderQuery(long userId,
String question,
String answer)
Updates the user's password reset question and answer. |
|
static User |
updateScreenName(long userId,
String screenName)
Updates the user's screen name. |
|
static User |
updateStatus(long userId,
int status)
Deprecated. As of 7.0.0, replaced by updateStatus(long, int,
ServiceContext) |
|
static User |
updateStatus(long userId,
int status,
ServiceContext serviceContext)
Updates the user's workflow status. |
|
static 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 portrait,
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. |
|
static User |
updateUser(long userId,
String oldPassword,
String newPassword1,
String newPassword2,
boolean passwordReset,
String reminderQueryQuestion,
String reminderQueryAnswer,
String screenName,
String emailAddress,
long facebookId,
String openId,
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 7.0.0, replaced by #updateUser(long, String,
String, String, boolean, String, String, String, String,
long, String, boolean, byte[], String, String, String,
String, String, String, String, int, int, boolean, int, int,
int, String, String, String, String, String, String, String,
String, String, String, String, long[], long[], long[], List,
long[], ServiceContext) |
|
static User |
updateUser(User user)
Updates the user in the database or adds it if it does not yet exist. |
|
static void |
verifyEmailAddress(String ticketKey)
Verifies the email address of the ticket. |
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public UserLocalServiceUtil()
| Method Detail |
|---|
public static User addDefaultAdminUser(long companyId,
String screenName,
String emailAddress,
Locale locale,
String firstName,
String middleName,
String lastName)
throws PortalException
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 name
PortalException
public static void addDefaultGroups(long userId)
throws PortalException
portal.properties with the key
admin.default.group.names.
userId - the primary key of the user
PortalException
public static void addDefaultRoles(long userId)
throws PortalException
portal.properties with the key
admin.default.role.names.
userId - the primary key of the user
PortalException
public static void addDefaultUserGroups(long userId)
throws PortalException
portal.properties with the property
admin.default.user.group.names.
userId - the primary key of the user
PortalException
public static void addGroupUser(long groupId,
User user)
public static void addGroupUser(long groupId,
long userId)
public static void addGroupUsers(long groupId,
List<User> Users)
throws PortalException
PortalException
public static void addGroupUsers(long groupId,
long[] userIds)
throws PortalException
PortalException
public static void addOrganizationUser(long organizationId,
User user)
public static void addOrganizationUser(long organizationId,
long userId)
public static void addOrganizationUsers(long organizationId,
List<User> Users)
throws PortalException
PortalException
public static void addOrganizationUsers(long organizationId,
long[] userIds)
throws PortalException
PortalException
public static void addPasswordPolicyUsers(long passwordPolicyId,
long[] userIds)
passwordPolicyId - the primary key of the password policyuserIds - the primary keys of the users
public static void addRoleUser(long roleId,
User user)
public static void addRoleUser(long roleId,
long userId)
public static void addRoleUsers(long roleId,
List<User> Users)
throws PortalException
PortalException
public static void addRoleUsers(long roleId,
long[] userIds)
throws PortalException
PortalException
public static void addTeamUser(long teamId,
User user)
public static void addTeamUser(long teamId,
long userId)
public static void addTeamUsers(long teamId,
List<User> Users)
throws PortalException
PortalException
public static void addTeamUsers(long teamId,
long[] userIds)
throws PortalException
PortalException
public static 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
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.
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.
PortalExceptionpublic static User addUser(User user)
user - the user
public static void addUserGroupUser(long userGroupId,
User user)
public static void addUserGroupUser(long userGroupId,
long userId)
public static void addUserGroupUsers(long userGroupId,
List<User> Users)
throws PortalException
PortalException
public static void addUserGroupUsers(long userGroupId,
long[] userIds)
throws PortalException
PortalException
public static 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
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.
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 static int authenticateByEmailAddress(long companyId,
String emailAddress,
String password,
Map<String,String[]> headerMap,
Map<String,String[]> parameterMap,
Map<String,Object> resultsMap)
throws PortalException
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.
PortalExceptionAuthPipeline
public static int authenticateByScreenName(long companyId,
String screenName,
String password,
Map<String,String[]> headerMap,
Map<String,String[]> parameterMap,
Map<String,Object> resultsMap)
throws PortalException
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.
PortalExceptionAuthPipeline
public static int authenticateByUserId(long companyId,
long userId,
String password,
Map<String,String[]> headerMap,
Map<String,String[]> parameterMap,
Map<String,Object> resultsMap)
throws PortalException
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.
PortalExceptionAuthPipeline
public static 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
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 authTypepassword - the user's password
0 otherwise
PortalException
public static long authenticateForDigest(long companyId,
String username,
String realm,
String nonce,
String method,
String uri,
String response)
throws PortalException
tunnel-web.
companyId - the primary key of the user's companyusername - either the user's email address, screen name, or primary
keyrealm - unusednonce - the number used oncemethod - the request methoduri - the request URIresponse - the authentication response hash
0 otherwise
PortalException
public static boolean authenticateForJAAS(long userId,
String encPassword)
userId - the primary key of the userencPassword - the encrypted password
true if authentication is successful;
false otherwise
public static void checkLockout(User user)
throws PortalException
user - the user
PortalExceptionpublic static void checkLoginFailure(User user)
user - the user
public static void checkLoginFailureByEmailAddress(long companyId,
String emailAddress)
throws PortalException
companyId - the primary key of the user's companyemailAddress - the user's email address
PortalException
public static void checkLoginFailureById(long userId)
throws PortalException
userId - the primary key of the user
PortalException
public static void checkLoginFailureByScreenName(long companyId,
String screenName)
throws PortalException
companyId - the primary key of the user's companyscreenName - the user's screen name
PortalException
public static void checkPasswordExpired(User user)
throws PortalException
user - the user
PortalExceptionpublic static void clearGroupUsers(long groupId)
public static void clearOrganizationUsers(long organizationId)
public static void clearRoleUsers(long roleId)
public static void clearTeamUsers(long teamId)
public static void clearUserGroupUsers(long userGroupId)
public static void completeUserRegistration(User user,
ServiceContext serviceContext)
throws PortalException
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.
PortalExceptionpublic static User createUser(long userId)
userId - the primary key for the new user
public static KeyValuePair decryptUserId(long companyId,
String name,
String password)
throws PortalException
companyId - the primary key of the user's companyname - the encrypted primary key of the userpassword - the encrypted password of the user
PortalException
public static void deleteGroupUser(long groupId,
User user)
public static void deleteGroupUser(long groupId,
long userId)
public static void deleteGroupUsers(long groupId,
List<User> Users)
public static void deleteGroupUsers(long groupId,
long[] userIds)
public static void deleteOrganizationUser(long organizationId,
User user)
public static void deleteOrganizationUser(long organizationId,
long userId)
public static void deleteOrganizationUsers(long organizationId,
List<User> Users)
public static void deleteOrganizationUsers(long organizationId,
long[] userIds)
public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException
PortalException
public static void deletePortrait(long userId)
throws PortalException
userId - the primary key of the user
PortalException
public static void deleteRoleUser(long roleId,
User user)
throws PortalException
PortalException
public static void deleteRoleUser(long roleId,
long userId)
throws PortalException
PortalException
public static void deleteRoleUsers(long roleId,
List<User> Users)
public static void deleteRoleUsers(long roleId,
long[] userIds)
public static void deleteTeamUser(long teamId,
User user)
public static void deleteTeamUser(long teamId,
long userId)
public static void deleteTeamUsers(long teamId,
List<User> Users)
public static void deleteTeamUsers(long teamId,
long[] userIds)
public static User deleteUser(User user)
throws PortalException
user - the user
PortalException
public static User deleteUser(long userId)
throws PortalException
userId - the primary key of the user
PortalException - if a user with the primary key could not be found
public static void deleteUserGroupUser(long userGroupId,
User user)
throws PortalException
PortalException
public static void deleteUserGroupUser(long userGroupId,
long userId)
throws PortalException
PortalException
public static void deleteUserGroupUsers(long userGroupId,
List<User> Users)
public static void deleteUserGroupUsers(long userGroupId,
long[] userIds)
public static DynamicQuery dynamicQuery()
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
public static <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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from UserModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
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 static <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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from UserModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
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 static long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
public static long dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
dynamicQuery - the dynamic queryprojection - the projection to apply to the query
public static String encryptUserId(String name)
throws PortalException
name - the primary key of the user
PortalExceptionpublic static User fetchUser(long userId)
public static User fetchUserByContactId(long contactId)
contactId - the user's contact ID
null if a user with
the contact ID could not be found
public static User fetchUserByEmailAddress(long companyId,
String emailAddress)
companyId - the primary key of the user's companyemailAddress - the user's email address
null if a user
with the email address could not be found
public static User fetchUserByFacebookId(long companyId,
long facebookId)
companyId - the primary key of the user's companyfacebookId - the user's Facebook ID
null if a user
with the Facebook ID could not be foundpublic static User fetchUserById(long userId)
userId - the primary key of the user
null if a user
with the primary key could not be found
public static User fetchUserByOpenId(long companyId,
String openId)
companyId - the primary key of the user's companyopenId - the user's OpenID
null if a user with the
OpenID could not be foundpublic static User fetchUserByPortraitId(long portraitId)
portraitId - the user's portrait ID
null if a user
with the portrait ID could not be found
public static User fetchUserByScreenName(long companyId,
String screenName)
companyId - the primary key of the user's companyscreenName - the user's screen name
null if a user
with the screen name could not be found
public static User fetchUserByUuidAndCompanyId(String uuid,
long companyId)
uuid - the user's UUIDcompanyId - the primary key of the company
null if a matching user could not be foundpublic static ActionableDynamicQuery getActionableDynamicQuery()
public static 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.
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 static int getCompanyUsersCount(long companyId)
companyId - the primary key of the company
public static User getDefaultUser(long companyId)
throws PortalException
companyId - the primary key of the company
PortalException
public static long getDefaultUserId(long companyId)
throws PortalException
companyId - the primary key of the company
PortalExceptionpublic static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
public static long[] getGroupPrimaryKeys(long userId)
userId - the userId of the user
public static long[] getGroupUserIds(long groupId)
groupId - the primary key of the group
public static List<User> getGroupUsers(long groupId)
public static List<User> getGroupUsers(long groupId,
int start,
int end)
public static List<User> getGroupUsers(long groupId,
int start,
int end,
OrderByComparator<User> orderByComparator)
public static int getGroupUsersCount(long groupId)
public static int getGroupUsersCount(long groupId,
int status)
throws PortalException
groupId - the primary key of the groupstatus - the workflow status
PortalExceptionpublic static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static List<User> getInheritedRoleUsers(long roleId,
int start,
int end,
OrderByComparator<User> obc)
throws PortalException
PortalExceptionpublic static List<User> getNoAnnouncementsDeliveries(String type)
type - the type of announcement
public static List<User> getNoContacts()
public static List<User> getNoGroups()
public static String getOSGiServiceIdentifier()
public static long[] getOrganizationPrimaryKeys(long userId)
userId - the userId of the user
public static long[] getOrganizationUserIds(long organizationId)
organizationId - the primary key of the organization
public static List<User> getOrganizationUsers(long organizationId)
public static List<User> getOrganizationUsers(long organizationId,
int start,
int end)
public static List<User> getOrganizationUsers(long organizationId,
int start,
int end,
OrderByComparator<User> orderByComparator)
public static int getOrganizationUsersCount(long organizationId)
public static int getOrganizationUsersCount(long organizationId,
int status)
throws PortalException
organizationId - the primary key of the organizationstatus - the workflow status
PortalException
public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException
PortalExceptionpublic static long[] getRolePrimaryKeys(long userId)
userId - the userId of the user
public static long[] getRoleUserIds(long roleId)
roleId - the primary key of the role
public static List<User> getRoleUsers(long roleId)
public static List<User> getRoleUsers(long roleId,
int start,
int end)
public static List<User> getRoleUsers(long roleId,
int start,
int end,
OrderByComparator<User> orderByComparator)
public static int getRoleUsersCount(long roleId)
public static int getRoleUsersCount(long roleId,
int status)
throws PortalException
roleId - the primary key of the rolestatus - the workflow status
PortalException
public static List<User> getSocialUsers(long userId,
int socialRelationType,
String socialRelationTypeComparator,
int start,
int end,
OrderByComparator<User> obc)
throws PortalException
PortalException
@Deprecated
public static List<User> getSocialUsers(long userId,
int socialRelationType,
int start,
int end,
OrderByComparator<User> obc)
throws PortalException
getSocialUsers(long, int,
String, int, int, 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 QueryUtil#ALL_POS will return the full
result set.
userId - the primary key of the 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)obc - the comparator to order the users by (optionally
null)
PortalException
@Deprecated
public static List<User> getSocialUsers(long userId,
int start,
int end,
OrderByComparator<User> obc)
throws PortalException
getSocialUsers(long, int,
String, int, int, 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 QueryUtil#ALL_POS will return the full
result set.
userId - the primary key of the userstart - the lower bound of the range of usersend - the upper bound of the range of users (not inclusive)obc - the comparator to order the users by (optionally
null)
PortalException
public static List<User> getSocialUsers(long userId1,
long userId2,
int socialRelationType,
int start,
int end,
OrderByComparator<User> obc)
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.
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)obc - the comparator to order the users by (optionally
null)
PortalException
public static List<User> getSocialUsers(long userId1,
long userId2,
int start,
int end,
OrderByComparator<User> obc)
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.
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)obc - the comparator to order the users by (optionally
null)
PortalException
@Deprecated
public static int getSocialUsersCount(long userId)
throws PortalException
getSocialUsersCount(long,
int, String)
userId - the primary key of the user
PortalException
@Deprecated
public static int getSocialUsersCount(long userId,
int socialRelationType)
throws PortalException
getSocialUsersCount(long,
int, String)
userId - the primary key of the usersocialRelationType - the type of social relation. The possible
types can be found in SocialRelationConstants.
PortalException
public static int getSocialUsersCount(long userId,
int socialRelationType,
String socialRelationTypeComparator)
throws PortalException
userId - the primary key of the usersocialRelationType - the type of social relation. The possible
types can be found in SocialRelationConstants.
PortalException
public static int getSocialUsersCount(long userId1,
long userId2)
throws PortalException
userId1 - the primary key of the first useruserId2 - the primary key of the second user
PortalException
public static int getSocialUsersCount(long userId1,
long userId2,
int socialRelationType)
throws PortalException
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.
PortalExceptionpublic static long[] getTeamPrimaryKeys(long userId)
userId - the userId of the user
public static List<User> getTeamUsers(long teamId)
public static List<User> getTeamUsers(long teamId,
int start,
int end)
public static List<User> getTeamUsers(long teamId,
int start,
int end,
OrderByComparator<User> orderByComparator)
public static int getTeamUsersCount(long teamId)
public static User getUser(long userId)
throws PortalException
userId - the primary key of the user
PortalException - if a user with the primary key could not be found
public static User getUserByContactId(long contactId)
throws PortalException
contactId - the user's contact ID
PortalException
public static User getUserByEmailAddress(long companyId,
String emailAddress)
throws PortalException
companyId - the primary key of the user's companyemailAddress - the user's email address
PortalException
public static User getUserByFacebookId(long companyId,
long facebookId)
throws PortalException
companyId - the primary key of the user's companyfacebookId - the user's Facebook ID
PortalException
public static User getUserById(long companyId,
long userId)
throws PortalException
companyId - the primary key of the user's companyuserId - the primary key of the user
PortalException
public static User getUserById(long userId)
throws PortalException
userId - the primary key of the user
PortalException
public static User getUserByOpenId(long companyId,
String openId)
throws PortalException
companyId - the primary key of the user's companyopenId - the user's OpenID
PortalException
public static User getUserByPortraitId(long portraitId)
throws PortalException
portraitId - the user's portrait ID
PortalException
public static User getUserByScreenName(long companyId,
String screenName)
throws PortalException
companyId - the primary key of the user's companyscreenName - the user's screen name
PortalException
@Deprecated
public static User getUserByUuid(String uuid)
throws PortalException
getUserByUuidAndCompanyId(String, long)
uuid - the user's UUID
PortalException
public static User getUserByUuidAndCompanyId(String uuid,
long companyId)
throws PortalException
uuid - the user's UUIDcompanyId - the primary key of the company
PortalException - if a matching user could not be foundpublic static long[] getUserGroupPrimaryKeys(long userId)
userId - the userId of the user
public static List<User> getUserGroupUsers(long userGroupId)
public static List<User> getUserGroupUsers(long userGroupId,
int start,
int end)
public static List<User> getUserGroupUsers(long userGroupId,
int start,
int end,
OrderByComparator<User> orderByComparator)
public static int getUserGroupUsersCount(long userGroupId)
public static int getUserGroupUsersCount(long userGroupId,
int status)
throws PortalException
userGroupId - the primary key of the user groupstatus - the workflow status
PortalException
public static long getUserIdByEmailAddress(long companyId,
String emailAddress)
throws PortalException
companyId - the primary key of the user's companyemailAddress - the user's email address
PortalException
public static long getUserIdByScreenName(long companyId,
String screenName)
throws PortalException
companyId - the primary key of the user's companyscreenName - the user's screen name
PortalException
public static 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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from UserModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
start - the lower bound of the range of usersend - the upper bound of the range of users (not inclusive)
public static int getUsersCount()
public static boolean hasGroupUser(long groupId,
long userId)
public static boolean hasGroupUsers(long groupId)
public static boolean hasOrganizationUser(long organizationId,
long userId)
public static boolean hasOrganizationUsers(long organizationId)
public static boolean hasPasswordPolicyUser(long passwordPolicyId,
long userId)
true if the password policy has been assigned to the
user.
passwordPolicyId - the primary key of the password policyuserId - the primary key of the user
true if the password policy is assigned to the user;
false otherwise
public static 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.
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
otherwise
PortalException
public static boolean hasRoleUser(long roleId,
long userId)
public static boolean hasRoleUsers(long roleId)
public static boolean hasTeamUser(long teamId,
long userId)
public static boolean hasTeamUsers(long teamId)
public static boolean hasUserGroupUser(long userGroupId,
long userId)
public static boolean hasUserGroupUsers(long userGroupId)
public static boolean isPasswordExpired(User user)
throws PortalException
true if the user's password is expired.
user - the user
true if the user's password is expired;
false otherwise
PortalException
public static boolean isPasswordExpiringSoon(User user)
throws PortalException
true if the password policy is configured to warn
the user that his password is expiring and the remaining time until
expiration is equal or less than the configured warning time.
user - the user
true if the user's password is expiring soon;
false otherwise
PortalException
public static User loadGetDefaultUser(long companyId)
throws PortalException
companyId - the primary key of the company
PortalException
public static 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> obc)
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.
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)obc - the comparator to order the users by (optionally
null)
UserFinder
public static 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.
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). For
more information see UserIndexer.andSearch - whether every field must match its keywords, or just
one field. For example, "users with the first name 'bob' and
last name 'smith'" vs "users with the first name 'bob'
or the last name 'smith'".start - the lower bound of the range of usersend - the upper bound of the range of users (not inclusive)sort - the field and direction to sort by (optionally
null)
UserIndexer
public static 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)
public static List<User> search(long companyId,
String keywords,
int status,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator<User> obc)
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.
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)obc - the comparator to order the users by (optionally
null)
UserFinder
public static 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.
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). For
more information see UserIndexer.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)
UserIndexer
public static Hits search(long companyId,
String keywords,
int status,
LinkedHashMap<String,Object> params,
int start,
int end,
Sort[] sorts)
public static int searchCount(long companyId,
String firstName,
String middleName,
String lastName,
String screenName,
String emailAddress,
int status,
LinkedHashMap<String,Object> params,
boolean andSearch)
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 static int searchCount(long companyId,
String keywords,
int status,
LinkedHashMap<String,Object> params)
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 static Map<Long,Integer> searchCounts(long companyId,
int status,
long[] groupIds)
public static List<User> searchSocial(long companyId,
long[] groupIds,
String keywords,
int start,
int end)
public static List<User> searchSocial(long[] groupIds,
long userId,
int[] socialRelationTypes,
String keywords,
int start,
int end)
throws PortalException
PortalException
public static List<User> searchSocial(long userId,
int[] socialRelationTypes,
String keywords,
int start,
int end)
throws PortalException
PortalException
public static 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
PortalException
public static 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
PortalException
public static BaseModelSearchResult<User> searchUsers(long companyId,
String keywords,
int status,
LinkedHashMap<String,Object> params,
int start,
int end,
Sort sort)
throws PortalException
PortalException
public static BaseModelSearchResult<User> searchUsers(long companyId,
String keywords,
int status,
LinkedHashMap<String,Object> params,
int start,
int end,
Sort[] sorts)
throws PortalException
PortalException
public static void sendEmailAddressVerification(User user,
String emailAddress,
ServiceContext serviceContext)
throws PortalException
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 static 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.
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 applied
PortalException
public static 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.
companyId - the primary key of the user's companyemailAddress - the user's email address
true if the notification email includes a new
password; false if the notification email only
contains a reset link
PortalException
public static 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.
companyId - the primary key of the user's companyscreenName - the user's screen name
true if the notification email includes a new
password; false if the notification email only
contains a reset link
PortalException
public static 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.
userId - the user's primary key
true if the notification email includes a new
password; false if the notification email only
contains a reset link
PortalException
public static void setGroupUsers(long groupId,
long[] userIds)
public static void setOrganizationUsers(long organizationId,
long[] userIds)
public static void setRoleUsers(long roleId,
long[] userIds)
throws PortalException
PortalException
public static void setTeamUsers(long teamId,
long[] userIds)
public static void setUserGroupUsers(long userGroupId,
long[] userIds)
throws PortalException
PortalException
public static void unsetGroupTeamsUsers(long groupId,
long[] userIds)
throws PortalException
groupId - the primary key of the groupuserIds - the primary keys of the users
PortalException
public static void unsetGroupUsers(long groupId,
long[] userIds,
ServiceContext serviceContext)
throws PortalException
groupId - the primary key of the groupuserIds - the primary keys of the usersserviceContext - the service context to be applied (optionally
null)
PortalException
public static void unsetOrganizationUsers(long organizationId,
long[] userIds)
throws PortalException
organizationId - the primary key of the organizationuserIds - the primary keys of the users
PortalException
public static void unsetPasswordPolicyUsers(long passwordPolicyId,
long[] userIds)
passwordPolicyId - the primary key of the password policyuserIds - the primary keys of the users
public static void unsetRoleUsers(long roleId,
long[] userIds)
throws PortalException
roleId - the primary key of the roleuserIds - the primary keys of the users
PortalException
public static void unsetRoleUsers(long roleId,
List<User> users)
throws PortalException
roleId - the primary key of the roleusers - the users
PortalException
public static void unsetTeamUsers(long teamId,
long[] userIds)
throws PortalException
teamId - the primary key of the teamuserIds - the primary keys of the users
PortalException
public static void unsetUserGroupUsers(long userGroupId,
long[] userIds)
throws PortalException
userGroupId - the primary key of the user groupuserIds - the primary keys of the users
PortalException
public static User updateAgreedToTermsOfUse(long userId,
boolean agreedToTermsOfUse)
throws PortalException
userId - the primary key of the useragreedToTermsOfUse - whether the user has agreet to the terms of
use
PortalException
public static void updateAsset(long userId,
User user,
long[] assetCategoryIds,
String[] assetTagNames)
throws PortalException
userId - the primary key of the useruser - ID the primary key of the userassetCategoryIds - the primary key's of the new asset categoriesassetTagNames - the new asset tag names
PortalException
public static User updateCreateDate(long userId,
Date createDate)
throws PortalException
userId - the primary key of the usercreateDate - the new creation date
PortalException
public static User updateEmailAddress(long userId,
String password,
String emailAddress1,
String emailAddress2)
throws PortalException
userId - the primary key of the userpassword - the user's passwordemailAddress1 - the user's new email addressemailAddress2 - the user's new email address confirmation
PortalException
public static User updateEmailAddress(long userId,
String password,
String emailAddress1,
String emailAddress2,
ServiceContext serviceContext)
throws PortalException
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 static User updateEmailAddressVerified(long userId,
boolean emailAddressVerified)
throws PortalException
userId - the primary key of the useremailAddressVerified - whether the user has verified email address
PortalException
public static User updateFacebookId(long userId,
long facebookId)
throws PortalException
userId - the primary key of the userfacebookId - the user's new Facebook ID
PortalException
public static void updateGroups(long userId,
long[] newGroupIds,
ServiceContext serviceContext)
throws PortalException
userId - the primary key of the usernewGroupIds - the primary keys of the groupsserviceContext - the service context to be applied (optionally
null)
PortalException
public static 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
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 static User updateJobTitle(long userId,
String jobTitle)
throws PortalException
userId - the primary key of the userjobTitle - the user's job title
PortalException
public static User updateLastLogin(long userId,
String loginIP)
throws PortalException
userId - the primary key of the userloginIP - the IP address the user logged in from
PortalException
public static User updateLockout(User user,
boolean lockout)
throws PortalException
user - the userlockout - whether the user is locked out
PortalException
public static User updateLockoutByEmailAddress(long companyId,
String emailAddress,
boolean lockout)
throws PortalException
companyId - the primary key of the user's companyemailAddress - the user's email addresslockout - whether the user is locked out
PortalException
public static User updateLockoutById(long userId,
boolean lockout)
throws PortalException
userId - the primary key of the userlockout - whether the user is locked out
PortalException
public static User updateLockoutByScreenName(long companyId,
String screenName,
boolean lockout)
throws PortalException
companyId - the primary key of the user's companyscreenName - the user's screen namelockout - whether the user is locked out
PortalException
public static User updateModifiedDate(long userId,
Date modifiedDate)
throws PortalException
userId - the primary key of the usermodifiedDate - the new modified date
PortalException
public static User updateOpenId(long userId,
String openId)
throws PortalException
userId - the primary key of the useropenId - the new OpenID
PortalException
public static void updateOrganizations(long userId,
long[] newOrganizationIds,
ServiceContext serviceContext)
throws PortalException
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 static User updatePassword(long userId,
String password1,
String password2,
boolean passwordReset)
throws PortalException
userId - the primary key of the userpassword1 - the user's new passwordpassword2 - the user's new password confirmationpasswordReset - whether the user should be asked to reset their
password the next time they log in
PortalException
public static User updatePassword(long userId,
String password1,
String password2,
boolean passwordReset,
boolean silentUpdate)
throws PortalException
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 static User updatePasswordManually(long userId,
String password,
boolean passwordEncrypted,
boolean passwordReset,
Date passwordModifiedDate)
throws PortalException
userId - the primary key of the userpassword - the user's new passwordpasswordEncrypted - the user's new encrypted passwordpasswordReset - whether the user should be asked to reset their
password the next time they loginpasswordModifiedDate - the new password modified date
PortalException
public static User updatePasswordReset(long userId,
boolean passwordReset)
throws PortalException
userId - the primary key of the userpasswordReset - whether the user should be asked to reset their
password the next time they login
PortalException
public static User updatePortrait(long userId,
byte[] bytes)
throws PortalException
userId - the primary key of the userbytes - the new portrait image data
PortalException
public static User updateReminderQuery(long userId,
String question,
String answer)
throws PortalException
userId - the primary key of the userquestion - the user's new password reset questionanswer - the user's new password reset answer
PortalException
public static User updateScreenName(long userId,
String screenName)
throws PortalException
userId - the primary key of the userscreenName - the user's new screen name
PortalException
@Deprecated
public static User updateStatus(long userId,
int status)
throws PortalException
updateStatus(long, int,
ServiceContext)
userId - the primary key of the userstatus - the user's new workflow status
PortalException
public static User updateStatus(long userId,
int status,
ServiceContext serviceContext)
throws PortalException
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.
PortalExceptionpublic static User updateUser(User user)
user - the user
@Deprecated
public static User updateUser(long userId,
String oldPassword,
String newPassword1,
String newPassword2,
boolean passwordReset,
String reminderQueryQuestion,
String reminderQueryAnswer,
String screenName,
String emailAddress,
long facebookId,
String openId,
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,
long, String, boolean, byte[], String, String, String,
String, String, String, String, int, int, boolean, int, int,
int, String, String, String, String, String, String, String,
String, String, String, String, long[], long[], long[], List,
long[], ServiceContext)
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 OpenIDlanguageId - 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 static 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 portrait,
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
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 OpenIDportrait - whether to update the user's 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 static void verifyEmailAddress(String ticketKey)
throws PortalException
ticketKey - the ticket key
PortalExceptionpublic static UserLocalService getService()
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||