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 |
addOrganizationUsers(long organizationId,
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[] organizationIds,
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)
|
long |
getUserIdByEmailAddress(long companyId,
java.lang.String emailAddress)
|
long |
getUserIdByScreenName(long companyId,
java.lang.String screenName)
|
boolean |
hasGroupUser(long groupId,
long userId)
|
boolean |
hasRoleUser(long roleId,
long userId)
|
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 |
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[] organizationIds)
|
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 oldPassword,
boolean passwordReset,
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[] organizationIds)
|
User |
updateUser(long userId,
java.lang.String oldPassword,
java.lang.String newPassword1,
java.lang.String newPassword2,
boolean passwordReset,
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[] organizationIds)
|
addGroupUsers
public void addGroupUsers(long groupId,
long[] userIds)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
addOrganizationUsers
public void addOrganizationUsers(long organizationId,
long[] userIds)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
addPasswordPolicyUsers
public void addPasswordPolicyUsers(long passwordPolicyId,
long[] userIds)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
addRoleUsers
public void addRoleUsers(long roleId,
long[] userIds)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
addUserGroupUsers
public void addUserGroupUsers(long userGroupId,
long[] userIds)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
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[] organizationIds,
boolean sendEmail)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
deleteRoleUser
public void deleteRoleUser(long roleId,
long userId)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
deleteUser
public void deleteUser(long userId)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
getDefaultUserId
public long getDefaultUserId(long companyId)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
getGroupUsers
public java.util.List getGroupUsers(long groupId)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
getRoleUsers
public java.util.List getRoleUsers(long roleId)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
getUserByEmailAddress
public User getUserByEmailAddress(long companyId,
java.lang.String emailAddress)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
getUserById
public User getUserById(long userId)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
getUserByScreenName
public User getUserByScreenName(long companyId,
java.lang.String screenName)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
getUserIdByEmailAddress
public long getUserIdByEmailAddress(long companyId,
java.lang.String emailAddress)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
getUserIdByScreenName
public long getUserIdByScreenName(long companyId,
java.lang.String screenName)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
hasGroupUser
public boolean hasGroupUser(long groupId,
long userId)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
hasRoleUser
public boolean hasRoleUser(long roleId,
long userId)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
setRoleUsers
public void setRoleUsers(long roleId,
long[] userIds)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
setUserGroupUsers
public void setUserGroupUsers(long userGroupId,
long[] userIds)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
unsetGroupUsers
public void unsetGroupUsers(long groupId,
long[] userIds)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
unsetOrganizationUsers
public void unsetOrganizationUsers(long organizationId,
long[] userIds)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
unsetPasswordPolicyUsers
public void unsetPasswordPolicyUsers(long passwordPolicyId,
long[] userIds)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
unsetRoleUsers
public void unsetRoleUsers(long roleId,
long[] userIds)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
unsetUserGroupUsers
public void unsetUserGroupUsers(long userGroupId,
long[] userIds)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
updateActive
public User updateActive(long userId,
boolean active)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
updateAgreedToTermsOfUse
public User updateAgreedToTermsOfUse(long userId,
boolean agreedToTermsOfUse)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
updateLockout
public User updateLockout(long userId,
boolean lockout)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
updateOrganizations
public void updateOrganizations(long userId,
long[] organizationIds)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
updatePassword
public User updatePassword(long userId,
java.lang.String password1,
java.lang.String password2,
boolean passwordReset)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
updatePortrait
public void updatePortrait(long userId,
byte[] bytes)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
updateUser
public User updateUser(long userId,
java.lang.String oldPassword,
boolean passwordReset,
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[] organizationIds)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
updateUser
public User updateUser(long userId,
java.lang.String oldPassword,
java.lang.String newPassword1,
java.lang.String newPassword2,
boolean passwordReset,
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[] organizationIds)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException,
com.liferay.portal.PortalException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException