com.liferay.portal.service
Interface UserService


public interface UserService

View Source

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

This interface defines the service. The default implementation is com.liferay.portal.service.impl.UserServiceImpl. Modify methods in that class and rerun ServiceBuilder to populate this class and all other generated classes.

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.

Author:
Brian Wing Shun Chan
See Also:
UserServiceFactory, UserServiceUtil

Method Summary
 void addGroupUsers(long groupId, long[] userIds)
           
 void addPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
           
 void addRoleUsers(long roleId, long[] userIds)
           
 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.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 organizationId, long locationId, boolean sendEmail)
           
 void addUserGroupUsers(long userGroupId, long[] userIds)
           
 void deleteRoleUser(long roleId, long userId)
           
 void deleteUser(long userId)
           
 long getDefaultUserId(long companyId)
           
 java.util.List getGroupUsers(long groupId)
           
 java.util.List getRoleUsers(long roleId)
           
 User getUserByEmailAddress(long companyId, java.lang.String emailAddress)
           
 User getUserById(long userId)
           
 User getUserByScreenName(long companyId, java.lang.String screenName)
           
 boolean hasGroupUser(long groupId, long userId)
           
 boolean hasRoleUser(long roleId, long userId)
           
 void setGroupUsers(long groupId, long[] userIds)
           
 void setRoleUsers(long roleId, long[] userIds)
           
 void setUserGroupUsers(long userGroupId, long[] userIds)
           
 void unsetGroupUsers(long groupId, long[] userIds)
           
 void unsetPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
           
 void unsetRoleUsers(long roleId, long[] userIds)
           
 void unsetUserGroupUsers(long userGroupId, long[] userIds)
           
 User updateActive(long userId, boolean active)
           
 User updateAgreedToTermsOfUse(long userId, boolean agreedToTermsOfUse)
           
 User updateLockout(long userId, boolean lockout)
           
 void updateOrganizations(long userId, long organizationId, long locationId)
           
 User updatePassword(long userId, java.lang.String password1, java.lang.String password2, boolean passwordReset)
           
 void updatePortrait(long userId, byte[] bytes)
           
 User updateUser(long userId, java.lang.String password, java.lang.String screenName, java.lang.String emailAddress, 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 icqSn, java.lang.String jabberSn, java.lang.String msnSn, java.lang.String skypeSn, java.lang.String ymSn, java.lang.String jobTitle, long organizationId, long locationId)
           
 

Method Detail

addGroupUsers

public void addGroupUsers(long groupId,
                          long[] userIds)
                   throws com.liferay.portal.SystemException,
                          com.liferay.portal.PortalException,
                          java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

addPasswordPolicyUsers

public void addPasswordPolicyUsers(long passwordPolicyId,
                                   long[] userIds)
                            throws com.liferay.portal.SystemException,
                                   com.liferay.portal.PortalException,
                                   java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

addRoleUsers

public void addRoleUsers(long roleId,
                         long[] userIds)
                  throws com.liferay.portal.SystemException,
                         com.liferay.portal.PortalException,
                         java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

addUserGroupUsers

public void addUserGroupUsers(long userGroupId,
                              long[] userIds)
                       throws com.liferay.portal.SystemException,
                              com.liferay.portal.PortalException,
                              java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

addUser

public 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.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 organizationId,
                    long locationId,
                    boolean sendEmail)
             throws com.liferay.portal.SystemException,
                    com.liferay.portal.PortalException,
                    java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

deleteRoleUser

public void deleteRoleUser(long roleId,
                           long userId)
                    throws com.liferay.portal.SystemException,
                           com.liferay.portal.PortalException,
                           java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

deleteUser

public void deleteUser(long userId)
                throws com.liferay.portal.SystemException,
                       com.liferay.portal.PortalException,
                       java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getDefaultUserId

public long getDefaultUserId(long companyId)
                      throws com.liferay.portal.SystemException,
                             com.liferay.portal.PortalException,
                             java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getGroupUsers

public java.util.List getGroupUsers(long groupId)
                             throws com.liferay.portal.SystemException,
                                    com.liferay.portal.PortalException,
                                    java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getRoleUsers

