com.liferay.portal.service
Class UserServiceUtil

java.lang.Object
  com.liferay.portal.service.UserServiceUtil

public class UserServiceUtil
extends java.lang.Object

View Source

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

This class provides static methods for the com.liferay.portal.service.UserService bean. The static methods of this class calls the same methods of the bean instance. It's convenient to be able to just write one line to call a method on a bean instead of writing a lookup call and a method call.

Author:

Brian Wing Shun Chan

See Also:

UserService

Constructor Summary

UserServiceUtil()

Method Summary

static void	addGroupUsers(long groupId, long[] userIds)
static void	addOrganizationUsers(long organizationId, long[] userIds)
static void	addPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
static void	addRoleUsers(long roleId, long[] userIds)
static User	addUser(long companyId, boolean autoPassword, java.lang.String password1, java.lang.String password2, boolean autoScreenName, java.lang.String screenName, java.lang.String emailAddress, java.lang.String openId, java.util.Locale locale, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName, int prefixId, int suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, java.lang.String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, 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)
static User	addUser(long companyId, boolean autoPassword, java.lang.String password1, java.lang.String password2, boolean autoScreenName, java.lang.String screenName, java.lang.String emailAddress, java.lang.String openId, java.util.Locale locale, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName, int prefixId, int 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)
static void	addUserGroupUsers(long userGroupId, long[] userIds)
static void	deletePortrait(long userId)
static void	deleteRoleUser(long roleId, long userId)
static void	deleteUser(long userId)
static long	getDefaultUserId(long companyId)
static long[]	getGroupUserIds(long groupId)
static long[]	getOrganizationUserIds(long organizationId)
static long[]	getRoleUserIds(long roleId)
static UserService	getService()
static User	getUserByEmailAddress(long companyId, java.lang.String emailAddress)
static User	getUserById(long userId)
static User	getUserByScreenName(long companyId, java.lang.String screenName)
static long	getUserIdByEmailAddress(long companyId, java.lang.String emailAddress)
static long	getUserIdByScreenName(long companyId, java.lang.String screenName)
static boolean	hasGroupUser(long groupId, long userId)
static boolean	hasRoleUser(long roleId, long userId)
static void	setRoleUsers(long roleId, long[] userIds)
void	setService(UserService service)
static void	setUserGroupUsers(long userGroupId, long[] userIds)
static void	unsetGroupUsers(long groupId, long[] userIds)
static void	unsetOrganizationUsers(long organizationId, long[] userIds)
static void	unsetPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
static void	unsetRoleUsers(long roleId, long[] userIds)
static void	unsetUserGroupUsers(long userGroupId, long[] userIds)
static User	updateActive(long userId, boolean active)
static User	updateAgreedToTermsOfUse(long userId, boolean agreedToTermsOfUse)
static void	updateEmailAddress(long userId, java.lang.String password, java.lang.String emailAddress1, java.lang.String emailAddress2)
static User	updateLockout(long userId, boolean lockout)
static void	updateOpenId(long userId, java.lang.String openId)
static void	updateOrganizations(long userId, long[] organizationIds)
static User	updatePassword(long userId, java.lang.String password1, java.lang.String password2, boolean passwordReset)
static void	updatePortrait(long userId, byte[] bytes)
static void	updateReminderQuery(long userId, java.lang.String question, java.lang.String answer)
static void	updateScreenName(long userId, java.lang.String screenName)
static 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, 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, int prefixId, int 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)
static 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, 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, int prefixId, int 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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserServiceUtil

public UserServiceUtil()

Method Detail

addGroupUsers

public static void addGroupUsers(long groupId,
                                 long[] userIds)
                          throws com.liferay.portal.PortalException,
                                 com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

addOrganizationUsers

public static void addOrganizationUsers(long organizationId,
                                        long[] userIds)
                                 throws com.liferay.portal.PortalException,
                                        com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

addPasswordPolicyUsers

public static void addPasswordPolicyUsers(long passwordPolicyId,
                                          long[] userIds)
                                   throws com.liferay.portal.PortalException,
                                          com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

addRoleUsers

public static void addRoleUsers(long roleId,
                                long[] userIds)
                         throws com.liferay.portal.PortalException,
                                com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

addUserGroupUsers

public static void addUserGroupUsers(long userGroupId,
                                     long[] userIds)
                              throws com.liferay.portal.PortalException,
                                     com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

addUser

public static User addUser(long companyId,
                           boolean autoPassword,
                           java.lang.String password1,
                           java.lang.String password2,
                           boolean autoScreenName,
                           java.lang.String screenName,
                           java.lang.String emailAddress,
                           java.lang.String openId,
                           java.util.Locale locale,
                           java.lang.String firstName,
                           java.lang.String middleName,
                           java.lang.String lastName,
                           int prefixId,
                           int 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 com.liferay.portal.PortalException,
                           com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

addUser

public static User addUser(long companyId,
                           boolean autoPassword,
                           java.lang.String password1,
                           java.lang.String password2,
                           boolean autoScreenName,
                           java.lang.String screenName,
                           java.lang.String emailAddress,
                           java.lang.String openId,
                           java.util.Locale locale,
                           java.lang.String firstName,
                           java.lang.String middleName,
                           java.lang.String lastName,
                           int prefixId,
                           int suffixId,
                           boolean male,
                           int birthdayMonth,
                           int birthdayDay,
                           int birthdayYear,
                           java.lang.String jobTitle,
                           long[] groupIds,
                           long[] organizationIds,
                           long[] roleIds,
                           long[] userGroupIds,
                           boolean sendEmail,
                           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 com.liferay.portal.PortalException,
                           com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

deletePortrait

public static void deletePortrait(long userId)
                           throws com.liferay.portal.PortalException,
                                  com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

deleteRoleUser

public static void deleteRoleUser(long roleId,
                                  long userId)
                           throws com.liferay.portal.PortalException,
                                  com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

deleteUser

public static void deleteUser(long userId)
                       throws com.liferay.portal.PortalException,
                              com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getDefaultUserId

public static long getDefaultUserId(long companyId)
                             throws com.liferay.portal.PortalException,
                                    com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getGroupUserIds

public static long[] getGroupUserIds(long groupId)
                              throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

getOrganizationUserIds

public static long[] getOrganizationUserIds(long organizationId)
                                     throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

getRoleUserIds

public static long[] getRoleUserIds(long roleId)
                             throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

getUserByEmailAddress

public static User getUserByEmailAddress(long companyId,
                                         java.lang.String emailAddress)
                                  throws com.liferay.portal.PortalException,
                                         com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getUserById

public static User getUserById(long userId)
                        throws com.liferay.portal.PortalException,
                               com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getUserByScreenName

public static User getUserByScreenName(long companyId,
                                       java.lang.String screenName)
                                throws com.liferay.portal.PortalException,
                                       com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getUserIdByEmailAddress

public static long getUserIdByEmailAddress(long companyId,
                                           java.lang.String emailAddress)
                                    throws com.liferay.portal.PortalException,
                                           com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getUserIdByScreenName

public static long getUserIdByScreenName(long companyId,
                                         java.lang.String screenName)
                                  throws com.liferay.portal.PortalException,
                                         com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

hasGroupUser

public static boolean hasGroupUser(long groupId,
                                   long userId)
                            throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

hasRoleUser

public static boolean hasRoleUser(long roleId,
                                  long userId)
                           throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

setRoleUsers

public static void setRoleUsers(long roleId,
                                long[] userIds)
                         throws com.liferay.portal.PortalException,
                                com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

setUserGroupUsers

public static void setUserGroupUsers(long userGroupId,
                                     long[] userIds)
                              throws com.liferay.portal.PortalException,
                                     com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

unsetGroupUsers

public static void unsetGroupUsers(long groupId,
                                   long[] userIds)
                            throws com.liferay.portal.PortalException,
                                   com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

unsetOrganizationUsers

public static void unsetOrganizationUsers(long organizationId,
                                          long[] userIds)
                                   throws com.liferay.portal.PortalException,
                                          com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

unsetPasswordPolicyUsers

public static void unsetPasswordPolicyUsers(long passwordPolicyId,
                                            long[] userIds)
                                     throws com.liferay.portal.PortalException,
                                            com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

unsetRoleUsers

public static void unsetRoleUsers(long roleId,
                                  long[] userIds)
                           throws com.liferay.portal.PortalException,
                                  com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

unsetUserGroupUsers

public static void unsetUserGroupUsers(long userGroupId,
                                       long[] userIds)
                                throws com.liferay.portal.PortalException,
                                       com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateActive

public static User updateActive(long userId,
                                boolean active)
                         throws com.liferay.portal.PortalException,
                                com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateAgreedToTermsOfUse

public static User updateAgreedToTermsOfUse(long userId,
                                            boolean agreedToTermsOfUse)
                                     throws com.liferay.portal.PortalException,
                                            com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateEmailAddress

public static void updateEmailAddress(long userId,
                                      java.lang.String password,
                                      java.lang.String emailAddress1,
                                      java.lang.String emailAddress2)
                               throws com.liferay.portal.PortalException,
                                      com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateLockout

public static User updateLockout(long userId,
                                 boolean lockout)
                          throws com.liferay.portal.PortalException,
                                 com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateOpenId

public static void updateOpenId(long userId,
                                java.lang.String openId)
                         throws com.liferay.portal.PortalException,
                                com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateOrganizations

public static void updateOrganizations(long userId,
                                       long[] organizationIds)
                                throws com.liferay.portal.PortalException,
                                       com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updatePassword

public static User updatePassword(long userId,
                                  java.lang.String password1,
                                  java.lang.String password2,
                                  boolean passwordReset)
                           throws com.liferay.portal.PortalException,
                                  com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updatePortrait

public static void updatePortrait(long userId,
                                  byte[] bytes)
                           throws com.liferay.portal.PortalException,
                                  com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateReminderQuery

public static void updateReminderQuery(long userId,
                                       java.lang.String question,
                                       java.lang.String answer)
                                throws com.liferay.portal.PortalException,
                                       com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateScreenName

public static void updateScreenName(long userId,
                                    java.lang.String screenName)
                             throws com.liferay.portal.PortalException,
                                    com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateUser

public static 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,
                              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,
                              int prefixId,
                              int 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 com.liferay.portal.PortalException,
                              com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateUser

public static 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,
                              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,
                              int prefixId,
                              int 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 com.liferay.portal.PortalException,
                              com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getService

public static UserService getService()

setService

public void setService(UserService service)