@AccessControlled @JSONWebService @ProviderType @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface UserService extends BaseService
UserServiceUtil,
UserServiceBaseImpl,
com.liferay.portal.service.impl.UserServiceImpl| Modifier and Type | Method and Description |
|---|---|
void |
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.
|
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.
|
User |
addUser(long companyId,
boolean autoPassword,
java.lang.String password1,
java.lang.String password2,
boolean autoScreenName,
java.lang.String screenName,
java.lang.String emailAddress,
long facebookId,
java.lang.String openId,
java.util.Locale locale,
java.lang.String firstName,
java.lang.String middleName,
java.lang.String lastName,
long prefixId,
long suffixId,
boolean male,
int birthdayMonth,
int birthdayDay,
int birthdayYear,
java.lang.String jobTitle,
long[] groupIds,
long[] organizationIds,
long[] roleIds,
long[] userGroupIds,
boolean sendEmail,
ServiceContext serviceContext)
Adds a user.
|
User |
addUser(long companyId,
boolean autoPassword,
java.lang.String password1,
java.lang.String password2,
boolean autoScreenName,
java.lang.String screenName,
java.lang.String emailAddress,
long facebookId,
java.lang.String openId,
java.util.Locale locale,
java.lang.String firstName,
java.lang.String middleName,
java.lang.String lastName,
long prefixId,
long suffixId,
boolean male,
int birthdayMonth,
int birthdayDay,
int birthdayYear,
java.lang.String jobTitle,
long[] groupIds,
long[] organizationIds,
long[] roleIds,
long[] userGroupIds,
java.util.List<Address> addresses,
java.util.List<EmailAddress> emailAddresses,
java.util.List<Phone> phones,
java.util.List<Website> websites,
java.util.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.
|
User |
addUserWithWorkflow(long companyId,
boolean autoPassword,
java.lang.String password1,
java.lang.String password2,
boolean autoScreenName,
java.lang.String screenName,
java.lang.String emailAddress,
long facebookId,
java.lang.String openId,
java.util.Locale locale,
java.lang.String firstName,
java.lang.String middleName,
java.lang.String lastName,
long prefixId,
long suffixId,
boolean male,
int birthdayMonth,
int birthdayDay,
int birthdayYear,
java.lang.String jobTitle,
long[] groupIds,
long[] organizationIds,
long[] roleIds,
long[] userGroupIds,
boolean sendEmail,
ServiceContext serviceContext)
Adds a user with workflow.
|
User |
addUserWithWorkflow(long companyId,
boolean autoPassword,
java.lang.String password1,
java.lang.String password2,
boolean autoScreenName,
java.lang.String screenName,
java.lang.String emailAddress,
long facebookId,
java.lang.String openId,
java.util.Locale locale,
java.lang.String firstName,
java.lang.String middleName,
java.lang.String lastName,
long prefixId,
long suffixId,
boolean male,
int birthdayMonth,
int birthdayDay,
int birthdayYear,
java.lang.String jobTitle,
long[] groupIds,
long[] organizationIds,
long[] roleIds,
long[] userGroupIds,
java.util.List<Address> addresses,
java.util.List<EmailAddress> emailAddresses,
java.util.List<Phone> phones,
java.util.List<Website> websites,
java.util.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.
|
java.lang.String |
getBeanIdentifier()
Returns the Spring bean ID for this bean.
|
java.util.List<User> |
getCompanyUsers(long companyId,
int start,
int end) |
int |
getCompanyUsersCount(long companyId) |
User |
getCurrentUser() |
long[] |
getGroupUserIds(long groupId)
Returns the primary keys of all the users belonging to the group.
|
java.util.List<User> |
getGroupUsers(long groupId)
Returns all the users belonging to the group.
|
long[] |
getOrganizationUserIds(long organizationId)
Returns the primary keys of all the users belonging to the organization.
|
java.util.List<User> |
getOrganizationUsers(long organizationId)
Returns all the users belonging to the organization.
|
long[] |
getRoleUserIds(long roleId)
Returns the primary keys of all the users belonging to the role.
|
User |
getUserByEmailAddress(long companyId,
java.lang.String emailAddress)
Returns the user with the email address.
|
User |
getUserById(long userId)
Returns the user with the primary key.
|
User |
getUserByScreenName(long companyId,
java.lang.String screenName)
Returns the user with the screen name.
|
java.util.List<User> |
getUserGroupUsers(long userGroupId) |
long |
getUserIdByEmailAddress(long companyId,
java.lang.String emailAddress)
Returns the primary key of the user with the email address.
|
long |
getUserIdByScreenName(long companyId,
java.lang.String screenName)
Returns the primary key of the user with the screen name.
|
boolean |
hasGroupUser(long groupId,
long userId)
Returns
true if the user is a member of the group. |
boolean |
hasRoleUser(long roleId,
long userId)
Returns
true if the user is a member of the role. |
boolean |
hasRoleUser(long companyId,
java.lang.String name,
long userId,
boolean inherited)
Returns
true if the user has the role with the name,
optionally through inheritance. |
boolean |
sendPasswordByEmailAddress(long companyId,
java.lang.String emailAddress)
Sends a password notification email to the user matching the email
address.
|
boolean |
sendPasswordByScreenName(long companyId,
java.lang.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 |
setBeanIdentifier(java.lang.String beanIdentifier)
Sets the Spring bean ID for this bean.
|
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 |
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.
|
User |
updateAgreedToTermsOfUse(long userId,
boolean agreedToTermsOfUse)
Updates the user's response to the terms of use agreement.
|
User |
updateEmailAddress(long userId,
java.lang.String password,
java.lang.String emailAddress1,
java.lang.String emailAddress2,
ServiceContext serviceContext)
Updates the user's email address.
|
User |
updateIncompleteUser(long companyId,
boolean autoPassword,
java.lang.String password1,
java.lang.String password2,
boolean autoScreenName,
java.lang.String screenName,
java.lang.String emailAddress,
long facebookId,
java.lang.String openId,
java.util.Locale locale,
java.lang.String firstName,
java.lang.String middleName,
java.lang.String lastName,
long prefixId,
long suffixId,
boolean male,
int birthdayMonth,
int birthdayDay,
int birthdayYear,
java.lang.String jobTitle,
boolean updateUserInformation,
boolean sendEmail,
ServiceContext serviceContext)
Updates a user account that was automatically created when a guest user
participated in an action (e.g. posting a comment) and only provided his
name and email address.
|
User |
updateLockoutById(long userId,
boolean lockout)
Updates whether the user is locked out from logging in.
|
User |
updateOpenId(long userId,
java.lang.String openId)
Updates the user's OpenID.
|
void |
updateOrganizations(long userId,
long[] organizationIds,
ServiceContext serviceContext)
Sets the organizations that the user is in, removing and adding
organizations as necessary.
|
User |
updatePassword(long userId,
java.lang.String password1,
java.lang.String password2,
boolean passwordReset)
Updates the user's password without tracking or validation of the change.
|
User |
updatePortrait(long userId,
byte[] bytes)
Updates the user's portrait image.
|
User |
updateReminderQuery(long userId,
java.lang.String question,
java.lang.String answer)
Updates the user's password reset question and answer.
|
User |
updateScreenName(long userId,
java.lang.String screenName)
Updates the user's screen name.
|
User |
updateStatus(long userId,
int status)
Deprecated.
As of 7.0.0, replaced by
updateStatus(long, int,
ServiceContext) |
User |
updateStatus(long userId,
int status,
ServiceContext serviceContext)
Updates the user's workflow status.
|
User |
updateUser(long userId,
java.lang.String oldPassword,
java.lang.String newPassword1,
java.lang.String newPassword2,
boolean passwordReset,
java.lang.String reminderQueryQuestion,
java.lang.String reminderQueryAnswer,
java.lang.String screenName,
java.lang.String emailAddress,
long facebookId,
java.lang.String openId,
boolean portrait,
byte[] portraitBytes,
java.lang.String languageId,
java.lang.String timeZoneId,
java.lang.String greeting,
java.lang.String comments,
java.lang.String firstName,
java.lang.String middleName,
java.lang.String lastName,
long prefixId,
long suffixId,
boolean male,
int birthdayMonth,
int birthdayDay,
int birthdayYear,
java.lang.String smsSn,
java.lang.String aimSn,
java.lang.String facebookSn,
java.lang.String icqSn,
java.lang.String jabberSn,
java.lang.String msnSn,
java.lang.String mySpaceSn,
java.lang.String skypeSn,
java.lang.String twitterSn,
java.lang.String ymSn,
java.lang.String jobTitle,
long[] groupIds,
long[] organizationIds,
long[] roleIds,
java.util.List<UserGroupRole> userGroupRoles,
long[] userGroupIds,
java.util.List<Address> addresses,
java.util.List<EmailAddress> emailAddresses,
java.util.List<Phone> phones,
java.util.List<Website> websites,
java.util.List<AnnouncementsDelivery> announcementsDelivers,
ServiceContext serviceContext)
Updates the user with additional parameters.
|
User |
updateUser(long userId,
java.lang.String oldPassword,
java.lang.String newPassword1,
java.lang.String newPassword2,
boolean passwordReset,
java.lang.String reminderQueryQuestion,
java.lang.String reminderQueryAnswer,
java.lang.String screenName,
java.lang.String emailAddress,
long facebookId,
java.lang.String openId,
java.lang.String languageId,
java.lang.String timeZoneId,
java.lang.String greeting,
java.lang.String comments,
java.lang.String firstName,
java.lang.String middleName,
java.lang.String lastName,
long prefixId,
long suffixId,
boolean male,
int birthdayMonth,
int birthdayDay,
int birthdayYear,
java.lang.String smsSn,
java.lang.String aimSn,
java.lang.String facebookSn,
java.lang.String icqSn,
java.lang.String jabberSn,
java.lang.String msnSn,
java.lang.String mySpaceSn,
java.lang.String skypeSn,
java.lang.String twitterSn,
java.lang.String ymSn,
java.lang.String jobTitle,
long[] groupIds,
long[] organizationIds,
long[] roleIds,
java.util.List<UserGroupRole> userGroupRoles,
long[] userGroupIds,
java.util.List<Address> addresses,
java.util.List<EmailAddress> emailAddresses,
java.util.List<Phone> phones,
java.util.List<Website> websites,
java.util.List<AnnouncementsDelivery> announcementsDelivers,
ServiceContext serviceContext)
Deprecated.
As of 7.0.0, replaced by
#updateUser(long, String,
String, String, boolean, String, String, String, String,
long, String, boolean, byte[], String, String, String,
String, String, String, String, int, int, boolean, int, int,
int, String, String, String, String, String, String, String,
String, String, String, String, long[], long[], long[], List,
long[], List, List, List, List, List, ServiceContext) |
User |
updateUser(long userId,
java.lang.String oldPassword,
java.lang.String newPassword1,
java.lang.String newPassword2,
boolean passwordReset,
java.lang.String reminderQueryQuestion,
java.lang.String reminderQueryAnswer,
java.lang.String screenName,
java.lang.String emailAddress,
long facebookId,
java.lang.String openId,
java.lang.String languageId,
java.lang.String timeZoneId,
java.lang.String greeting,
java.lang.String comments,
java.lang.String firstName,
java.lang.String middleName,
java.lang.String lastName,
long prefixId,
long suffixId,
boolean male,
int birthdayMonth,
int birthdayDay,
int birthdayYear,
java.lang.String smsSn,
java.lang.String aimSn,
java.lang.String facebookSn,
java.lang.String icqSn,
java.lang.String jabberSn,
java.lang.String msnSn,
java.lang.String mySpaceSn,
java.lang.String skypeSn,
java.lang.String twitterSn,
java.lang.String ymSn,
java.lang.String jobTitle,
long[] groupIds,
long[] organizationIds,
long[] roleIds,
java.util.List<UserGroupRole> userGroupRoles,
long[] userGroupIds,
ServiceContext serviceContext)
Updates the user.
|
void addGroupUsers(long groupId,
long[] userIds,
ServiceContext serviceContext)
throws PortalException
groupId - the primary key of the groupuserIds - the primary keys of the usersserviceContext - the service context to be applied (optionally
null)PortalException - if a group or user with the primary key could not
be found, if the user did not have permission to assign group
members, or if the operation was not allowed by the membership
policyvoid addOrganizationUsers(long organizationId,
long[] userIds)
throws PortalException
organizationId - the primary key of the organizationuserIds - the primary keys of the usersPortalException - if an organization or user with the primary key
could not be found, if the user did not have permission to assign
organization members, if current user did not have an
organization in common with a given user, or if the operation was
not allowed by the membership policyvoid addPasswordPolicyUsers(long passwordPolicyId,
long[] userIds)
throws PortalException
passwordPolicyId - the primary key of the password policyuserIds - the primary keys of the usersPortalException - if the user did not have permission to assign
policy membersvoid addRoleUsers(long roleId,
long[] userIds)
throws PortalException
roleId - the primary key of the roleuserIds - the primary keys of the usersPortalException - if a role or user with the primary key could not
be found, if the user did not have permission to assign role
members, or if the operation was not allowed by the membership
policyvoid addTeamUsers(long teamId,
long[] userIds)
throws PortalException
teamId - the primary key of the teamuserIds - the primary keys of the usersPortalException - if a team or user with the primary key could not
be found or if the user did not have permission to assign team
membersUser addUser(long companyId, boolean autoPassword, java.lang.String password1, java.lang.String password2, boolean autoScreenName, java.lang.String screenName, java.lang.String emailAddress, long facebookId, java.lang.String openId, java.util.Locale locale, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName, long prefixId, long suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, java.lang.String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, java.util.List<Address> addresses, java.util.List<EmailAddress> emailAddresses, java.util.List<Phone> phones, java.util.List<Website> websites, java.util.List<AnnouncementsDelivery> announcementsDelivers, boolean sendEmail, ServiceContext serviceContext) throws PortalException
This method handles the creation and bookkeeping of the user including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, etc.
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 nameprefixId - the user's name prefix IDsuffixId - the user's name suffix IDmale - whether the user is malebirthdayMonth - the user's birthday month (0-based, meaning 0 for
January)birthdayDay - the user's birthday daybirthdayYear - the user's birthday yearjobTitle - the user's job titlegroupIds - the primary keys of the user's groupsorganizationIds - the primary keys of the user's organizationsroleIds - the primary keys of the roles this user possessesuserGroupIds - the primary keys of the user's user 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 (optionally
null). Can set the UUID (with the uuid
attribute), asset category IDs, asset tag names, and expando
bridge attributes for the user.PortalException - if the user's information was invalid, if the
creator did not have permission to add users, if the email
address was reserved, if the operation was not allowed by the
membership policy, or if some other portal exception occurredUser addUser(long companyId, boolean autoPassword, java.lang.String password1, java.lang.String password2, boolean autoScreenName, java.lang.String screenName, java.lang.String emailAddress, long facebookId, java.lang.String openId, java.util.Locale locale, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName, long prefixId, long suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, java.lang.String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, ServiceContext serviceContext) throws PortalException
This method handles the creation and bookkeeping of the user including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, etc.
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 nameprefixId - the user's name prefix IDsuffixId - the user's name suffix IDmale - whether the user is malebirthdayMonth - the user's birthday month (0-based, meaning 0 for
January)birthdayDay - the user's birthday daybirthdayYear - the user's birthday yearjobTitle - the user's job titlegroupIds - the primary keys of the user's groupsorganizationIds - the primary keys of the user's organizationsroleIds - the primary keys of the roles this user possessesuserGroupIds - the primary keys of the user's user groupssendEmail - whether to send the user an email notification about
their new accountserviceContext - the service context to be applied (optionally
null). Can set the UUID (with the uuid
attribute), asset category IDs, asset tag names, and expando
bridge attributes for the user.PortalException - if the user's information was invalid, if the
operation was not allowed by the membership policy, if the
creator did not have permission to add users, or if the email
address was reservedvoid addUserGroupUsers(long userGroupId,
long[] userIds)
throws PortalException
userGroupId - the primary key of the user groupuserIds - the primary keys of the usersPortalException - if a user group or user with the primary could
could not be found, if the current user did not have permission
to assign group members, or if the operation was not allowed by
the membership policyUser addUserWithWorkflow(long companyId, boolean autoPassword, java.lang.String password1, java.lang.String password2, boolean autoScreenName, java.lang.String screenName, java.lang.String emailAddress, long facebookId, java.lang.String openId, java.util.Locale locale, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName, long prefixId, long suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, java.lang.String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, java.util.List<Address> addresses, java.util.List<EmailAddress> emailAddresses, java.util.List<Phone> phones, java.util.List<Website> websites, java.util.List<AnnouncementsDelivery> announcementsDelivers, boolean sendEmail, ServiceContext serviceContext) throws PortalException
This method handles the creation and bookkeeping of the user including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, etc.
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 nameprefixId - the user's name prefix IDsuffixId - the user's name suffix IDmale - whether the user is malebirthdayMonth - the user's birthday month (0-based, meaning 0 for
January)birthdayDay - the user's birthday daybirthdayYear - the user's birthday yearjobTitle - the user's job titlegroupIds - the primary keys of the user's groupsorganizationIds - the primary keys of the user's organizationsroleIds - the primary keys of the roles this user possessesuserGroupIds - the primary keys of the user's user 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 (optionally
null). Can set the UUID (with the uuid
attribute), asset category IDs, asset tag names, and expando
bridge attributes for the user.PortalException - if the user's information was invalid, if the
operation was not allowed by the membership policy, if the
creator did not have permission to add users, if the email
address was reserved, or if some other portal exception occurredUser addUserWithWorkflow(long companyId, boolean autoPassword, java.lang.String password1, java.lang.String password2, boolean autoScreenName, java.lang.String screenName, java.lang.String emailAddress, long facebookId, java.lang.String openId, java.util.Locale locale, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName, long prefixId, long suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, java.lang.String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, ServiceContext serviceContext) throws PortalException
This method handles the creation and bookkeeping of the user including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, etc.
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 nameprefixId - the user's name prefix IDsuffixId - the user's name suffix IDmale - whether the user is malebirthdayMonth - the user's birthday month (0-based, meaning 0 for
January)birthdayDay - the user's birthday daybirthdayYear - the user's birthday yearjobTitle - the user's job titlegroupIds - the primary keys of the user's groupsorganizationIds - the primary keys of the user's organizationsroleIds - the primary keys of the roles this user possessesuserGroupIds - the primary keys of the user's user groupssendEmail - whether to send the user an email notification about
their new accountserviceContext - the service context to be applied (optionally
null). Can set the UUID (with the uuid
attribute), asset category IDs, asset tag names, and expando
bridge attributes for the user.PortalException - if the user's information was invalid, if the
operation was not allowed by the membership policy, if the
creator did not have permission to add users, or if the email
address was reservedvoid deletePortrait(long userId)
throws PortalException
userId - the primary key of the userPortalException - if a user with the primary key could not be
found, if the user's portrait could not be found, or if the
current user did not have permission to update the uservoid deleteRoleUser(long roleId,
long userId)
throws PortalException
roleId - the primary key of the roleuserId - the primary key of the userPortalException - if a role or user with the primary key could not
be found, or if the current user did not have permission to
assign role membersvoid deleteUser(long userId)
throws PortalException
userId - the primary key of the userPortalException - if a user with the primary key could not be found
or if the current user did not have permission to delete the userjava.lang.String getBeanIdentifier()
@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<User> getCompanyUsers(long companyId, int start, int end) throws PortalException
PortalException@Transactional(propagation=SUPPORTS, readOnly=true) int getCompanyUsersCount(long companyId) throws PortalException
PortalException@Transactional(propagation=SUPPORTS, readOnly=true) User getCurrentUser() throws PortalException
PortalException@Transactional(propagation=SUPPORTS, readOnly=true) long[] getGroupUserIds(long groupId) throws PortalException
groupId - the primary key of the groupPortalException - if the current user did not have permission to
view group assignments@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<User> getGroupUsers(long groupId) throws PortalException
groupId - the primary key of the groupPortalException - if the current user did not have permission to
view group assignments@Transactional(propagation=SUPPORTS, readOnly=true) long[] getOrganizationUserIds(long organizationId) throws PortalException
organizationId - the primary key of the organizationPortalException - if the current user did not have permission to
view organization assignments@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<User> getOrganizationUsers(long organizationId) throws PortalException
organizationId - the primary key of the organizationPortalException - if the current user did not have permission to
view organization assignments@Transactional(propagation=SUPPORTS, readOnly=true) long[] getRoleUserIds(long roleId) throws PortalException
roleId - the primary key of the rolePortalException - if the current user did not have permission to
view role members@Transactional(propagation=SUPPORTS, readOnly=true) User getUserByEmailAddress(long companyId, java.lang.String emailAddress) throws PortalException
companyId - the primary key of the user's companyemailAddress - the user's email addressPortalException - if a user with the email address could not be
found or if the current user did not have permission to view the
user@Transactional(propagation=SUPPORTS, readOnly=true) User getUserById(long userId) throws PortalException
userId - the primary key of the userPortalException - if a user with the primary key could not be found
or if the current user did not have permission to view the user@Transactional(propagation=SUPPORTS, readOnly=true) User getUserByScreenName(long companyId, java.lang.String screenName) throws PortalException
companyId - the primary key of the user's companyscreenName - the user's screen namePortalException - if a user with the screen name could not be found
or if the current user did not have permission to view the user@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<User> getUserGroupUsers(long userGroupId) throws PortalException
PortalException@Transactional(propagation=SUPPORTS, readOnly=true) long getUserIdByEmailAddress(long companyId, java.lang.String emailAddress) throws PortalException
companyId - the primary key of the user's companyemailAddress - the user's email addressPortalException - if a user with the email address could not be
found@Transactional(propagation=SUPPORTS, readOnly=true) long getUserIdByScreenName(long companyId, java.lang.String screenName) throws PortalException
companyId - the primary key of the user's companyscreenName - the user's screen namePortalException - if a user with the screen name could not be found@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasGroupUser(long groupId, long userId) throws PortalException
true if the user is a member of the group.groupId - the primary key of the groupuserId - the primary key of the usertrue if the user is a member of the group;
false otherwisePortalException - if the current user did not have permission to
view the user or group members@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasRoleUser(long companyId, java.lang.String name, long userId, boolean inherited) throws PortalException
true if the user has the role with the name,
optionally through inheritance.companyId - the primary key of the role's companyname - the name of the role (must be a regular role, not an
organization, site or provider role)userId - the primary key of the userinherited - whether to include roles inherited from organizations,
sites, etc.true if the user has the role; false
otherwisePortalException - if a role with the name could not be found@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasRoleUser(long roleId, long userId) throws PortalException
true if the user is a member of the role.roleId - the primary key of the roleuserId - the primary key of the usertrue if the user is a member of the role;
false otherwisePortalException - if the current user did not have permission to
view the user or role membersboolean sendPasswordByEmailAddress(long companyId,
java.lang.String emailAddress)
throws PortalException
The content of the notification email is specified with the
admin.email.password portal property keys. They can be
overridden via a portal-ext.properties file or modified
through the Portal Settings UI.
companyId - the primary key of the user's companyemailAddress - the user's email addresstrue if the notification email includes a new
password; false if the notification email only
contains a reset linkPortalException - if a user with the email address could not be
foundboolean sendPasswordByScreenName(long companyId,
java.lang.String screenName)
throws PortalException
The content of the notification email is specified with the
admin.email.password portal property keys. They can be
overridden via a portal-ext.properties file or modified
through the Portal Settings UI.
companyId - the primary key of the user's companyscreenName - the user's screen nametrue if the notification email includes a new
password; false if the notification email only
contains a reset linkPortalException - if a user with the screen name could not be foundboolean sendPasswordByUserId(long userId)
throws PortalException
The content of the notification email is specified with the
admin.email.password portal property keys. They can be
overridden via a portal-ext.properties file or modified
through the Portal Settings UI.
userId - the user's primary keytrue if the notification email includes a new
password; false if the notification email only
contains a reset linkPortalException - if a user with the user ID could not be foundvoid setBeanIdentifier(java.lang.String beanIdentifier)
beanIdentifier - the Spring bean ID for this beanvoid setRoleUsers(long roleId,
long[] userIds)
throws PortalException
roleId - the primary key of the roleuserIds - the primary keys of the usersPortalException - if the current user did not have permission to
assign role members or if the operation was not allowed by the
membership policyvoid setUserGroupUsers(long userGroupId,
long[] userIds)
throws PortalException
userGroupId - the primary key of the user groupuserIds - the primary keys of the usersPortalException - if the current user did not have permission to
assign group membersvoid unsetGroupTeamsUsers(long groupId,
long[] userIds)
throws PortalException
groupId - the primary key of the groupuserIds - the primary keys of the usersPortalException - if the current user did not have permission to
modify user group assignmentsvoid unsetGroupUsers(long groupId,
long[] userIds,
ServiceContext serviceContext)
throws PortalException
groupId - the primary key of the groupuserIds - the primary keys of the usersserviceContext - the service context to be applied (optionally
null)PortalException - if the current user did not have permission to
modify group assignments or if the operation was not allowed by
the membership policyvoid unsetOrganizationUsers(long organizationId,
long[] userIds)
throws PortalException
organizationId - the primary key of the organizationuserIds - the primary keys of the usersPortalException - if the current user did not have permission to
modify organization assignments or if the operation was not
allowed by the membership policyvoid unsetPasswordPolicyUsers(long passwordPolicyId,
long[] userIds)
throws PortalException
passwordPolicyId - the primary key of the password policyuserIds - the primary keys of the usersPortalException - if the current user did not have permission to
modify policy assignmentsvoid unsetRoleUsers(long roleId,
long[] userIds)
throws PortalException
roleId - the primary key of the roleuserIds - the primary keys of the usersPortalException - if the current user did not have permission to
modify role assignments or if the operation was not allowed by
the membership policyvoid unsetTeamUsers(long teamId,
long[] userIds)
throws PortalException
teamId - the primary key of the teamuserIds - the primary keys of the usersPortalException - if the current user did not have permission to
modify team assignmentsvoid unsetUserGroupUsers(long userGroupId,
long[] userIds)
throws PortalException
userGroupId - the primary key of the user groupuserIds - the primary keys of the usersPortalException - if the current user did not have permission to
modify user group assignments or if the operation was not allowed
by the membership policyUser updateAgreedToTermsOfUse(long userId, boolean agreedToTermsOfUse) throws PortalException
userId - the primary key of the useragreedToTermsOfUse - whether the user has agree to the terms of usePortalException - if the current user did not have permission to
update the user's agreement to terms-of-useUser updateEmailAddress(long userId, java.lang.String password, java.lang.String emailAddress1, java.lang.String emailAddress2, ServiceContext serviceContext) throws PortalException
userId - the primary key of the userpassword - the user's passwordemailAddress1 - the user's new email addressemailAddress2 - the user's new email address confirmationserviceContext - the service context to be applied. Must set the
portal URL, main path, primary key of the layout, remote address,
remote host, and agent for the user.PortalException - if a user with the primary key could not be found
or if the current user did not have permission to update the userUser updateIncompleteUser(long companyId, boolean autoPassword, java.lang.String password1, java.lang.String password2, boolean autoScreenName, java.lang.String screenName, java.lang.String emailAddress, long facebookId, java.lang.String openId, java.util.Locale locale, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName, long prefixId, long suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, java.lang.String jobTitle, boolean updateUserInformation, boolean sendEmail, ServiceContext serviceContext) throws PortalException
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 nameprefixId - the user's name prefix IDsuffixId - the user's name suffix IDmale - whether the user is malebirthdayMonth - the user's birthday month (0-based, meaning 0 for
January)birthdayDay - the user's birthday daybirthdayYear - the user's birthday yearjobTitle - the user's job titleupdateUserInformation - whether to update the user's informationsendEmail - whether to send the user an email notification about
their new accountserviceContext - the service context to be applied (optionally
null). Can set the expando bridge attributes for the
user.PortalException - if the user's information was invalid or if the
email address was reservedUser updateLockoutById(long userId, boolean lockout) throws PortalException
userId - the primary key of the userlockout - whether the user is locked outPortalException - if the user did not have permission to lock out
the userUser updateOpenId(long userId, java.lang.String openId) throws PortalException
userId - the primary key of the useropenId - the new OpenIDPortalException - if a user with the primary key could not be found
or if the current user did not have permission to update the uservoid updateOrganizations(long userId,
long[] organizationIds,
ServiceContext serviceContext)
throws PortalException
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.PortalException - if a user with the primary key could not be found
or if the current user did not have permission to update the userUser updatePassword(long userId, java.lang.String password1, java.lang.String password2, boolean passwordReset) throws PortalException
userId - the primary key of the userpassword1 - the user's new passwordpassword2 - the user's new password confirmationpasswordReset - whether the user should be asked to reset their
password the next time they log inPortalException - if a user with the primary key could not be found
or if the current user did not have permission to update the userUser updatePortrait(long userId, byte[] bytes) throws PortalException
userId - the primary key of the userbytes - the new portrait image dataPortalException - if a user with the primary key could not be
found, if the new portrait was invalid, or if the current user
did not have permission to update the userUser updateReminderQuery(long userId, java.lang.String question, java.lang.String answer) throws PortalException
userId - the primary key of the userquestion - the user's new password reset questionanswer - the user's new password reset answerPortalException - if a user with the primary key could not be
found, if the new question or answer were invalid, or if the
current user did not have permission to update the userUser updateScreenName(long userId, java.lang.String screenName) throws PortalException
userId - the primary key of the userscreenName - the user's new screen namePortalException - if a user with the primary key could not be
found, if the new screen name was invalid, or if the current user
did not have permission to update the user@Deprecated User updateStatus(long userId, int status) throws PortalException
updateStatus(long, int,
ServiceContext)userId - the primary key of the userstatus - the user's new workflow statusPortalException - if a user with the primary key could not be
found, if the current user was updating her own status to
anything but WorkflowConstants#STATUS_APPROVED, or if
the current user did not have permission to update the user's
workflow status.User updateStatus(long userId, int status, ServiceContext serviceContext) throws PortalException
userId - the primary key of the userstatus - the user's new workflow statusserviceContext - the service context to be applied. You can specify
an unencrypted custom password (used by an LDAP listener) for the
user via attribute passwordUnencrypted.PortalException - if a user with the primary key could not be
found, if the current user was updating her own status to
anything but WorkflowConstants#STATUS_APPROVED, or if the
current user did not have permission to update the user's
workflow status.@Deprecated User updateUser(long userId, java.lang.String oldPassword, java.lang.String newPassword1, java.lang.String newPassword2, boolean passwordReset, java.lang.String reminderQueryQuestion, java.lang.String reminderQueryAnswer, java.lang.String screenName, java.lang.String emailAddress, long facebookId, java.lang.String openId, java.lang.String languageId, java.lang.String timeZoneId, java.lang.String greeting, java.lang.String comments, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName, long prefixId, long suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, java.lang.String smsSn, java.lang.String aimSn, java.lang.String facebookSn, java.lang.String icqSn, java.lang.String jabberSn, java.lang.String msnSn, java.lang.String mySpaceSn, java.lang.String skypeSn, java.lang.String twitterSn, java.lang.String ymSn, java.lang.String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, java.util.List<UserGroupRole> userGroupRoles, long[] userGroupIds, java.util.List<Address> addresses, java.util.List<EmailAddress> emailAddresses, java.util.List<Phone> phones, java.util.List<Website> websites, java.util.List<AnnouncementsDelivery> announcementsDelivers, ServiceContext serviceContext) throws PortalException
#updateUser(long, String,
String, String, boolean, String, String, String, String,
long, String, boolean, byte[], String, String, String,
String, String, String, String, int, int, boolean, int, int,
int, String, String, String, String, String, String, String,
String, String, String, String, long[], long[], long[], List,
long[], List, List, List, List, List, ServiceContext)userId - the primary key of the useroldPassword - the user's old passwordnewPassword1 - the user's new password (optionally
null)newPassword2 - the user's new password confirmation (optionally
null)passwordReset - whether the user should be asked to reset their
password the next time they loginreminderQueryQuestion - the user's new password reset questionreminderQueryAnswer - the user's new password reset answerscreenName - the user's new screen nameemailAddress - the user's new email addressfacebookId - the user's new Facebook IDopenId - the user's new OpenIDlanguageId - the user's new language IDtimeZoneId - the user's new time zone IDgreeting - the user's new greetingcomments - the user's new commentsfirstName - the user's new first namemiddleName - the user's new middle namelastName - the user's new last nameprefixId - the user's new name prefix IDsuffixId - the user's new name suffix IDmale - whether user is malebirthdayMonth - the user's new birthday month (0-based, meaning
0 for January)birthdayDay - the user's new birthday daybirthdayYear - the user's birthday yearsmsSn - the user's new SMS screen nameaimSn - the user's new AIM screen namefacebookSn - the user's new Facebook screen nameicqSn - the user's new ICQ screen namejabberSn - the user's new Jabber screen namemsnSn - the user's new MSN screen namemySpaceSn - the user's new MySpace screen nameskypeSn - the user's new Skype screen nametwitterSn - the user's new Twitter screen nameymSn - the user's new Yahoo! Messenger 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 (optionally
null). Can set the UUID (with the
uuid attribute), asset category IDs, asset tag
names, and expando bridge attributes for the user.PortalException - if a user with the primary key could not be
found, if the new information was invalid, if the current
user did not have permission to update the user, or if the
operation was not allowed by the membership policyUser updateUser(long userId, java.lang.String oldPassword, java.lang.String newPassword1, java.lang.String newPassword2, boolean passwordReset, java.lang.String reminderQueryQuestion, java.lang.String reminderQueryAnswer, java.lang.String screenName, java.lang.String emailAddress, long facebookId, java.lang.String openId, java.lang.String languageId, java.lang.String timeZoneId, java.lang.String greeting, java.lang.String comments, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName, long prefixId, long suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, java.lang.String smsSn, java.lang.String aimSn, java.lang.String facebookSn, java.lang.String icqSn, java.lang.String jabberSn, java.lang.String msnSn, java.lang.String mySpaceSn, java.lang.String skypeSn, java.lang.String twitterSn, java.lang.String ymSn, java.lang.String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, java.util.List<UserGroupRole> userGroupRoles, long[] userGroupIds, ServiceContext serviceContext) throws PortalException
userId - the primary key of the useroldPassword - the user's old passwordnewPassword1 - the user's new password (optionally
null)newPassword2 - the user's new password confirmation (optionally
null)passwordReset - whether the user should be asked to reset their
password the next time they loginreminderQueryQuestion - the user's new password reset questionreminderQueryAnswer - the user's new password reset answerscreenName - the user's new screen nameemailAddress - the user's new email addressfacebookId - the user's new Facebook IDopenId - the user's new OpenIDlanguageId - the user's new language IDtimeZoneId - the user's new time zone IDgreeting - the user's new greetingcomments - the user's new commentsfirstName - the user's new first namemiddleName - the user's new middle namelastName - the user's new last nameprefixId - the user's new name prefix IDsuffixId - the user's new name suffix IDmale - whether user is malebirthdayMonth - the user's new birthday month (0-based, meaning 0
for January)birthdayDay - the user's new birthday daybirthdayYear - the user's birthday yearsmsSn - the user's new SMS screen nameaimSn - the user's new AIM screen namefacebookSn - the user's new Facebook screen nameicqSn - the user's new ICQ screen namejabberSn - the user's new Jabber screen namemsnSn - the user's new MSN screen namemySpaceSn - the user's new MySpace screen nameskypeSn - the user's new Skype screen nametwitterSn - the user's new Twitter screen nameymSn - the user's new Yahoo! Messenger screen namejobTitle - the user's new job titlegroupIds - the primary keys of the user's groupsorganizationIds - the primary keys of the user's organizationsroleIds - the primary keys of the user's rolesuserGroupRoles - the user user's group rolesuserGroupIds - the primary keys of the user's user groupsserviceContext - the service context to be applied (optionally
null). Can set the UUID (with the uuid
attribute), asset category IDs, asset tag names, and expando
bridge attributes for the user.PortalException - if a user with the primary key could not be
found, if the new information was invalid, if the current user
did not have permission to update the user, or if the operation
was not allowed by the membership policyUser updateUser(long userId, java.lang.String oldPassword, java.lang.String newPassword1, java.lang.String newPassword2, boolean passwordReset, java.lang.String reminderQueryQuestion, java.lang.String reminderQueryAnswer, java.lang.String screenName, java.lang.String emailAddress, long facebookId, java.lang.String openId, boolean portrait, byte[] portraitBytes, java.lang.String languageId, java.lang.String timeZoneId, java.lang.String greeting, java.lang.String comments, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName, long prefixId, long suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, java.lang.String smsSn, java.lang.String aimSn, java.lang.String facebookSn, java.lang.String icqSn, java.lang.String jabberSn, java.lang.String msnSn, java.lang.String mySpaceSn, java.lang.String skypeSn, java.lang.String twitterSn, java.lang.String ymSn, java.lang.String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, java.util.List<UserGroupRole> userGroupRoles, long[] userGroupIds, java.util.List<Address> addresses, java.util.List<EmailAddress> emailAddresses, java.util.List<Phone> phones, java.util.List<Website> websites, java.util.List<AnnouncementsDelivery> announcementsDelivers, ServiceContext serviceContext) throws PortalException
userId - the primary key of the useroldPassword - the user's old passwordnewPassword1 - the user's new password (optionally
null)newPassword2 - the user's new password confirmation (optionally
null)passwordReset - whether the user should be asked to reset their
password the next time they loginreminderQueryQuestion - the user's new password reset questionreminderQueryAnswer - the user's new password reset answerscreenName - the user's new screen nameemailAddress - the user's new email addressfacebookId - the user's new Facebook IDopenId - the user's new OpenIDportrait - whether to update the user's portrait imageportraitBytes - the new portrait image datalanguageId - the user's new language IDtimeZoneId - the user's new time zone IDgreeting - the user's new greetingcomments - the user's new commentsfirstName - the user's new first namemiddleName - the user's new middle namelastName - the user's new last nameprefixId - the user's new name prefix IDsuffixId - the user's new name suffix IDmale - whether user is malebirthdayMonth - the user's new birthday month (0-based, meaning 0
for January)birthdayDay - the user's new birthday daybirthdayYear - the user's birthday yearsmsSn - the user's new SMS screen nameaimSn - the user's new AIM screen namefacebookSn - the user's new Facebook screen nameicqSn - the user's new ICQ screen namejabberSn - the user's new Jabber screen namemsnSn - the user's new MSN screen namemySpaceSn - the user's new MySpace screen nameskypeSn - the user's new Skype screen nametwitterSn - the user's new Twitter screen nameymSn - the user's new Yahoo! Messenger 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 (optionally
null). Can set the UUID (with the uuid
attribute), asset category IDs, asset tag names, and expando
bridge attributes for the user.PortalException - if a user with the primary key could not be
found, if the new information was invalid, if the current user
did not have permission to update the user, or if the operation
was not allowed by the membership policy