public java.util.List getRoleUsers(long roleId)
                            throws com.liferay.portal.SystemException,
                                   com.liferay.portal.PortalException,
                                   java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getUserByEmailAddress

public User getUserByEmailAddress(long companyId,
                                  java.lang.String emailAddress)
                           throws com.liferay.portal.SystemException,
                                  com.liferay.portal.PortalException,
                                  java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getUserById

public User getUserById(long userId)
                 throws com.liferay.portal.SystemException,
                        com.liferay.portal.PortalException,
                        java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getUserByScreenName

public User getUserByScreenName(long companyId,
                                java.lang.String screenName)
                         throws com.liferay.portal.SystemException,
                                com.liferay.portal.PortalException,
                                java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

hasGroupUser

public boolean hasGroupUser(long groupId,
                            long userId)
                     throws com.liferay.portal.SystemException,
                            com.liferay.portal.PortalException,
                            java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

hasRoleUser

public boolean hasRoleUser(long roleId,
                           long userId)
                    throws com.liferay.portal.SystemException,
                           com.liferay.portal.PortalException,
                           java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

setGroupUsers

public void setGroupUsers(long groupId,
                          long[] userIds)
                   throws com.liferay.portal.SystemException,
                          com.liferay.portal.PortalException,
                          java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

setRoleUsers

public void setRoleUsers(long roleId,
                         long[] userIds)
                  throws com.liferay.portal.SystemException,
                         com.liferay.portal.PortalException,
                         java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

setUserGroupUsers

public void setUserGroupUsers(long userGroupId,
                              long[] userIds)
                       throws com.liferay.portal.SystemException,
                              com.liferay.portal.PortalException,
                              java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

unsetGroupUsers

public void unsetGroupUsers(long groupId,
                            long[] userIds)
                     throws com.liferay.portal.SystemException,
                            com.liferay.portal.PortalException,
                            java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

unsetPasswordPolicyUsers

public void unsetPasswordPolicyUsers(long passwordPolicyId,
                                     long[] userIds)
                              throws com.liferay.portal.SystemException,
                                     com.liferay.portal.PortalException,
                                     java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

unsetRoleUsers

public void unsetRoleUsers(long roleId,
                           long[] userIds)
                    throws com.liferay.portal.SystemException,
                           com.liferay.portal.PortalException,
                           java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

unsetUserGroupUsers

public void unsetUserGroupUsers(long userGroupId,
                                long[] userIds)
                         throws com.liferay.portal.SystemException,
                                com.liferay.portal.PortalException,
                                java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updateActive

public User updateActive(long userId,
                         boolean active)
                  throws com.liferay.portal.SystemException,
                         com.liferay.portal.PortalException,
                         java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updateAgreedToTermsOfUse

public User updateAgreedToTermsOfUse(long userId,
                                     boolean agreedToTermsOfUse)
                              throws com.liferay.portal.SystemException,
                                     com.liferay.portal.PortalException,
                                     java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updateLockout

public User updateLockout(long userId,
                          boolean lockout)
                   throws com.liferay.portal.SystemException,
                          com.liferay.portal.PortalException,
                          java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updateOrganizations

public void updateOrganizations(long userId,
                                long organizationId,
                                long locationId)
                         throws com.liferay.portal.SystemException,
                                com.liferay.portal.PortalException,
                                java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updatePassword

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

updatePortrait

public void updatePortrait(long userId,
                           byte[] bytes)
                    throws com.liferay.portal.SystemException,
                           com.liferay.portal.PortalException,
                           java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updateUser

public User updateUser(long userId,
                       java.lang.String password,
                       java.lang.String screenName,
                       java.lang.String emailAddress,
                       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 icqSn,
                       java.lang.String jabberSn,
                       java.lang.String msnSn,
                       java.lang.String skypeSn,
                       java.lang.String ymSn,
                       java.lang.String jobTitle,
                       long organizationId,
                       long locationId)
                throws com.liferay.portal.SystemException,
                       com.liferay.portal.PortalException,
                       java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException