Class UserServiceUtil
com.liferay.portal.service.impl.UserServiceImpl
and is an
access point for service operations in application layer code running on a
remote server. Methods of this service are expected to have security checks
based on the propagated JAAS credentials because this service can be
accessed remotely.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic void
addGroupUsers
(long groupId, long[] userIds, ServiceContext serviceContext) Adds the users to the group.static void
addOrganizationUsers
(long organizationId, long[] userIds) Adds the users to the organization.static User
addOrUpdateUser
(String externalReferenceCode, long creatorUserId, long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, List<Address> addresses, List<EmailAddress> emailAddresses, List<Phone> phones, List<Website> websites, boolean sendEmail, ServiceContext serviceContext) static void
addPasswordPolicyUsers
(long passwordPolicyId, long[] userIds) Assigns the password policy to the users, removing any other currently assigned password policies.static void
addRoleUsers
(long roleId, long[] userIds) Adds the users to the role.static void
addTeamUsers
(long teamId, long[] userIds) Adds the users to the team.static User
addUser
(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 prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, ServiceContext serviceContext) Deprecated.static User
addUser
(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 prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, List<Address> addresses, List<EmailAddress> emailAddresses, List<Phone> phones, List<Website> websites, List<AnnouncementsDelivery> announcementsDelivers, boolean sendEmail, ServiceContext serviceContext) static User
addUser
(long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, ServiceContext serviceContext) Adds a user.static User
addUser
(long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, List<Address> addresses, List<EmailAddress> emailAddresses, List<Phone> phones, List<Website> websites, List<AnnouncementsDelivery> announcementsDelivers, boolean sendEmail, ServiceContext serviceContext) Adds a user with additional parameters.static void
addUserGroupUsers
(long userGroupId, long[] userIds) Adds the users to the user group.static User
addUserWithWorkflow
(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 prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, ServiceContext serviceContext) static User
addUserWithWorkflow
(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 prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, List<Address> addresses, List<EmailAddress> emailAddresses, List<Phone> phones, List<Website> websites, List<AnnouncementsDelivery> announcementsDelivers, boolean sendEmail, ServiceContext serviceContext) static User
addUserWithWorkflow
(long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, ServiceContext serviceContext) Adds a user with workflow.static User
addUserWithWorkflow
(long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, List<Address> addresses, List<EmailAddress> emailAddresses, List<Phone> phones, List<Website> websites, List<AnnouncementsDelivery> announcementsDelivers, boolean sendEmail, ServiceContext serviceContext) Adds a user with workflow and additional parameters.static void
deletePortrait
(long userId) Deletes the user's portrait image.static void
deleteRoleUser
(long roleId, long userId) Removes the user from the role.static void
deleteUser
(long userId) Deletes the user.static User
fetchUserByExternalReferenceCode
(String externalReferenceCode, long companyId) getCompanyUsers
(long companyId, int start, int end) static int
getCompanyUsersCount
(long companyId) static User
static long[]
getGroupUserIds
(long groupId) Returns the primary keys of all the users belonging to the group.getGroupUsers
(long groupId) Returns all the users belonging to the group.getGroupUsers
(long groupId, int status, int start, int end, OrderByComparator<User> orderByComparator) Returns the users belonging to a group.getGroupUsers
(long groupId, int status, OrderByComparator<User> orderByComparator) Returns the users belonging to a group.static int
getGroupUsersCount
(long groupId, int status) Returns the number of users with the status belonging to the group.getGtCompanyUsers
(long gtUserId, long companyId, int size) getGtOrganizationUsers
(long gtUserId, long organizationId, int size) getGtUserGroupUsers
(long gtUserId, long userGroupId, int size) static int
getOrganizationsAndUserGroupsUsersCount
(long[] organizationIds, long[] userGroupIds) static long[]
getOrganizationUserIds
(long organizationId) Returns the primary keys of all the users belonging to the organization.getOrganizationUsers
(long organizationId) Returns all the users belonging to the organization.getOrganizationUsers
(long organizationId, int status, int start, int end, OrderByComparator<User> orderByComparator) Returns the users belonging to the organization with the status.getOrganizationUsers
(long organizationId, int status, OrderByComparator<User> orderByComparator) Returns the users belonging to the organization with the status.static int
getOrganizationUsersCount
(long organizationId, int status) Returns the number of users with the status belonging to the organization.static String
Returns the OSGi service identifier.static long[]
getRoleUserIds
(long roleId) Returns the primary keys of all the users belonging to the role.static UserService
static User
getUserByEmailAddress
(long companyId, String emailAddress) Returns the user with the email address.static User
getUserByExternalReferenceCode
(long companyId, String externalReferenceCode) Returns the user with the external reference code.static User
getUserByExternalReferenceCode
(String externalReferenceCode, long companyId) static User
getUserById
(long userId) Returns the user with the primary key.static User
getUserByScreenName
(long companyId, String screenName) Returns the user with the screen name.getUserGroupUsers
(long userGroupId) getUserGroupUsers
(long userGroupId, int start, int end) 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 boolean
hasGroupUser
(long groupId, long userId) Returnstrue
if the user is a member of the group.static boolean
hasRoleUser
(long roleId, long userId) Returnstrue
if the user is a member of the role.static boolean
hasRoleUser
(long companyId, String name, long userId, boolean inherited) Returnstrue
if the user has the role with the name, optionally through inheritance.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
setRoleUsers
(long roleId, long[] userIds) Sets the users in the role, removing and adding users to the role as necessary.static void
setService
(UserService service) static void
setUserGroupUsers
(long userGroupId, long[] userIds) Sets the users in the user group, removing and adding users to the user group as necessary.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, 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 the user's response to the terms of use agreement.static User
updateEmailAddress
(long userId, String password, String emailAddress1, String emailAddress2, ServiceContext serviceContext) Updates the user's email address.static User
updateExternalReferenceCode
(long userId, String externalReferenceCode) static User
updateExternalReferenceCode
(User user, String externalReferenceCode) static User
updateIncompleteUser
(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 prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, boolean updateUserInformation, boolean sendEmail, ServiceContext serviceContext) Deprecated.As of Athanasius (7.3.x), replaced by#updateIncompleteUser(long, long, boolean, String, String, boolean, String, String, Locale, String, String, String, long, long, boolean, int, int, int, String, boolean, boolean, ServiceContext)
static User
updateIncompleteUser
(long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, boolean updateUserInformation, boolean sendEmail, ServiceContext serviceContext) Updates a user account that was automatically created when a guest user participated in an action (e.g. posting a comment) and only provided his name and email address.static User
updateLanguageId
(long userId, String languageId) static User
updateLockoutById
(long userId, boolean lockout) Updates whether the user is locked out from logging in.static User
updateOpenId
(long userId, String openId) Deprecated.As of Athanasius (7.3.x), with no direct replacementstatic void
updateOrganizations
(long userId, long[] organizationIds, 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
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, ServiceContext serviceContext) Updates the user's workflow status.static User
updateStatus
(User user, int status, ServiceContext serviceContext) static User
updateUser
(long userId, String oldPassword, String newPassword1, String newPassword2, boolean passwordReset, String reminderQueryQuestion, String reminderQueryAnswer, String screenName, String emailAddress, boolean hasPortrait, byte[] portraitBytes, String languageId, String timeZoneId, String greeting, String comments, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String smsSn, String facebookSn, String jabberSn, String skypeSn, String twitterSn, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, List<UserGroupRole> userGroupRoles, long[] userGroupIds, List<Address> addresses, List<EmailAddress> emailAddresses, List<Phone> phones, List<Website> websites, List<AnnouncementsDelivery> announcementsDelivers, ServiceContext serviceContext) Updates the user with additional parameters.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 hasPortrait, byte[] portraitBytes, String languageId, String timeZoneId, String greeting, String comments, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String smsSn, String facebookSn, String jabberSn, String skypeSn, String twitterSn, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, List<UserGroupRole> userGroupRoles, long[] userGroupIds, List<Address> addresses, List<EmailAddress> emailAddresses, List<Phone> phones, List<Website> websites, List<AnnouncementsDelivery> announcementsDelivers, ServiceContext serviceContext) Deprecated.As of Athanasius (7.3.x), replaced byupdateUser(long, String, String, String, boolean, String, String, String, String, boolean, byte[], String, String, String, String, String, String, String, long, long, boolean, int, int, int, String, String, String, String, String, String, long[], long[], long[], List, long[], List, List, List, List, List, ServiceContext)
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 prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String smsSn, String facebookSn, String jabberSn, String skypeSn, String twitterSn, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, List<UserGroupRole> userGroupRoles, long[] userGroupIds, ServiceContext serviceContext) Deprecated.As of Athanasius (7.3.x), replaced byupdateUser(long, String, String, String, boolean, String, String, String, String, String, String, String, String, String, String, String, long, long, boolean, int, int, int, String, String, String, String, String, String, long[], long[], long[], List, long[], ServiceContext)
static User
updateUser
(long userId, String oldPassword, String newPassword1, String newPassword2, boolean passwordReset, String reminderQueryQuestion, String reminderQueryAnswer, String screenName, String emailAddress, String languageId, String timeZoneId, String greeting, String comments, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String smsSn, String facebookSn, String jabberSn, String skypeSn, String twitterSn, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, List<UserGroupRole> userGroupRoles, long[] userGroupIds, ServiceContext serviceContext) Updates the user.
-
Constructor Details
-
UserServiceUtil
public UserServiceUtil()
-
-
Method Details
-
addGroupUsers
public static void addGroupUsers(long groupId, long[] userIds, ServiceContext serviceContext) throws PortalException Adds the users to the group.- Parameters:
groupId
- the primary key of the groupuserIds
- the primary keys of the usersserviceContext
- the service context to be applied (optionallynull
)- Throws:
PortalException
-
addOrganizationUsers
Adds the users to the organization.- Parameters:
organizationId
- the primary key of the organizationuserIds
- the primary keys of the users- Throws:
PortalException
-
addOrUpdateUser
public static User addOrUpdateUser(String externalReferenceCode, long creatorUserId, long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, List<Address> addresses, List<EmailAddress> emailAddresses, List<Phone> phones, List<Website> websites, boolean sendEmail, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
addPasswordPolicyUsers
public static void addPasswordPolicyUsers(long passwordPolicyId, long[] userIds) throws PortalException Assigns the password policy to the users, removing any other currently assigned password policies.- Parameters:
passwordPolicyId
- the primary key of the password policyuserIds
- the primary keys of the users- Throws:
PortalException
-
addRoleUsers
Adds the users to the role.- Parameters:
roleId
- the primary key of the roleuserIds
- the primary keys of the users- Throws:
PortalException
-
addTeamUsers
Adds the users to the team.- Parameters:
teamId
- the primary key of the teamuserIds
- the primary keys of the users- Throws:
PortalException
-
addUser
public static User addUser(long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, ServiceContext serviceContext) throws PortalException Adds a user.This method handles the creation and bookkeeping of the user including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, etc.
- Parameters:
companyId
- the primary key of the user's companyautoPassword
- whether a password should be automatically generated for the userpassword1
- the user's passwordpassword2
- the user's password confirmationautoScreenName
- whether a screen name should be automatically generated for the userscreenName
- the user's screen nameemailAddress
- the user's email addresslocale
- the user's localefirstName
- the user's first namemiddleName
- the user's middle namelastName
- the user's last nameprefixListTypeId
- the user's name prefix IDsuffixListTypeId
- the user's name suffix IDmale
- whether the user is malebirthdayMonth
- the user's birthday month (0-based, meaning 0 for January)birthdayDay
- the user's birthday daybirthdayYear
- the user's birthday yearjobTitle
- the user's job 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 (optionallynull
). Can set the UUID (with theuuid
attribute), asset category IDs, asset tag names, and expando bridge attributes for the user.- Returns:
- the new user
- Throws:
PortalException
-
addUser
public static User addUser(long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, List<Address> addresses, List<EmailAddress> emailAddresses, List<Phone> phones, List<Website> websites, List<AnnouncementsDelivery> announcementsDelivers, boolean sendEmail, ServiceContext serviceContext) throws PortalException Adds a user with additional parameters.This method handles the creation and bookkeeping of the user including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, etc.
- Parameters:
companyId
- the primary key of the user's companyautoPassword
- whether a password should be automatically generated for the userpassword1
- the user's passwordpassword2
- the user's password confirmationautoScreenName
- whether a screen name should be automatically generated for the userscreenName
- the user's screen nameemailAddress
- the user's email addresslocale
- the user's localefirstName
- the user's first namemiddleName
- the user's middle namelastName
- the user's last nameprefixListTypeId
- the user's name prefix IDsuffixListTypeId
- the user's name suffix IDmale
- whether the user is malebirthdayMonth
- the user's birthday month (0-based, meaning 0 for January)birthdayDay
- the user's birthday daybirthdayYear
- the user's birthday yearjobTitle
- the user's job 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 groupsaddresses
- the user's addressesemailAddresses
- the user's email addressesphones
- the user's phone numberswebsites
- the user's websitesannouncementsDelivers
- the announcements deliveriessendEmail
- whether to send the user an email notification about their new accountserviceContext
- the service context to be applied (optionallynull
). Can set the UUID (with theuuid
attribute), asset category IDs, asset tag names, and expando bridge attributes for the user.- Returns:
- the new user
- Throws:
PortalException
-
addUser
@Deprecated public static User addUser(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 prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, ServiceContext serviceContext) throws PortalException Deprecated.Adds a user.This method handles the creation and bookkeeping of the user including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, etc.
- Parameters:
companyId
- 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 nameprefixListTypeId
- the user's name prefix IDsuffixListTypeId
- the user's name suffix IDmale
- whether the user is malebirthdayMonth
- the user's birthday month (0-based, meaning 0 for January)birthdayDay
- the user's birthday daybirthdayYear
- the user's birthday yearjobTitle
- the user's job 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 (optionallynull
). Can set the UUID (with theuuid
attribute), asset category IDs, asset tag names, and expando bridge attributes for the user.- Returns:
- the new user
- Throws:
PortalException
-
addUser
@Deprecated public static User addUser(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 prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, List<Address> addresses, List<EmailAddress> emailAddresses, List<Phone> phones, List<Website> websites, List<AnnouncementsDelivery> announcementsDelivers, boolean sendEmail, ServiceContext serviceContext) throws PortalException Deprecated.Adds a user with additional parameters.This method handles the creation and bookkeeping of the user including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, etc.
- Parameters:
companyId
- 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 nameprefixListTypeId
- the user's name prefix IDsuffixListTypeId
- the user's name suffix IDmale
- whether the user is malebirthdayMonth
- the user's birthday month (0-based, meaning 0 for January)birthdayDay
- the user's birthday daybirthdayYear
- the user's birthday yearjobTitle
- the user's job 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 groupsaddresses
- the user's addressesemailAddresses
- the user's email addressesphones
- the user's phone numberswebsites
- the user's websitesannouncementsDelivers
- the announcements deliveriessendEmail
- whether to send the user an email notification about their new accountserviceContext
- the service context to be applied (optionallynull
). Can set the UUID (with theuuid
attribute), asset category IDs, asset tag names, and expando bridge attributes for the user.- Returns:
- the new user
- Throws:
PortalException
-
addUserGroupUsers
Adds the users to the user group.- Parameters:
userGroupId
- the primary key of the user groupuserIds
- the primary keys of the users- Throws:
PortalException
-
addUserWithWorkflow
public static User addUserWithWorkflow(long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, ServiceContext serviceContext) throws PortalException Adds a user with workflow.This method handles the creation and bookkeeping of the user including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, etc.
- Parameters:
companyId
- the primary key of the user's companyautoPassword
- whether a password should be automatically generated for the userpassword1
- the user's passwordpassword2
- the user's password confirmationautoScreenName
- whether a screen name should be automatically generated for the userscreenName
- the user's screen nameemailAddress
- the user's email addresslocale
- the user's localefirstName
- the user's first namemiddleName
- the user's middle namelastName
- the user's last nameprefixListTypeId
- the user's name prefix IDsuffixListTypeId
- the user's name suffix IDmale
- whether the user is malebirthdayMonth
- the user's birthday month (0-based, meaning 0 for January)birthdayDay
- the user's birthday daybirthdayYear
- the user's birthday yearjobTitle
- the user's job 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 (optionallynull
). Can set the UUID (with theuuid
attribute), asset category IDs, asset tag names, and expando bridge attributes for the user.- Returns:
- the new user
- Throws:
PortalException
-
addUserWithWorkflow
public static User addUserWithWorkflow(long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, List<Address> addresses, List<EmailAddress> emailAddresses, List<Phone> phones, List<Website> websites, List<AnnouncementsDelivery> announcementsDelivers, boolean sendEmail, ServiceContext serviceContext) throws PortalException Adds a user with workflow and additional parameters.This method handles the creation and bookkeeping of the user including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, etc.
- Parameters:
companyId
- the primary key of the user's companyautoPassword
- whether a password should be automatically generated for the userpassword1
- the user's passwordpassword2
- the user's password confirmationautoScreenName
- whether a screen name should be automatically generated for the userscreenName
- the user's screen nameemailAddress
- the user's email addresslocale
- the user's localefirstName
- the user's first namemiddleName
- the user's middle namelastName
- the user's last nameprefixListTypeId
- the user's name prefix IDsuffixListTypeId
- the user's name suffix IDmale
- whether the user is malebirthdayMonth
- the user's birthday month (0-based, meaning 0 for January)birthdayDay
- the user's birthday daybirthdayYear
- the user's birthday yearjobTitle
- the user's job 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 groupsaddresses
- the user's addressesemailAddresses
- the user's email addressesphones
- the user's phone numberswebsites
- the user's websitesannouncementsDelivers
- the announcements deliveriessendEmail
- whether to send the user an email notification about their new accountserviceContext
- the service context to be applied (optionallynull
). Can set the UUID (with theuuid
attribute), asset category IDs, asset tag names, and expando bridge attributes for the user.- Returns:
- the new user
- Throws:
PortalException
-
addUserWithWorkflow
@Deprecated public static User addUserWithWorkflow(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 prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, ServiceContext serviceContext) throws PortalException Deprecated.Adds a user with workflow.This method handles the creation and bookkeeping of the user including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, etc.
- Parameters:
companyId
- 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 nameprefixListTypeId
- the user's name prefix IDsuffixListTypeId
- the user's name suffix IDmale
- whether the user is malebirthdayMonth
- the user's birthday month (0-based, meaning 0 for January)birthdayDay
- the user's birthday daybirthdayYear
- the user's birthday yearjobTitle
- the user's job 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 (optionallynull
). Can set the UUID (with theuuid
attribute), asset category IDs, asset tag names, and expando bridge attributes for the user.- Returns:
- the new user
- Throws:
PortalException
-
addUserWithWorkflow
@Deprecated public static User addUserWithWorkflow(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 prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, List<Address> addresses, List<EmailAddress> emailAddresses, List<Phone> phones, List<Website> websites, List<AnnouncementsDelivery> announcementsDelivers, boolean sendEmail, ServiceContext serviceContext) throws PortalException Deprecated.Adds a user with workflow and additional parameters.This method handles the creation and bookkeeping of the user including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, etc.
- Parameters:
companyId
- 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 nameprefixListTypeId
- the user's name prefix IDsuffixListTypeId
- the user's name suffix IDmale
- whether the user is malebirthdayMonth
- the user's birthday month (0-based, meaning 0 for January)birthdayDay
- the user's birthday daybirthdayYear
- the user's birthday yearjobTitle
- the user's job 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 groupsaddresses
- the user's addressesemailAddresses
- the user's email addressesphones
- the user's phone numberswebsites
- the user's websitesannouncementsDelivers
- the announcements deliveriessendEmail
- whether to send the user an email notification about their new accountserviceContext
- the service context to be applied (optionallynull
). Can set the UUID (with theuuid
attribute), asset category IDs, asset tag names, and expando bridge attributes for the user.- Returns:
- the new user
- Throws:
PortalException
-
deletePortrait
Deletes the user's portrait image.- Parameters:
userId
- the primary key of the user- Throws:
PortalException
-
deleteRoleUser
Removes the user from the role.- Parameters:
roleId
- the primary key of the roleuserId
- the primary key of the user- Throws:
PortalException
-
deleteUser
Deletes the user.- Parameters:
userId
- the primary key of the user- Throws:
PortalException
-
fetchUserByExternalReferenceCode
public static User fetchUserByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Throws:
PortalException
-
getCompanyUsers
- Throws:
PortalException
-
getCompanyUsersCount
- Throws:
PortalException
-
getCurrentUser
- Throws:
PortalException
-
getGroupUserIds
Returns the primary keys of all the users belonging to the group.- Parameters:
groupId
- the primary key of the group- Returns:
- the primary keys of the users belonging to the group
- Throws:
PortalException
-
getGroupUsers
Returns all the users belonging to the group.- Parameters:
groupId
- the primary key of the group- Returns:
- the users belonging to the group
- Throws:
PortalException
-
getGroupUsers
public static List<User> getGroupUsers(long groupId, int status, int start, int end, OrderByComparator<User> orderByComparator) throws PortalException Returns the users belonging to a group.- Parameters:
groupId
- the primary key of the groupstatus
- the workflow statusstart
- the lower bound of the range of usersend
- the upper bound of the range of users (not inclusive)orderByComparator
- the comparator to order the users by (optionallynull
)- Returns:
- the matching users
- Throws:
PortalException
-
getGroupUsers
public static List<User> getGroupUsers(long groupId, int status, OrderByComparator<User> orderByComparator) throws PortalException Returns the users belonging to a group.- Parameters:
groupId
- the primary key of the groupstatus
- the workflow statusorderByComparator
- the comparator to order the users by (optionallynull
)- Returns:
- the matching users
- Throws:
PortalException
-
getGroupUsersCount
Returns the number of users with the status belonging to the group.- Parameters:
groupId
- the primary key of the groupstatus
- the workflow status- Returns:
- the number of users with the status belonging to the group
- Throws:
PortalException
-
getGtCompanyUsers
public static List<User> getGtCompanyUsers(long gtUserId, long companyId, int size) throws PortalException - Throws:
PortalException
-
getGtOrganizationUsers
public static List<User> getGtOrganizationUsers(long gtUserId, long organizationId, int size) throws PortalException - Throws:
PortalException
-
getGtUserGroupUsers
public static List<User> getGtUserGroupUsers(long gtUserId, long userGroupId, int size) throws PortalException - Throws:
PortalException
-
getOrganizationsAndUserGroupsUsersCount
public static int getOrganizationsAndUserGroupsUsersCount(long[] organizationIds, long[] userGroupIds) throws PrincipalException - Throws:
PrincipalException
-
getOrganizationUserIds
Returns the primary keys of all the users belonging to the organization.- Parameters:
organizationId
- the primary key of the organization- Returns:
- the primary keys of the users belonging to the organization
- Throws:
PortalException
-
getOrganizationUsers
Returns all the users belonging to the organization.- Parameters:
organizationId
- the primary key of the organization- Returns:
- users belonging to the organization
- Throws:
PortalException
-
getOrganizationUsers
public static List<User> getOrganizationUsers(long organizationId, int status, int start, int end, OrderByComparator<User> orderByComparator) throws PortalException Returns the users belonging to the organization with the status.- Parameters:
organizationId
- the primary key of the organizationstatus
- the workflow statusstart
- the lower bound of the range of usersend
- the upper bound of the range of users (not inclusive)orderByComparator
- the comparator to order the users by (optionallynull
)- Returns:
- the matching users
- Throws:
PortalException
-
getOrganizationUsers
public static List<User> getOrganizationUsers(long organizationId, int status, OrderByComparator<User> orderByComparator) throws PortalException Returns the users belonging to the organization with the status.- Parameters:
organizationId
- the primary key of the organizationstatus
- the workflow statusorderByComparator
- the comparator to order the users by (optionallynull
)- Returns:
- the matching users
- Throws:
PortalException
-
getOrganizationUsersCount
Returns the number of users with the status belonging to the organization.- Parameters:
organizationId
- the primary key of the organizationstatus
- the workflow status- Returns:
- the number of users with the status belonging to the organization
- Throws:
PortalException
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getRoleUserIds
Returns the primary keys of all the users belonging to the role.- Parameters:
roleId
- the primary key of the role- Returns:
- the primary keys of the users belonging to the role
- Throws:
PortalException
-
getUserByEmailAddress
public static User getUserByEmailAddress(long companyId, String emailAddress) throws PortalException Returns the user with the email address.- Parameters:
companyId
- the primary key of the user's companyemailAddress
- the user's email address- Returns:
- the user with the email address
- Throws:
PortalException
-
getUserByExternalReferenceCode
public static User getUserByExternalReferenceCode(long companyId, String externalReferenceCode) throws PortalException Returns the user with the external reference code.- Parameters:
companyId
- the primary key of the user's companyexternalReferenceCode
- the user's external reference code- Returns:
- the user with the external reference code
- Throws:
PortalException
-
getUserByExternalReferenceCode
public static User getUserByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Throws:
PortalException
-
getUserById
Returns the user with the primary key.- Parameters:
userId
- the primary key of the user- Returns:
- the user with the primary key
- Throws:
PortalException
-
getUserByScreenName
Returns the user with the screen name.- Parameters:
companyId
- the primary key of the user's companyscreenName
- the user's screen name- Returns:
- the user with the screen name
- Throws:
PortalException
-
getUserGroupUsers
- Throws:
PortalException
-
getUserGroupUsers
public static List<User> getUserGroupUsers(long userGroupId, int start, int end) throws PortalException - Throws:
PortalException
-
getUserIdByEmailAddress
public static long getUserIdByEmailAddress(long companyId, String emailAddress) throws PortalException Returns the primary key of the user with the email address.- Parameters:
companyId
- the primary key of the user's companyemailAddress
- the user's email address- Returns:
- the primary key of the user with the email address
- Throws:
PortalException
-
getUserIdByScreenName
Returns the primary key of the user with the screen name.- Parameters:
companyId
- the primary key of the user's companyscreenName
- the user's screen name- Returns:
- the primary key of the user with the screen name
- Throws:
PortalException
-
hasGroupUser
Returnstrue
if the user is a member of the group.- Parameters:
groupId
- the primary key of the groupuserId
- the primary key of the user- Returns:
true
if the user is a member of the group;false
otherwise- Throws:
PortalException
-
hasRoleUser
Returnstrue
if the user is a member of the role.- Parameters:
roleId
- the primary key of the roleuserId
- the primary key of the user- Returns:
true
if the user is a member of the role;false
otherwise- Throws:
PortalException
-
hasRoleUser
public static boolean hasRoleUser(long companyId, String name, long userId, boolean inherited) throws PortalException Returnstrue
if the user has the role with the name, optionally through inheritance.- Parameters:
companyId
- the primary key of the role's companyname
- the name of the role (must be a regular role, not an organization, site or provider role)userId
- the primary key of the userinherited
- whether to include roles inherited from organizations, sites, etc.- Returns:
true
if the user has the role;false
otherwise- Throws:
PortalException
-
sendPasswordByEmailAddress
public static boolean sendPasswordByEmailAddress(long companyId, String emailAddress) throws PortalException Sends a password notification email to the user matching the email address. The portal's settings determine whether a password is sent explicitly or whether a link for resetting the user's password is sent. The method sends the email asynchronously and returns before the email is sent.The content of the notification email is specified with the
admin.email.password
portal property keys. They can be overridden via aportal-ext.properties
file or modified through the Portal Settings UI.- Parameters:
companyId
- the primary key of the user's companyemailAddress
- the user's email address- Returns:
true
if the notification email includes a new password;false
if the notification email only contains a reset link- Throws:
PortalException
-
sendPasswordByScreenName
public static boolean sendPasswordByScreenName(long companyId, String screenName) throws PortalException Sends a password notification email to the user matching the screen name. The portal's settings determine whether a password is sent explicitly or whether a link for resetting the user's password is sent. The method sends the email asynchronously and returns before the email is sent.The content of the notification email is specified with the
admin.email.password
portal property keys. They can be overridden via aportal-ext.properties
file or modified through the Portal Settings UI.- Parameters:
companyId
- the primary key of the user's companyscreenName
- the user's screen name- Returns:
true
if the notification email includes a new password;false
if the notification email only contains a reset link- Throws:
PortalException
-
sendPasswordByUserId
Sends a password notification email to the user matching the ID. The portal's settings determine whether a password is sent explicitly or whether a link for resetting the user's password is sent. The method sends the email asynchronously and returns before the email is sent.The content of the notification email is specified with the
admin.email.password
portal property keys. They can be overridden via aportal-ext.properties
file or modified through the Portal Settings UI.- Parameters:
userId
- the user's primary key- Returns:
true
if the notification email includes a new password;false
if the notification email only contains a reset link- Throws:
PortalException
-
setRoleUsers
Sets the users in the role, removing and adding users to the role as necessary.- Parameters:
roleId
- the primary key of the roleuserIds
- the primary keys of the users- Throws:
PortalException
-
setUserGroupUsers
Sets the users in the user group, removing and adding users to the user group as necessary.- Parameters:
userGroupId
- the primary key of the user groupuserIds
- the primary keys of the users- Throws:
PortalException
-
unsetGroupTeamsUsers
Removes the users from the teams of a group.- Parameters:
groupId
- the primary key of the groupuserIds
- the primary keys of the users- Throws:
PortalException
-
unsetGroupUsers
public static void unsetGroupUsers(long groupId, long[] userIds, ServiceContext serviceContext) throws PortalException Removes the users from the group.- Parameters:
groupId
- the primary key of the groupuserIds
- the primary keys of the usersserviceContext
- the service context to be applied (optionallynull
)- Throws:
PortalException
-
unsetOrganizationUsers
public static void unsetOrganizationUsers(long organizationId, long[] userIds) throws PortalException Removes the users from the organization.- Parameters:
organizationId
- the primary key of the organizationuserIds
- the primary keys of the users- Throws:
PortalException
-
unsetPasswordPolicyUsers
public static void unsetPasswordPolicyUsers(long passwordPolicyId, long[] userIds) throws PortalException Removes the users from the password policy.- Parameters:
passwordPolicyId
- the primary key of the password policyuserIds
- the primary keys of the users- Throws:
PortalException
-
unsetRoleUsers
Removes the users from the role.- Parameters:
roleId
- the primary key of the roleuserIds
- the primary keys of the users- Throws:
PortalException
-
unsetTeamUsers
Removes the users from the team.- Parameters:
teamId
- the primary key of the teamuserIds
- the primary keys of the users- Throws:
PortalException
-
unsetUserGroupUsers
Removes the users from the user group.- Parameters:
userGroupId
- the primary key of the user groupuserIds
- the primary keys of the users- Throws:
PortalException
-
updateAgreedToTermsOfUse
public static User updateAgreedToTermsOfUse(long userId, boolean agreedToTermsOfUse) throws PortalException Updates the user's response to the terms of use agreement.- Parameters:
userId
- the primary key of the useragreedToTermsOfUse
- whether the user has agree to the terms of use- Returns:
- the user
- Throws:
PortalException
-
updateEmailAddress
public static User updateEmailAddress(long userId, String password, String emailAddress1, String emailAddress2, ServiceContext serviceContext) throws PortalException Updates the user's email address.- Parameters:
userId
- the primary key of the userpassword
- the user's passwordemailAddress1
- the user's new email addressemailAddress2
- the user's new email address confirmationserviceContext
- the service context to be applied. Must set the portal URL, main path, primary key of the layout, remote address, remote host, and agent for the user.- Returns:
- the user
- Throws:
PortalException
-
updateExternalReferenceCode
public static User updateExternalReferenceCode(long userId, String externalReferenceCode) throws PortalException - Throws:
PortalException
-
updateExternalReferenceCode
public static User updateExternalReferenceCode(User user, String externalReferenceCode) throws PortalException - Throws:
PortalException
-
updateIncompleteUser
public static User updateIncompleteUser(long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, boolean updateUserInformation, boolean sendEmail, ServiceContext serviceContext) throws PortalException Updates a user account that was automatically created when a guest user participated in an action (e.g. posting a comment) and only provided his name and email address.- Parameters:
companyId
- the primary key of the user's companyautoPassword
- whether a password should be automatically generated for the userpassword1
- the user's passwordpassword2
- the user's password confirmationautoScreenName
- whether a screen name should be automatically generated for the userscreenName
- the user's screen nameemailAddress
- the user's email addresslocale
- the user's localefirstName
- the user's first namemiddleName
- the user's middle namelastName
- the user's last nameprefixListTypeId
- the user's name prefix IDsuffixListTypeId
- the user's name suffix IDmale
- whether the user is malebirthdayMonth
- the user's birthday month (0-based, meaning 0 for January)birthdayDay
- the user's birthday daybirthdayYear
- the user's birthday yearjobTitle
- the user's job titleupdateUserInformation
- whether to update the user's informationsendEmail
- whether to send the user an email notification about their new accountserviceContext
- the service context to be applied (optionallynull
). Can set the expando bridge attributes for the user.- Returns:
- the user
- Throws:
PortalException
-
updateIncompleteUser
@Deprecated public static User updateIncompleteUser(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 prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, boolean updateUserInformation, boolean sendEmail, ServiceContext serviceContext) throws PortalException Deprecated.As of Athanasius (7.3.x), replaced by#updateIncompleteUser(long, long, boolean, String, String, boolean, String, String, Locale, String, String, String, long, long, boolean, int, int, int, String, boolean, boolean, 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.- Parameters:
companyId
- 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 nameprefixListTypeId
- the user's name prefix IDsuffixListTypeId
- the user's name suffix IDmale
- whether the user is malebirthdayMonth
- the user's birthday month (0-based, meaning 0 for January)birthdayDay
- the user's birthday daybirthdayYear
- the user's birthday yearjobTitle
- the user's job titleupdateUserInformation
- whether to update the user's informationsendEmail
- whether to send the user an email notification about their new accountserviceContext
- the service context to be applied (optionallynull
). Can set the expando bridge attributes for the user.- Returns:
- the user
- Throws:
PortalException
-
updateLanguageId
- Throws:
PortalException
-
updateLockoutById
Updates whether the user is locked out from logging in.- Parameters:
userId
- the primary key of the userlockout
- whether the user is locked out- Returns:
- the user
- Throws:
PortalException
-
updateOpenId
Deprecated.As of Athanasius (7.3.x), with no direct replacementUpdates the user's OpenID.- Parameters:
userId
- the primary key of the useropenId
- the new OpenID- Returns:
- the user
- Throws:
PortalException
-
updateOrganizations
public static void updateOrganizations(long userId, long[] organizationIds, ServiceContext serviceContext) throws PortalException Sets the organizations that the user is in, removing and adding organizations as necessary.- Parameters:
userId
- the primary key of the userorganizationIds
- the primary keys of the organizationsserviceContext
- the service context to be applied. Must set whether user indexing is enabled.- Throws:
PortalException
-
updatePassword
public static User updatePassword(long userId, String password1, String password2, boolean passwordReset) throws PortalException Updates the user's password without tracking or validation of the change.- Parameters:
userId
- the primary key of the userpassword1
- the user's new passwordpassword2
- the user's new password confirmationpasswordReset
- whether the user should be asked to reset their password the next time they log in- Returns:
- the user
- Throws:
PortalException
-
updatePortrait
Updates the user's portrait image.- Parameters:
userId
- the primary key of the userbytes
- the new portrait image data- Returns:
- the user
- Throws:
PortalException
-
updateReminderQuery
public static User updateReminderQuery(long userId, String question, String answer) throws PortalException Updates the user's password reset question and answer.- Parameters:
userId
- the primary key of the userquestion
- the user's new password reset questionanswer
- the user's new password reset answer- Returns:
- the user
- Throws:
PortalException
-
updateScreenName
Updates the user's screen name.- Parameters:
userId
- the primary key of the userscreenName
- the user's new screen name- Returns:
- the user
- Throws:
PortalException
-
updateStatus
public static User updateStatus(long userId, int status, ServiceContext serviceContext) throws PortalException Updates the user's workflow status.- Parameters:
userId
- the primary key of the userstatus
- the user's new workflow statusserviceContext
- the service context to be applied. You can specify an unencrypted custom password (used by an LDAP listener) for the user via attributepasswordUnencrypted
.- Returns:
- the user
- Throws:
PortalException
-
updateStatus
public static User updateStatus(User user, int status, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
updateUser
public static User updateUser(long userId, String oldPassword, String newPassword1, String newPassword2, boolean passwordReset, String reminderQueryQuestion, String reminderQueryAnswer, String screenName, String emailAddress, boolean hasPortrait, byte[] portraitBytes, String languageId, String timeZoneId, String greeting, String comments, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String smsSn, String facebookSn, String jabberSn, String skypeSn, String twitterSn, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, List<UserGroupRole> userGroupRoles, long[] userGroupIds, List<Address> addresses, List<EmailAddress> emailAddresses, List<Phone> phones, List<Website> websites, List<AnnouncementsDelivery> announcementsDelivers, ServiceContext serviceContext) throws PortalException Updates the user with additional parameters.- Parameters:
userId
- the primary key of the useroldPassword
- the user's old passwordnewPassword1
- the user's new password (optionallynull
)newPassword2
- the user's new password confirmation (optionallynull
)passwordReset
- whether the user should be asked to reset their password the next time they loginreminderQueryQuestion
- the user's new password reset questionreminderQueryAnswer
- the user's new password reset answerscreenName
- the user's new screen nameemailAddress
- the user's new email addresshasPortrait
- if the user has a custom portrait imageportraitBytes
- the new portrait image datalanguageId
- the user's new language IDtimeZoneId
- the user's new time zone IDgreeting
- the user's new greetingcomments
- the user's new commentsfirstName
- the user's new first namemiddleName
- the user's new middle namelastName
- the user's new last nameprefixListTypeId
- the user's new name prefix IDsuffixListTypeId
- the user's new name suffix IDmale
- whether user is malebirthdayMonth
- the user's new birthday month (0-based, meaning 0 for January)birthdayDay
- the user's new birthday daybirthdayYear
- the user's birthday yearsmsSn
- the user's new SMS screen namefacebookSn
- the user's new Facebook screen namejabberSn
- the user's new Jabber screen nameskypeSn
- the user's new Skype screen nametwitterSn
- the user's new Twitter screen namejobTitle
- the user's new job titlegroupIds
- the primary keys of the user's groupsorganizationIds
- the primary keys of the user's organizationsroleIds
- the primary keys of the user's rolesuserGroupRoles
- the user user's group rolesuserGroupIds
- the primary keys of the user's user groupsaddresses
- the user's addressesemailAddresses
- the user's email addressesphones
- the user's phone numberswebsites
- the user's websitesannouncementsDelivers
- the announcements deliveriesserviceContext
- the service context to be applied (optionallynull
). Can set the UUID (with theuuid
attribute), asset category IDs, asset tag names, and expando bridge attributes for the user.- Returns:
- the user
- Throws:
PortalException
-
updateUser
@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, boolean hasPortrait, byte[] portraitBytes, String languageId, String timeZoneId, String greeting, String comments, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String smsSn, String facebookSn, String jabberSn, String skypeSn, String twitterSn, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, List<UserGroupRole> userGroupRoles, long[] userGroupIds, List<Address> addresses, List<EmailAddress> emailAddresses, List<Phone> phones, List<Website> websites, List<AnnouncementsDelivery> announcementsDelivers, ServiceContext serviceContext) throws PortalException Deprecated.As of Athanasius (7.3.x), replaced byupdateUser(long, String, String, String, boolean, String, String, String, String, boolean, byte[], String, String, String, String, String, String, String, long, long, boolean, int, int, int, String, String, String, String, String, String, long[], long[], long[], List, long[], List, List, List, List, List, ServiceContext)
Updates the user with additional parameters.- Parameters:
userId
- the primary key of the useroldPassword
- the user's old passwordnewPassword1
- the user's new password (optionallynull
)newPassword2
- the user's new password confirmation (optionallynull
)passwordReset
- whether the user should be asked to reset their password the next time they loginreminderQueryQuestion
- the user's new password reset questionreminderQueryAnswer
- the user's new password reset answerscreenName
- the user's new screen nameemailAddress
- the user's new email addresshasPortrait
- if the user has a custom portrait imageportraitBytes
- the new portrait image datalanguageId
- the user's new language IDtimeZoneId
- the user's new time zone IDgreeting
- the user's new greetingcomments
- the user's new commentsfirstName
- the user's new first namemiddleName
- the user's new middle namelastName
- the user's new last nameprefixListTypeId
- the user's new name prefix IDsuffixListTypeId
- the user's new name suffix IDmale
- whether user is malebirthdayMonth
- the user's new birthday month (0-based, meaning 0 for January)birthdayDay
- the user's new birthday daybirthdayYear
- the user's birthday yearsmsSn
- the user's new SMS screen namefacebookSn
- the user's new Facebook screen namejabberSn
- the user's new Jabber screen nameskypeSn
- the user's new Skype screen nametwitterSn
- the user's new Twitter screen namejobTitle
- the user's new job titlegroupIds
- the primary keys of the user's groupsorganizationIds
- the primary keys of the user's organizationsroleIds
- the primary keys of the user's rolesuserGroupRoles
- the user user's group rolesuserGroupIds
- the primary keys of the user's user groupsaddresses
- the user's addressesemailAddresses
- the user's email addressesphones
- the user's phone numberswebsites
- the user's websitesannouncementsDelivers
- the announcements deliveriesserviceContext
- the service context to be applied (optionallynull
). Can set the UUID (with theuuid
attribute), asset category IDs, asset tag names, and expando bridge attributes for the user.- Returns:
- the user
- Throws:
PortalException
-
updateUser
@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 prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String smsSn, String facebookSn, String jabberSn, String skypeSn, String twitterSn, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, List<UserGroupRole> userGroupRoles, long[] userGroupIds, ServiceContext serviceContext) throws PortalException Deprecated.As of Athanasius (7.3.x), replaced byupdateUser(long, String, String, String, boolean, String, String, String, String, String, String, String, String, String, String, String, long, long, boolean, int, int, int, String, String, String, String, String, String, long[], long[], long[], List, long[], ServiceContext)
Updates the user.- Parameters:
userId
- the primary key of the useroldPassword
- the user's old passwordnewPassword1
- the user's new password (optionallynull
)newPassword2
- the user's new password confirmation (optionallynull
)passwordReset
- whether the user should be asked to reset their password the next time they loginreminderQueryQuestion
- the user's new password reset questionreminderQueryAnswer
- the user's new password reset answerscreenName
- the user's new screen nameemailAddress
- the user's new email addresslanguageId
- the user's new language IDtimeZoneId
- the user's new time zone IDgreeting
- the user's new greetingcomments
- the user's new commentsfirstName
- the user's new first namemiddleName
- the user's new middle namelastName
- the user's new last nameprefixListTypeId
- the user's new name prefix IDsuffixListTypeId
- the user's new name suffix IDmale
- whether user is malebirthdayMonth
- the user's new birthday month (0-based, meaning 0 for January)birthdayDay
- the user's new birthday daybirthdayYear
- the user's birthday yearsmsSn
- the user's new SMS screen namefacebookSn
- the user's new Facebook screen namejabberSn
- the user's new Jabber screen nameskypeSn
- the user's new Skype screen nametwitterSn
- the user's new Twitter screen namejobTitle
- the user's new job titlegroupIds
- the primary keys of the user's groupsorganizationIds
- the primary keys of the user's organizationsroleIds
- the primary keys of the user's rolesuserGroupRoles
- the user user's group rolesuserGroupIds
- the primary keys of the user's user groupsserviceContext
- the service context to be applied (optionallynull
). Can set the UUID (with theuuid
attribute), asset category IDs, asset tag names, and expando bridge attributes for the user.- Returns:
- the user
- Throws:
PortalException
-
updateUser
public static User updateUser(long userId, String oldPassword, String newPassword1, String newPassword2, boolean passwordReset, String reminderQueryQuestion, String reminderQueryAnswer, String screenName, String emailAddress, String languageId, String timeZoneId, String greeting, String comments, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String smsSn, String facebookSn, String jabberSn, String skypeSn, String twitterSn, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, List<UserGroupRole> userGroupRoles, long[] userGroupIds, ServiceContext serviceContext) throws PortalException Updates the user.- Parameters:
userId
- the primary key of the useroldPassword
- the user's old passwordnewPassword1
- the user's new password (optionallynull
)newPassword2
- the user's new password confirmation (optionallynull
)passwordReset
- whether the user should be asked to reset their password the next time they loginreminderQueryQuestion
- the user's new password reset questionreminderQueryAnswer
- the user's new password reset answerscreenName
- the user's new screen nameemailAddress
- the user's new email addresslanguageId
- the user's new language IDtimeZoneId
- the user's new time zone IDgreeting
- the user's new greetingcomments
- the user's new commentsfirstName
- the user's new first namemiddleName
- the user's new middle namelastName
- the user's new last nameprefixListTypeId
- the user's new name prefix IDsuffixListTypeId
- the user's new name suffix IDmale
- whether user is malebirthdayMonth
- the user's new birthday month (0-based, meaning 0 for January)birthdayDay
- the user's new birthday daybirthdayYear
- the user's birthday yearsmsSn
- the user's new SMS screen namefacebookSn
- the user's new Facebook screen namejabberSn
- the user's new Jabber screen nameskypeSn
- the user's new Skype screen nametwitterSn
- the user's new Twitter screen namejobTitle
- the user's new job titlegroupIds
- the primary keys of the user's groupsorganizationIds
- the primary keys of the user's organizationsroleIds
- the primary keys of the user's rolesuserGroupRoles
- the user user's group rolesuserGroupIds
- the primary keys of the user's user groupsserviceContext
- the service context to be applied (optionallynull
). Can set the UUID (with theuuid
attribute), asset category IDs, asset tag names, and expando bridge attributes for the user.- Returns:
- the user
- Throws:
PortalException
-
getService
-
setService
-
addUser(long, boolean, String, String, boolean, String, String, Locale, String, String, String, long, long, boolean, int, int, int, String, long[], long[], long[], long[], boolean, ServiceContext)