Class UserServiceWrapper
- All Implemented Interfaces:
BaseService
,ServiceWrapper<UserService>
,UserService
UserService
.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addGroupUsers
(long groupId, long[] userIds, ServiceContext serviceContext) Adds the users to the group.void
addOrganizationUsers
(long organizationId, long[] userIds) Adds the users to the organization.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) void
addPasswordPolicyUsers
(long passwordPolicyId, long[] userIds) Assigns the password policy to the users, removing any other currently assigned password policies.void
addRoleUsers
(long roleId, long[] userIds) Adds the users to the role.void
addTeamUsers
(long teamId, long[] userIds) Adds the users to the team.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.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) 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.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.void
addUserGroupUsers
(long userGroupId, long[] userIds) Adds the users to the user group.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) 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) 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.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.void
deletePortrait
(long userId) Deletes the user's portrait image.void
deleteRoleUser
(long roleId, long userId) Removes the user from the role.void
deleteUser
(long userId) Deletes the user.fetchUserByExternalReferenceCode
(String externalReferenceCode, long companyId) getCompanyUsers
(long companyId, int start, int end) int
getCompanyUsersCount
(long companyId) 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.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) int
getOrganizationsAndUserGroupsUsersCount
(long[] organizationIds, long[] userGroupIds) long[]
getOrganizationUserIds
(long organizationId) Returns the primary keys of all the users belonging to the organization.getOrganizationUsers
(long organizationId) 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.int
getOrganizationUsersCount
(long organizationId, int status) Returns the number of users with the status belonging to the organization.Returns the OSGi service identifier.long[]
getRoleUserIds
(long roleId) Returns the primary keys of all the users belonging to the role.getUserByEmailAddress
(long companyId, String emailAddress) Returns the user with the email address.getUserByExternalReferenceCode
(long companyId, String externalReferenceCode) Returns the user with the external reference code.getUserByExternalReferenceCode
(String externalReferenceCode, long companyId) getUserById
(long userId) Returns the user with the primary key.getUserByScreenName
(long companyId, String screenName) Returns the user with the screen name.getUserGroupUsers
(long userGroupId) getUserGroupUsers
(long userGroupId, int start, int end) long
getUserIdByEmailAddress
(long companyId, String emailAddress) Returns the primary key of the user with the email address.long
getUserIdByScreenName
(long companyId, String screenName) Returns the primary key of the user with the screen name.boolean
hasGroupUser
(long groupId, long userId) Returnstrue
if the user is a member of the group.boolean
hasRoleUser
(long roleId, long userId) Returnstrue
if the user is a member of the role.boolean
hasRoleUser
(long companyId, String name, long userId, boolean inherited) Returnstrue
if the user has the role with the name, optionally through inheritance.boolean
sendPasswordByEmailAddress
(long companyId, String emailAddress) Sends a password notification email to the user matching the email address.boolean
sendPasswordByScreenName
(long companyId, String screenName) Sends a password notification email to the user matching the screen name.boolean
sendPasswordByUserId
(long userId) Sends a password notification email to the user matching the ID.void
setRoleUsers
(long roleId, long[] userIds) Sets the users in the role, removing and adding users to the role as necessary.void
setUserGroupUsers
(long userGroupId, long[] userIds) Sets the users in the user group, removing and adding users to the user group as necessary.void
setWrappedService
(UserService userService) void
unsetGroupTeamsUsers
(long groupId, long[] userIds) Removes the users from the teams of a group.void
unsetGroupUsers
(long groupId, long[] userIds, ServiceContext serviceContext) Removes the users from the group.void
unsetOrganizationUsers
(long organizationId, long[] userIds) Removes the users from the organization.void
unsetPasswordPolicyUsers
(long passwordPolicyId, long[] userIds) Removes the users from the password policy.void
unsetRoleUsers
(long roleId, long[] userIds) Removes the users from the role.void
unsetTeamUsers
(long teamId, long[] userIds) Removes the users from the team.void
unsetUserGroupUsers
(long userGroupId, long[] userIds) Removes the users from the user group.updateAgreedToTermsOfUse
(long userId, boolean agreedToTermsOfUse) Updates the user's response to the terms of use agreement.updateEmailAddress
(long userId, String password, String emailAddress1, String emailAddress2, ServiceContext serviceContext) Updates the user's email address.updateExternalReferenceCode
(long userId, String externalReferenceCode) updateExternalReferenceCode
(User user, String externalReferenceCode) 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)
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.updateLanguageId
(long userId, String languageId) updateLockoutById
(long userId, boolean lockout) Updates whether the user is locked out from logging in.updateOpenId
(long userId, String openId) Deprecated.As of Athanasius (7.3.x), with no direct replacementvoid
updateOrganizations
(long userId, long[] organizationIds, ServiceContext serviceContext) Sets the organizations that the user is in, removing and adding organizations as necessary.updatePassword
(long userId, String password1, String password2, boolean passwordReset) Updates the user's password without tracking or validation of the change.updatePortrait
(long userId, byte[] bytes) Updates the user's portrait image.updateReminderQuery
(long userId, String question, String answer) Updates the user's password reset question and answer.updateScreenName
(long userId, String screenName) Updates the user's screen name.updateStatus
(long userId, int status, ServiceContext serviceContext) Updates the user's workflow status.updateStatus
(User user, int status, ServiceContext serviceContext) updateUser
(long userId, String oldPassword, String newPassword1, String newPassword2, boolean passwordReset, String reminderQueryQuestion, String reminderQueryAnswer, String screenName, String emailAddress, boolean hasPortrait, byte[] portraitBytes, String languageId, String timeZoneId, String greeting, String comments, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String smsSn, String facebookSn, String jabberSn, String skypeSn, String twitterSn, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, List<UserGroupRole> userGroupRoles, long[] userGroupIds, List<Address> addresses, List<EmailAddress> emailAddresses, List<Phone> phones, List<Website> websites, List<AnnouncementsDelivery> announcementsDelivers, ServiceContext serviceContext) Updates the user with additional parameters.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)
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)
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
-
UserServiceWrapper
public UserServiceWrapper() -
UserServiceWrapper
-
-
Method Details
-
addGroupUsers
public void addGroupUsers(long groupId, long[] userIds, ServiceContext serviceContext) throws PortalException Adds the users to the group.- Specified by:
addGroupUsers
in interfaceUserService
- 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.- Specified by:
addOrganizationUsers
in interfaceUserService
- Parameters:
organizationId
- the primary key of the organizationuserIds
- the primary keys of the users- Throws:
PortalException
-
addOrUpdateUser
public User addOrUpdateUser(String externalReferenceCode, long creatorUserId, long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, List<Address> addresses, List<EmailAddress> emailAddresses, List<Phone> phones, List<Website> websites, boolean sendEmail, ServiceContext serviceContext) throws PortalException - Specified by:
addOrUpdateUser
in interfaceUserService
- Throws:
PortalException
-
addPasswordPolicyUsers
Assigns the password policy to the users, removing any other currently assigned password policies.- Specified by:
addPasswordPolicyUsers
in interfaceUserService
- Parameters:
passwordPolicyId
- the primary key of the password policyuserIds
- the primary keys of the users- Throws:
PortalException
-
addRoleUsers
Adds the users to the role.- Specified by:
addRoleUsers
in interfaceUserService
- Parameters:
roleId
- the primary key of the roleuserIds
- the primary keys of the users- Throws:
PortalException
-
addTeamUsers
Adds the users to the team.- Specified by:
addTeamUsers
in interfaceUserService
- Parameters:
teamId
- the primary key of the teamuserIds
- the primary keys of the users- Throws:
PortalException
-
addUser
public 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.
- Specified by:
addUser
in interfaceUserService
- 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 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.
- Specified by:
addUser
in interfaceUserService
- 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 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.
- Specified by:
addUser
in interfaceUserService
- 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 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.
- Specified by:
addUser
in interfaceUserService
- 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.- Specified by:
addUserGroupUsers
in interfaceUserService
- Parameters:
userGroupId
- the primary key of the user groupuserIds
- the primary keys of the users- Throws:
PortalException
-
addUserWithWorkflow
public 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.
- Specified by:
addUserWithWorkflow
in interfaceUserService
- 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 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.
- Specified by:
addUserWithWorkflow
in interfaceUserService
- 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 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.
- Specified by:
addUserWithWorkflow
in interfaceUserService
- 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 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.
- Specified by:
addUserWithWorkflow
in interfaceUserService
- 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.- Specified by:
deletePortrait
in interfaceUserService
- Parameters:
userId
- the primary key of the user- Throws:
PortalException
-
deleteRoleUser
Removes the user from the role.- Specified by:
deleteRoleUser
in interfaceUserService
- Parameters:
roleId
- the primary key of the roleuserId
- the primary key of the user- Throws:
PortalException
-
deleteUser
Deletes the user.- Specified by:
deleteUser
in interfaceUserService
- Parameters:
userId
- the primary key of the user- Throws:
PortalException
-
fetchUserByExternalReferenceCode
public User fetchUserByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Specified by:
fetchUserByExternalReferenceCode
in interfaceUserService
- Throws:
PortalException
-
getCompanyUsers
- Specified by:
getCompanyUsers
in interfaceUserService
- Throws:
PortalException
-
getCompanyUsersCount
- Specified by:
getCompanyUsersCount
in interfaceUserService
- Throws:
PortalException
-
getCurrentUser
- Specified by:
getCurrentUser
in interfaceUserService
- Throws:
PortalException
-
getGroupUserIds
Returns the primary keys of all the users belonging to the group.- Specified by:
getGroupUserIds
in interfaceUserService
- 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.- Specified by:
getGroupUsers
in interfaceUserService
- Parameters:
groupId
- the primary key of the group- Returns:
- the users belonging to the group
- Throws:
PortalException
-
getGroupUsers
public List<User> getGroupUsers(long groupId, int status, int start, int end, OrderByComparator<User> orderByComparator) throws PortalException Returns the users belonging to a group.- Specified by:
getGroupUsers
in interfaceUserService
- Parameters:
groupId
- the primary key of the groupstatus
- the workflow statusstart
- the lower bound of the range of usersend
- the upper bound of the range of users (not inclusive)orderByComparator
- the comparator to order the users by (optionallynull
)- Returns:
- the matching users
- Throws:
PortalException
-
getGroupUsers
public List<User> getGroupUsers(long groupId, int status, OrderByComparator<User> orderByComparator) throws PortalException Returns the users belonging to a group.- Specified by:
getGroupUsers
in interfaceUserService
- 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.- Specified by:
getGroupUsersCount
in interfaceUserService
- 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
- Specified by:
getGtCompanyUsers
in interfaceUserService
- Throws:
PortalException
-
getGtOrganizationUsers
public List<User> getGtOrganizationUsers(long gtUserId, long organizationId, int size) throws PortalException - Specified by:
getGtOrganizationUsers
in interfaceUserService
- Throws:
PortalException
-
getGtUserGroupUsers
public List<User> getGtUserGroupUsers(long gtUserId, long userGroupId, int size) throws PortalException - Specified by:
getGtUserGroupUsers
in interfaceUserService
- Throws:
PortalException
-
getOrganizationsAndUserGroupsUsersCount
public int getOrganizationsAndUserGroupsUsersCount(long[] organizationIds, long[] userGroupIds) throws PrincipalException - Specified by:
getOrganizationsAndUserGroupsUsersCount
in interfaceUserService
- Throws:
PrincipalException
-
getOrganizationUserIds
Returns the primary keys of all the users belonging to the organization.- Specified by:
getOrganizationUserIds
in interfaceUserService
- 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.- Specified by:
getOrganizationUsers
in interfaceUserService
- Parameters:
organizationId
- the primary key of the organization- Returns:
- users belonging to the organization
- Throws:
PortalException
-
getOrganizationUsers
public List<User> getOrganizationUsers(long organizationId, int status, int start, int end, OrderByComparator<User> orderByComparator) throws PortalException Returns the users belonging to the organization with the status.- Specified by:
getOrganizationUsers
in interfaceUserService
- Parameters:
organizationId
- the primary key of the organizationstatus
- the workflow statusstart
- the lower bound of the range of usersend
- the upper bound of the range of users (not inclusive)orderByComparator
- the comparator to order the users by (optionallynull
)- Returns:
- the matching users
- Throws:
PortalException
-
getOrganizationUsers
public List<User> getOrganizationUsers(long organizationId, int status, OrderByComparator<User> orderByComparator) throws PortalException Returns the users belonging to the organization with the status.- Specified by:
getOrganizationUsers
in interfaceUserService
- 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.- Specified by:
getOrganizationUsersCount
in interfaceUserService
- Parameters:
organizationId
- the primary key of the organizationstatus
- the workflow status- Returns:
- the number of users with the status belonging to the organization
- Throws:
PortalException
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Specified by:
getOSGiServiceIdentifier
in interfaceUserService
- Returns:
- the OSGi service identifier
-
getRoleUserIds
Returns the primary keys of all the users belonging to the role.- Specified by:
getRoleUserIds
in interfaceUserService
- Parameters:
roleId
- the primary key of the role- Returns:
- the primary keys of the users belonging to the role
- Throws:
PortalException
-
getUserByEmailAddress
Returns the user with the email address.- Specified by:
getUserByEmailAddress
in interfaceUserService
- Parameters:
companyId
- the primary key of the user's companyemailAddress
- the user's email address- Returns:
- the user with the email address
- Throws:
PortalException
-
getUserByExternalReferenceCode
public User getUserByExternalReferenceCode(long companyId, String externalReferenceCode) throws PortalException Returns the user with the external reference code.- Specified by:
getUserByExternalReferenceCode
in interfaceUserService
- 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 User getUserByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Specified by:
getUserByExternalReferenceCode
in interfaceUserService
- Throws:
PortalException
-
getUserById
Returns the user with the primary key.- Specified by:
getUserById
in interfaceUserService
- 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.- Specified by:
getUserByScreenName
in interfaceUserService
- 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
- Specified by:
getUserGroupUsers
in interfaceUserService
- Throws:
PortalException
-
getUserGroupUsers
- Specified by:
getUserGroupUsers
in interfaceUserService
- Throws:
PortalException
-
getUserIdByEmailAddress
Returns the primary key of the user with the email address.- Specified by:
getUserIdByEmailAddress
in interfaceUserService
- Parameters:
companyId
- the primary key of the user's companyemailAddress
- the user's email address- Returns:
- the primary key of the user with the email address
- Throws:
PortalException
-
getUserIdByScreenName
Returns the primary key of the user with the screen name.- Specified by:
getUserIdByScreenName
in interfaceUserService
- 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.- Specified by:
hasGroupUser
in interfaceUserService
- 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.- Specified by:
hasRoleUser
in interfaceUserService
- 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 boolean hasRoleUser(long companyId, String name, long userId, boolean inherited) throws PortalException Returnstrue
if the user has the role with the name, optionally through inheritance.- Specified by:
hasRoleUser
in interfaceUserService
- 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 boolean sendPasswordByEmailAddress(long companyId, String emailAddress) throws PortalException Sends a password notification email to the user matching the email address. The portal's settings determine whether a password is sent explicitly or whether a link for resetting the user's password is sent. The method sends the email asynchronously and returns before the email is sent.The content of the notification email is specified with the
admin.email.password
portal property keys. They can be overridden via aportal-ext.properties
file or modified through the Portal Settings UI.- Specified by:
sendPasswordByEmailAddress
in interfaceUserService
- Parameters:
companyId
- the primary key of the user's companyemailAddress
- the user's email address- Returns:
true
if the notification email includes a new password;false
if the notification email only contains a reset link- Throws:
PortalException
-
sendPasswordByScreenName
Sends a password notification email to the user matching the screen name. The portal's settings determine whether a password is sent explicitly or whether a link for resetting the user's password is sent. The method sends the email asynchronously and returns before the email is sent.The content of the notification email is specified with the
admin.email.password
portal property keys. They can be overridden via aportal-ext.properties
file or modified through the Portal Settings UI.- Specified by:
sendPasswordByScreenName
in interfaceUserService
- Parameters:
companyId
- the primary key of the user's companyscreenName
- the user's screen name- Returns:
true
if the notification email includes a new password;false
if the notification email only contains a reset link- Throws:
PortalException
-
sendPasswordByUserId
Sends a password notification email to the user matching the ID. The portal's settings determine whether a password is sent explicitly or whether a link for resetting the user's password is sent. The method sends the email asynchronously and returns before the email is sent.The content of the notification email is specified with the
admin.email.password
portal property keys. They can be overridden via aportal-ext.properties
file or modified through the Portal Settings UI.- Specified by:
sendPasswordByUserId
in interfaceUserService
- 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.- Specified by:
setRoleUsers
in interfaceUserService
- 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.- Specified by:
setUserGroupUsers
in interfaceUserService
- 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.- Specified by:
unsetGroupTeamsUsers
in interfaceUserService
- Parameters:
groupId
- the primary key of the groupuserIds
- the primary keys of the users- Throws:
PortalException
-
unsetGroupUsers
public void unsetGroupUsers(long groupId, long[] userIds, ServiceContext serviceContext) throws PortalException Removes the users from the group.- Specified by:
unsetGroupUsers
in interfaceUserService
- Parameters:
groupId
- the primary key of the groupuserIds
- the primary keys of the usersserviceContext
- the service context to be applied (optionallynull
)- Throws:
PortalException
-
unsetOrganizationUsers
Removes the users from the organization.- Specified by:
unsetOrganizationUsers
in interfaceUserService
- Parameters:
organizationId
- the primary key of the organizationuserIds
- the primary keys of the users- Throws:
PortalException
-
unsetPasswordPolicyUsers
Removes the users from the password policy.- Specified by:
unsetPasswordPolicyUsers
in interfaceUserService
- Parameters:
passwordPolicyId
- the primary key of the password policyuserIds
- the primary keys of the users- Throws:
PortalException
-
unsetRoleUsers
Removes the users from the role.- Specified by:
unsetRoleUsers
in interfaceUserService
- Parameters:
roleId
- the primary key of the roleuserIds
- the primary keys of the users- Throws:
PortalException
-
unsetTeamUsers
Removes the users from the team.- Specified by:
unsetTeamUsers
in interfaceUserService
- Parameters:
teamId
- the primary key of the teamuserIds
- the primary keys of the users- Throws:
PortalException
-
unsetUserGroupUsers
Removes the users from the user group.- Specified by:
unsetUserGroupUsers
in interfaceUserService
- Parameters:
userGroupId
- the primary key of the user groupuserIds
- the primary keys of the users- Throws:
PortalException
-
updateAgreedToTermsOfUse
public User updateAgreedToTermsOfUse(long userId, boolean agreedToTermsOfUse) throws PortalException Updates the user's response to the terms of use agreement.- Specified by:
updateAgreedToTermsOfUse
in interfaceUserService
- 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 User updateEmailAddress(long userId, String password, String emailAddress1, String emailAddress2, ServiceContext serviceContext) throws PortalException Updates the user's email address.- Specified by:
updateEmailAddress
in interfaceUserService
- 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 User updateExternalReferenceCode(long userId, String externalReferenceCode) throws PortalException - Specified by:
updateExternalReferenceCode
in interfaceUserService
- Throws:
PortalException
-
updateExternalReferenceCode
public User updateExternalReferenceCode(User user, String externalReferenceCode) throws PortalException - Specified by:
updateExternalReferenceCode
in interfaceUserService
- Throws:
PortalException
-
updateIncompleteUser
public 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.- Specified by:
updateIncompleteUser
in interfaceUserService
- 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 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.- Specified by:
updateIncompleteUser
in interfaceUserService
- 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
- Specified by:
updateLanguageId
in interfaceUserService
- Throws:
PortalException
-
updateLockoutById
Updates whether the user is locked out from logging in.- Specified by:
updateLockoutById
in interfaceUserService
- 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.- Specified by:
updateOpenId
in interfaceUserService
- Parameters:
userId
- the primary key of the useropenId
- the new OpenID- Returns:
- the user
- Throws:
PortalException
-
updateOrganizations
public void updateOrganizations(long userId, long[] organizationIds, ServiceContext serviceContext) throws PortalException Sets the organizations that the user is in, removing and adding organizations as necessary.- Specified by:
updateOrganizations
in interfaceUserService
- 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 User updatePassword(long userId, String password1, String password2, boolean passwordReset) throws PortalException Updates the user's password without tracking or validation of the change.- Specified by:
updatePassword
in interfaceUserService
- 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.- Specified by:
updatePortrait
in interfaceUserService
- Parameters:
userId
- the primary key of the userbytes
- the new portrait image data- Returns:
- the user
- Throws:
PortalException
-
updateReminderQuery
Updates the user's password reset question and answer.- Specified by:
updateReminderQuery
in interfaceUserService
- Parameters:
userId
- the primary key of the userquestion
- the user's new password reset questionanswer
- the user's new password reset answer- Returns:
- the user
- Throws:
PortalException
-
updateScreenName
Updates the user's screen name.- Specified by:
updateScreenName
in interfaceUserService
- Parameters:
userId
- the primary key of the userscreenName
- the user's new screen name- Returns:
- the user
- Throws:
PortalException
-
updateStatus
public User updateStatus(long userId, int status, ServiceContext serviceContext) throws PortalException Updates the user's workflow status.- Specified by:
updateStatus
in interfaceUserService
- Parameters:
userId
- the primary key of the userstatus
- the user's new workflow statusserviceContext
- the service context to be applied. You can specify an unencrypted custom password (used by an LDAP listener) for the user via attributepasswordUnencrypted
.- Returns:
- the user
- Throws:
PortalException
-
updateStatus
public User updateStatus(User user, int status, ServiceContext serviceContext) throws PortalException - Specified by:
updateStatus
in interfaceUserService
- Throws:
PortalException
-
updateUser
public User updateUser(long userId, String oldPassword, String newPassword1, String newPassword2, boolean passwordReset, String reminderQueryQuestion, String reminderQueryAnswer, String screenName, String emailAddress, boolean hasPortrait, byte[] portraitBytes, String languageId, String timeZoneId, String greeting, String comments, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String smsSn, String facebookSn, String jabberSn, String skypeSn, String twitterSn, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, List<UserGroupRole> userGroupRoles, long[] userGroupIds, 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.- Specified by:
updateUser
in interfaceUserService
- 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 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.- Specified by:
updateUser
in interfaceUserService
- 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 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.- Specified by:
updateUser
in interfaceUserService
- 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 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.- Specified by:
updateUser
in interfaceUserService
- 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
-
getWrappedService
- Specified by:
getWrappedService
in interfaceServiceWrapper<UserService>
-
setWrappedService
- Specified by:
setWrappedService
in interfaceServiceWrapper<UserService>
-
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)