Liferay 6.0.5

com.liferay.portal.service
Class UserServiceUtil

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

public class UserServiceUtil
extends Object

The utility for the user remote service. This utility wraps UserServiceImpl and is the primary access point for service operations in application layer code running on a remote server.

Never modify this class directly. Add custom service methods to UserServiceImpl and rerun ServiceBuilder to regenerate this class.

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:
UserService, UserServiceBaseImpl, UserServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

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 void addTeamUsers(long teamId, long[] userIds)
           
static User addUser(long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, long facebookId, String openId, Locale locale, String firstName, String middleName, String lastName, 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)
           
static User addUser(long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, long facebookId, String openId, Locale locale, String firstName, String middleName, String lastName, 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)
           
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, String emailAddress)
           
static User getUserById(long userId)
           
static User getUserByScreenName(long companyId, String screenName)
           
static long getUserIdByEmailAddress(long companyId, String emailAddress)
           
static long getUserIdByScreenName(long companyId, String screenName)
           
static boolean hasGroupUser(long groupId, long userId)
           
static boolean hasRoleUser(long roleId, long userId)
           
static boolean hasRoleUser(long companyId, String name, long userId, boolean inherited)
           
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 unsetTeamUsers(long teamId, 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, String password, String emailAddress1, String emailAddress2)
           
static User updateLockout(long userId, boolean lockout)
           
static void updateOpenId(long userId, String openId)
           
static void updateOrganizations(long userId, long[] organizationIds)
           
static User updatePassword(long userId, String password1, String password2, boolean passwordReset)
           
static void updatePortrait(long userId, byte[] bytes)
           
static void updateReminderQuery(long userId, String question, String answer)
           
static void updateScreenName(long userId, String screenName)
           
static User updateUser(long userId, String oldPassword, String newPassword1, String newPassword2, boolean passwordReset, String reminderQueryQuestion, String reminderQueryAnswer, String screenName, String emailAddress, long facebookId, String openId, String languageId, String timeZoneId, String greeting, String comments, String firstName, String middleName, String lastName, 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)
           
static User updateUser(long userId, String oldPassword, String newPassword1, String newPassword2, boolean passwordReset, String reminderQueryQuestion, String reminderQueryAnswer, String screenName, String emailAddress, long facebookId, String openId, String languageId, String timeZoneId, String greeting, String comments, String firstName, String middleName, String lastName, 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)
           
 
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 PortalException,
                                 SystemException
Throws:
PortalException
SystemException

addOrganizationUsers

public static void addOrganizationUsers(long organizationId,
                                        long[] userIds)
                                 throws PortalException,
                                        SystemException
Throws:
PortalException
SystemException

addPasswordPolicyUsers

public static void addPasswordPolicyUsers(long passwordPolicyId,
                                          long[] userIds)
                                   throws PortalException,
                                          SystemException
Throws:
PortalException
SystemException

addRoleUsers

public static void addRoleUsers(long roleId,
                                long[] userIds)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

addTeamUsers

public static void addTeamUsers(long teamId,
                                long[] userIds)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

addUserGroupUsers

public static void addUserGroupUsers(long userGroupId,
                                     long[] userIds)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

addUser

