com.liferay.portal.service
Interface UserService

All Known Implementing Classes:

UserServiceBaseImpl, UserServiceImpl, UserServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface UserService

The interface for the user remote service.

Never modify or reference this interface directly. Always use UserServiceUtil to access the user remote service. Add custom service methods to UserServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

See Also:

UserServiceUtil, UserServiceBaseImpl, UserServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

void	addGroupUsers(long groupId, long[] userIds)
void	addOrganizationUsers(long organizationId, long[] userIds)
void	addPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
void	addRoleUsers(long roleId, long[] userIds)
void	addTeamUsers(long teamId, long[] userIds)
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, int prefixId, int suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, List<Address> addresses, List<EmailAddress> emailAddresses, List<Phone> phones, List<Website> websites, List<AnnouncementsDelivery> announcementsDelivers, ServiceContext serviceContext)
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, int prefixId, int suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, ServiceContext serviceContext)
void	addUserGroupUsers(long userGroupId, long[] userIds)
void	deletePortrait(long userId)
void	deleteRoleUser(long roleId, long userId)
void	deleteUser(long userId)
long	getDefaultUserId(long companyId)
long[]	getGroupUserIds(long groupId)
long[]	getOrganizationUserIds(long organizationId)
long[]	getRoleUserIds(long roleId)
User	getUserByEmailAddress(long companyId, String emailAddress)
User	getUserById(long userId)
User	getUserByScreenName(long companyId, String screenName)
long	getUserIdByEmailAddress(long companyId, String emailAddress)
long	getUserIdByScreenName(long companyId, String screenName)
boolean	hasGroupUser(long groupId, long userId)
boolean	hasRoleUser(long roleId, long userId)
boolean	hasRoleUser(long companyId, String name, long userId, boolean inherited)
void	setRoleUsers(long roleId, long[] userIds)
void	setUserGroupUsers(long userGroupId, long[] userIds)
void	unsetGroupUsers(long groupId, long[] userIds)
void	unsetOrganizationUsers(long organizationId, long[] userIds)
void	unsetPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
void	unsetRoleUsers(long roleId, long[] userIds)
void	unsetTeamUsers(long teamId, long[] userIds)
void	unsetUserGroupUsers(long userGroupId, long[] userIds)
User	updateActive(long userId, boolean active)
User	updateAgreedToTermsOfUse(long userId, boolean agreedToTermsOfUse)
void	updateEmailAddress(long userId, String password, String emailAddress1, String emailAddress2)
User	updateLockout(long userId, boolean lockout)
void	updateOpenId(long userId, String openId)
void	updateOrganizations(long userId, long[] organizationIds)
User	updatePassword(long userId, String password1, String password2, boolean passwordReset)
void	updatePortrait(long userId, byte[] bytes)
void	updateReminderQuery(long userId, String question, String answer)
void	updateScreenName(long userId, String screenName)
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, int prefixId, int suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String smsSn, String aimSn, String facebookSn, String icqSn, String jabberSn, String msnSn, String mySpaceSn, String skypeSn, String twitterSn, String ymSn, 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)
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, int prefixId, int suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String smsSn, String aimSn, String facebookSn, String icqSn, String jabberSn, String msnSn, String mySpaceSn, String skypeSn, String twitterSn, String ymSn, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, List<UserGroupRole> userGroupRoles, long[] userGroupIds, ServiceContext serviceContext)

Method Detail

addGroupUsers

void addGroupUsers(long groupId,
                   long[] userIds)
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

addOrganizationUsers

void addOrganizationUsers(long organizationId,
                          long[] userIds)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

addPasswordPolicyUsers

void addPasswordPolicyUsers(long passwordPolicyId,
                            long[] userIds)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

addRoleUsers

void addRoleUsers(long roleId,
                  long[] userIds)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

addTeamUsers

void addTeamUsers(long teamId,
                  long[] userIds)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

addUserGroupUsers

void addUserGroupUsers(long userGroupId,
                       long[] userIds)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

addUser

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,
             int prefixId,
             int suffixId,
             boolean male,
             int birthdayMonth,
             int birthdayDay,
             int birthdayYear,
             String jobTitle,
             long[] groupIds,
             long[] organizationIds,
             long[] roleIds,
             long[] userGroupIds,
             boolean sendEmail,
             ServiceContext serviceContext)
             throws PortalException,
                    SystemException

Throws:

PortalException

SystemException

addUser

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,
             int prefixId,
             int suffixId,
             boolean male,
             int birthdayMonth,
             int birthdayDay,
             int birthdayYear,
             String jobTitle,
             long[] groupIds,
             long[] organizationIds,
             long[] roleIds,
             long[] userGroupIds,
             boolean sendEmail,
             List<Address> addresses,
             List<EmailAddress> emailAddresses,
             List<Phone> phones,
             List<Website> websites,
             List<AnnouncementsDelivery> announcementsDelivers,
             ServiceContext serviceContext)
             throws PortalException,
                    SystemException

Throws:

PortalException

SystemException

deletePortrait

void deletePortrait(long userId)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

deleteRoleUser

void deleteRoleUser(long roleId,
                    long userId)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

deleteUser

void deleteUser(long userId)
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

getDefaultUserId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getDefaultUserId(long companyId)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

getGroupUserIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long[] getGroupUserIds(long groupId)
                       throws SystemException

Throws:

SystemException

getOrganizationUserIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long[] getOrganizationUserIds(long organizationId)
                              throws SystemException

Throws:

SystemException

getRoleUserIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long[] getRoleUserIds(long roleId)
                      throws SystemException

Throws:

SystemException

getUserByEmailAddress

@Transactional(propagation=SUPPORTS,
               readOnly=true)
User getUserByEmailAddress(long companyId,
                                                                    String emailAddress)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

getUserById

@Transactional(propagation=SUPPORTS,
               readOnly=true)
User getUserById(long userId)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

getUserByScreenName

@Transactional(propagation=SUPPORTS,
               readOnly=true)
User getUserByScreenName(long companyId,
                                                                  String screenName)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

getUserIdByEmailAddress

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getUserIdByEmailAddress(long companyId,
                                                                      String emailAddress)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

getUserIdByScreenName

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getUserIdByScreenName(long companyId,
                                                                    String screenName)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

hasGroupUser

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasGroupUser(long groupId,
                                                              long userId)
                     throws SystemException

Throws:

SystemException

hasRoleUser

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasRoleUser(long roleId,
                                                             long userId)
                    throws SystemException

Throws:

SystemException

hasRoleUser

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasRoleUser(long companyId,
                                                             String name,
                                                             long userId,
                                                             boolean inherited)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

setRoleUsers

void setRoleUsers(long roleId,
                  long[] userIds)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

setUserGroupUsers

void setUserGroupUsers(long userGroupId,
                       long[] userIds)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

unsetGroupUsers

void unsetGroupUsers(long groupId,
                     long[] userIds)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

unsetOrganizationUsers

void unsetOrganizationUsers(long organizationId,
                            long[] userIds)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

unsetPasswordPolicyUsers

void unsetPasswordPolicyUsers(long passwordPolicyId,
                              long[] userIds)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

unsetRoleUsers

void unsetRoleUsers(long roleId,
                    long[] userIds)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

unsetTeamUsers

void unsetTeamUsers(long teamId,
                    long[] userIds)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

unsetUserGroupUsers

void unsetUserGroupUsers(long userGroupId,
                         long[] userIds)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

updateActive

User updateActive(long userId,
                  boolean active)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

updateAgreedToTermsOfUse

User updateAgreedToTermsOfUse(long userId,
                              boolean agreedToTermsOfUse)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

updateEmailAddress

void updateEmailAddress(long userId,
                        String password,
                        String emailAddress1,
                        String emailAddress2)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

updateLockout

User updateLockout(long userId,
                   boolean lockout)
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

updateOpenId

void updateOpenId(long userId,
                  String openId)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

updateOrganizations

void updateOrganizations(long userId,
                         long[] organizationIds)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

updatePassword

User updatePassword(long userId,
                    String password1,
                    String password2,
                    boolean passwordReset)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

updatePortrait

void updatePortrait(long userId,
                    byte[] bytes)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

updateReminderQuery

void updateReminderQuery(long userId,
                         String question,
                         String answer)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

updateScreenName

void updateScreenName(long userId,
                      String screenName)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

updateUser

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,
                int prefixId,
                int suffixId,
                boolean male,
                int birthdayMonth,
                int birthdayDay,
                int birthdayYear,
                String smsSn,
                String aimSn,
                String facebookSn,
                String icqSn,
                String jabberSn,
                String msnSn,
                String mySpaceSn,
                String skypeSn,
                String twitterSn,
                String ymSn,
                String jobTitle,
                long[] groupIds,
                long[] organizationIds,
                long[] roleIds,
                List<UserGroupRole> userGroupRoles,
                long[] userGroupIds,
                ServiceContext serviceContext)
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

updateUser

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,
                int prefixId,
                int suffixId,
                boolean male,
                int birthdayMonth,
                int birthdayDay,
                int birthdayYear,
                String smsSn,
                String aimSn,
                String facebookSn,
                String icqSn,
                String jabberSn,
                String msnSn,
                String mySpaceSn,
                String skypeSn,
                String twitterSn,
                String ymSn,
                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,
                       SystemException

Throws:

PortalException

SystemException