public static User addUser(long companyId,
                           boolean autoPassword,
                           String password1,
                           String password2,
                           boolean autoScreenName,
                           String screenName,
                           String emailAddress,
                           long facebookId,
                           String openId,
                           Locale locale,
                           String firstName,
                           String middleName,
                           String lastName,
                           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

public static User addUser(long companyId,
                           boolean autoPassword,
                           String password1,
                           String password2,
                           boolean autoScreenName,
                           String screenName,
                           String emailAddress,
                           long facebookId,
                           String openId,
                           Locale locale,
                           String firstName,
                           String middleName,
                           String lastName,
                           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

public static void deletePortrait(long userId)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

deleteRoleUser

public static void deleteRoleUser(long roleId,
                                  long userId)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

deleteUser

public static void deleteUser(long userId)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

getDefaultUserId

public static long getDefaultUserId(long companyId)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

getGroupUserIds

public static long[] getGroupUserIds(long groupId)
                              throws SystemException
Throws:
SystemException

getOrganizationUserIds

public static long[] getOrganizationUserIds(long organizationId)
                                     throws SystemException
Throws:
SystemException

getRoleUserIds

public static long[] getRoleUserIds(long roleId)
                             throws SystemException
Throws:
SystemException

getUserByEmailAddress

public static User getUserByEmailAddress(long companyId,
                                         String emailAddress)
                                  throws PortalException,
                                         SystemException
Throws:
PortalException
SystemException

getUserById

public static User getUserById(long userId)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

getUserByScreenName

public static User getUserByScreenName(long companyId,
                                       String screenName)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

getUserIdByEmailAddress

public static long getUserIdByEmailAddress(long companyId,
                                           String emailAddress)
                                    throws PortalException,
                                           SystemException
Throws:
PortalException
SystemException

getUserIdByScreenName

public static long getUserIdByScreenName(long companyId,
                                         String screenName)
                                  throws PortalException,
                                         SystemException
Throws:
PortalException
SystemException

hasGroupUser

public static boolean hasGroupUser(long groupId,
                                   long userId)
                            throws SystemException
Throws:
SystemException

hasRoleUser

public static boolean hasRoleUser(long roleId,
                                  long userId)
                           throws SystemException
Throws:
SystemException

hasRoleUser

public static boolean hasRoleUser(long companyId,
                                  String name,
                                  long userId,
                                  boolean inherited)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

setRoleUsers

public static void setRoleUsers(long roleId,
                                long[] userIds)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

setUserGroupUsers

public static void setUserGroupUsers(long userGroupId,
                                     long[] userIds)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

unsetGroupUsers

public static void unsetGroupUsers(long groupId,
                                   long[] userIds)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

unsetOrganizationUsers

public static void unsetOrganizationUsers(long organizationId,
                                          long[] userIds)
                                   throws PortalException,
                                          SystemException
Throws:
PortalException
SystemException

unsetPasswordPolicyUsers

public static void unsetPasswordPolicyUsers(long passwordPolicyId,
                                            long[] userIds)
                                     throws PortalException,
                                            SystemException
Throws:
PortalException
SystemException

unsetRoleUsers

public static void unsetRoleUsers(long roleId,
                                  long[] userIds)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

unsetTeamUsers

public static void unsetTeamUsers(long teamId,
                                  long[] userIds)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

unsetUserGroupUsers

public static void unsetUserGroupUsers(long userGroupId,
                                       long[] userIds)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

updateActive

public static User updateActive(long userId,
                                boolean active)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

updateAgreedToTermsOfUse

public static User updateAgreedToTermsOfUse(long userId,
                                            boolean agreedToTermsOfUse)
                                     throws PortalException,
                                            SystemException
Throws:
PortalException
SystemException

updateEmailAddress

public static void updateEmailAddress(long userId,
                                      String password,
                                      String emailAddress1,
                                      String emailAddress2)
                               throws PortalException,
                                      SystemException
Throws:
PortalException
SystemException

updateLockout

public static User updateLockout(long userId,
                                 boolean lockout)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

updateOpenId

public static void updateOpenId(long userId,
                                String openId)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

updateOrganizations

public static void updateOrganizations(long userId,
                                       long[] organizationIds)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

updatePassword

public static User updatePassword(long userId,
                                  String password1,
                                  String password2,
                                  boolean passwordReset)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

updatePortrait

public static void updatePortrait(long userId,
                                  byte[] bytes)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

updateReminderQuery

public static void updateReminderQuery(long userId,
                                       String question,
                                       String answer)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

updateScreenName

public static void updateScreenName(long userId,
                                    String screenName)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

updateUser

public static User updateUser(long userId,
                              String oldPassword,
                              String newPassword1,
                              String newPassword2,
                              boolean passwordReset,
                              String reminderQueryQuestion,
                              String reminderQueryAnswer,
                              String screenName,
                              String emailAddress,
                              long facebookId,
                              String openId,
                              String languageId,
                              String timeZoneId,
                              String greeting,
                              String comments,
                              String firstName,
                              String middleName,
                              String lastName,
                              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

public static User updateUser(long userId,
                              String oldPassword,
                              String newPassword1,
                              String newPassword2,
                              boolean passwordReset,
                              String reminderQueryQuestion,
                              String reminderQueryAnswer,
                              String screenName,
                              String emailAddress,
                              long facebookId,
                              String openId,
                              String languageId,
                              String timeZoneId,
                              String greeting,
                              String comments,
                              String firstName,
                              String middleName,
                              String lastName,
                              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

getService

public static UserService getService()

setService

public void setService(UserService service)

Liferay 6.0.5