/portal-service/src/com/liferay/portal/service/UserServiceWrapper.java
https://github.com/monicali/liferay-portal · Java · 1174 lines · 372 code · 48 blank · 754 comment · 0 complexity · 6838a7795313b89e55a200e6e347469b MD5 · raw file
- /**
- * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
- *
- * This library is free software; you can redistribute it and/or modify it under
- * the terms of the GNU Lesser General Public License as published by the Free
- * Software Foundation; either version 2.1 of the License, or (at your option)
- * any later version.
- *
- * This library is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
- * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
- * details.
- */
- package com.liferay.portal.service;
- /**
- * <p>
- * This class is a wrapper for {@link UserService}.
- * </p>
- *
- * @author Brian Wing Shun Chan
- * @see UserService
- * @generated
- */
- public class UserServiceWrapper implements UserService,
- ServiceWrapper<UserService> {
- public UserServiceWrapper(UserService userService) {
- _userService = userService;
- }
- /**
- * Adds the users to the group.
- *
- * @param groupId the primary key of the group
- * @param userIds the primary keys of the users
- * @throws PortalException if a group or user with the primary key could not
- be found, or if the user did not have permission to assign group
- members
- * @throws SystemException if a system exception occurred
- */
- public void addGroupUsers(long groupId, long[] userIds,
- com.liferay.portal.service.ServiceContext serviceContext)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- _userService.addGroupUsers(groupId, userIds, serviceContext);
- }
- /**
- * Adds the users to the organization.
- *
- * @param organizationId the primary key of the organization
- * @param userIds the primary keys of the users
- * @throws PortalException if an organization or user with the primary key
- could not be found, if the user did not have permission to assign
- organization members, or if current user did not have an
- organization in common with a given user
- * @throws SystemException if a system exception occurred
- */
- public void addOrganizationUsers(long organizationId, long[] userIds)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- _userService.addOrganizationUsers(organizationId, userIds);
- }
- /**
- * Assigns the password policy to the users, removing any other currently
- * assigned password policies.
- *
- * @param passwordPolicyId the primary key of the password policy
- * @param userIds the primary keys of the users
- * @throws PortalException if the user did not have permission to assign
- policy members
- * @throws SystemException if a system exception occurred
- */
- public void addPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- _userService.addPasswordPolicyUsers(passwordPolicyId, userIds);
- }
- /**
- * Adds the users to the role.
- *
- * @param roleId the primary key of the role
- * @param userIds the primary keys of the users
- * @throws PortalException if a role or user with the primary key could not
- be found or if the user did not have permission to assign role
- members
- * @throws SystemException if a system exception occurred
- */
- public void addRoleUsers(long roleId, long[] userIds)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- _userService.addRoleUsers(roleId, userIds);
- }
- /**
- * Adds the users to the team.
- *
- * @param teamId the primary key of the team
- * @param userIds the primary keys of the users
- * @throws PortalException if a team or user with the primary key could not
- be found or if the user did not have permission to assign team
- members
- * @throws SystemException if a system exception occurred
- */
- public void addTeamUsers(long teamId, long[] userIds)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- _userService.addTeamUsers(teamId, userIds);
- }
- /**
- * Adds a user.
- *
- * <p>
- * This method handles the creation and bookkeeping of the user including
- * its resources, metadata, and internal data structures. It is not
- * necessary to make subsequent calls to any methods to setup default
- * groups, resources, etc.
- * </p>
- *
- * @param companyId the primary key of the user's company
- * @param autoPassword whether a password should be automatically generated
- for the user
- * @param password1 the user's password
- * @param password2 the user's password confirmation
- * @param autoScreenName whether a screen name should be automatically
- generated for the user
- * @param screenName the user's screen name
- * @param emailAddress the user's email address
- * @param facebookId the user's facebook ID
- * @param openId the user's OpenID
- * @param locale the user's locale
- * @param firstName the user's first name
- * @param middleName the user's middle name
- * @param lastName the user's last name
- * @param prefixId the user's name prefix ID
- * @param suffixId the user's name suffix ID
- * @param male whether the user is male
- * @param birthdayMonth the user's birthday month (0-based, meaning 0 for
- January)
- * @param birthdayDay the user's birthday day
- * @param birthdayYear the user's birthday year
- * @param jobTitle the user's job title
- * @param groupIds the primary keys of the user's groups
- * @param organizationIds the primary keys of the user's organizations
- * @param roleIds the primary keys of the roles this user possesses
- * @param userGroupIds the primary keys of the user's user groups
- * @param sendEmail whether to send the user an email notification about
- their new account
- * @param serviceContext the user's service context (optionally
- <code>null</code>). Can set the universally unique identifier
- (with the <code>uuid</code> attribute), asset category IDs, asset
- tag names, and expando bridge attributes for the user.
- * @return the new user
- * @throws PortalException if the user's information was invalid, if the
- creator did not have permission to add users, or if the email
- address was reserved
- * @throws SystemException if a system exception occurred
- */
- public com.liferay.portal.model.User addUser(long companyId,
- boolean autoPassword, java.lang.String password1,
- java.lang.String password2, boolean autoScreenName,
- java.lang.String screenName, java.lang.String emailAddress,
- long facebookId, 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,
- com.liferay.portal.service.ServiceContext serviceContext)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.addUser(companyId, autoPassword, password1,
- password2, autoScreenName, screenName, emailAddress, facebookId,
- openId, locale, firstName, middleName, lastName, prefixId,
- suffixId, male, birthdayMonth, birthdayDay, birthdayYear, jobTitle,
- groupIds, organizationIds, roleIds, userGroupIds, sendEmail,
- serviceContext);
- }
- /**
- * Adds a user with additional parameters.
- *
- * <p>
- * This method handles the creation and bookkeeping of the user including
- * its resources, metadata, and internal data structures. It is not
- * necessary to make subsequent calls to any methods to setup default
- * groups, resources, etc.
- * </p>
- *
- * @param companyId the primary key of the user's company
- * @param autoPassword whether a password should be automatically generated
- for the user
- * @param password1 the user's password
- * @param password2 the user's password confirmation
- * @param autoScreenName whether a screen name should be automatically
- generated for the user
- * @param screenName the user's screen name
- * @param emailAddress the user's email address
- * @param facebookId the user's facebook ID
- * @param openId the user's OpenID
- * @param locale the user's locale
- * @param firstName the user's first name
- * @param middleName the user's middle name
- * @param lastName the user's last name
- * @param prefixId the user's name prefix ID
- * @param suffixId the user's name suffix ID
- * @param male whether the user is male
- * @param birthdayMonth the user's birthday month (0-based, meaning 0 for
- January)
- * @param birthdayDay the user's birthday day
- * @param birthdayYear the user's birthday year
- * @param jobTitle the user's job title
- * @param groupIds the primary keys of the user's groups
- * @param organizationIds the primary keys of the user's organizations
- * @param roleIds the primary keys of the roles this user possesses
- * @param userGroupIds the primary keys of the user's user groups
- * @param addresses the user's addresses
- * @param emailAddresses the user's email addresses
- * @param phones the user's phone numbers
- * @param websites the user's websites
- * @param announcementsDelivers the announcements deliveries
- * @param sendEmail whether to send the user an email notification about
- their new account
- * @param serviceContext the user's service context (optionally
- <code>null</code>). Can set the universally unique identifier
- (with the <code>uuid</code> attribute), asset category IDs, asset
- tag names, and expando bridge attributes for the user.
- * @return the new user
- * @throws PortalException if the user's information was invalid, if the
- creator did not have permission to add users, if the email
- address was reserved, or some other portal exception occurred
- * @throws SystemException if a system exception occurred
- */
- public com.liferay.portal.model.User addUser(long companyId,
- boolean autoPassword, java.lang.String password1,
- java.lang.String password2, boolean autoScreenName,
- java.lang.String screenName, java.lang.String emailAddress,
- long facebookId, 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,
- java.util.List<com.liferay.portal.model.Address> addresses,
- java.util.List<com.liferay.portal.model.EmailAddress> emailAddresses,
- java.util.List<com.liferay.portal.model.Phone> phones,
- java.util.List<com.liferay.portal.model.Website> websites,
- java.util.List<com.liferay.portlet.announcements.model.AnnouncementsDelivery> announcementsDelivers,
- boolean sendEmail,
- com.liferay.portal.service.ServiceContext serviceContext)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.addUser(companyId, autoPassword, password1,
- password2, autoScreenName, screenName, emailAddress, facebookId,
- openId, locale, firstName, middleName, lastName, prefixId,
- suffixId, male, birthdayMonth, birthdayDay, birthdayYear, jobTitle,
- groupIds, organizationIds, roleIds, userGroupIds, addresses,
- emailAddresses, phones, websites, announcementsDelivers, sendEmail,
- serviceContext);
- }
- /**
- * Adds the users to the user group.
- *
- * @param userGroupId the primary key of the user group
- * @param userIds the primary keys of the users
- * @throws PortalException if a user group or user with the primary could
- could not be found, or if the current user did not have
- permission to assign group members
- * @throws SystemException if a system exception occurred
- */
- public void addUserGroupUsers(long userGroupId, long[] userIds)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- _userService.addUserGroupUsers(userGroupId, userIds);
- }
- /**
- * Adds a user with workflow.
- *
- * <p>
- * This method handles the creation and bookkeeping of the user including
- * its resources, metadata, and internal data structures. It is not
- * necessary to make subsequent calls to any methods to setup default
- * groups, resources, etc.
- * </p>
- *
- * @param companyId the primary key of the user's company
- * @param autoPassword whether a password should be automatically generated
- for the user
- * @param password1 the user's password
- * @param password2 the user's password confirmation
- * @param autoScreenName whether a screen name should be automatically
- generated for the user
- * @param screenName the user's screen name
- * @param emailAddress the user's email address
- * @param facebookId the user's facebook ID
- * @param openId the user's OpenID
- * @param locale the user's locale
- * @param firstName the user's first name
- * @param middleName the user's middle name
- * @param lastName the user's last name
- * @param prefixId the user's name prefix ID
- * @param suffixId the user's name suffix ID
- * @param male whether the user is male
- * @param birthdayMonth the user's birthday month (0-based, meaning 0 for
- January)
- * @param birthdayDay the user's birthday day
- * @param birthdayYear the user's birthday year
- * @param jobTitle the user's job title
- * @param groupIds the primary keys of the user's groups
- * @param organizationIds the primary keys of the user's organizations
- * @param roleIds the primary keys of the roles this user possesses
- * @param userGroupIds the primary keys of the user's user groups
- * @param sendEmail whether to send the user an email notification about
- their new account
- * @param serviceContext the user's service context (optionally
- <code>null</code>). Can set the universally unique identifier
- (with the <code>uuid</code> attribute), asset category IDs, asset
- tag names, and expando bridge attributes for the user.
- * @return the new user
- * @throws PortalException if the user's information was invalid, if the
- creator did not have permission to add users, or if the email
- address was reserved
- * @throws SystemException if a system exception occurred
- */
- public com.liferay.portal.model.User addUserWithWorkflow(long companyId,
- boolean autoPassword, java.lang.String password1,
- java.lang.String password2, boolean autoScreenName,
- java.lang.String screenName, java.lang.String emailAddress,
- long facebookId, 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,
- com.liferay.portal.service.ServiceContext serviceContext)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.addUserWithWorkflow(companyId, autoPassword,
- password1, password2, autoScreenName, screenName, emailAddress,
- facebookId, openId, locale, firstName, middleName, lastName,
- prefixId, suffixId, male, birthdayMonth, birthdayDay, birthdayYear,
- jobTitle, groupIds, organizationIds, roleIds, userGroupIds,
- sendEmail, serviceContext);
- }
- /**
- * Adds a user with workflow and additional parameters.
- *
- * <p>
- * This method handles the creation and bookkeeping of the user including
- * its resources, metadata, and internal data structures. It is not
- * necessary to make subsequent calls to any methods to setup default
- * groups, resources, etc.
- * </p>
- *
- * @param companyId the primary key of the user's company
- * @param autoPassword whether a password should be automatically generated
- for the user
- * @param password1 the user's password
- * @param password2 the user's password confirmation
- * @param autoScreenName whether a screen name should be automatically
- generated for the user
- * @param screenName the user's screen name
- * @param emailAddress the user's email address
- * @param facebookId the user's facebook ID
- * @param openId the user's OpenID
- * @param locale the user's locale
- * @param firstName the user's first name
- * @param middleName the user's middle name
- * @param lastName the user's last name
- * @param prefixId the user's name prefix ID
- * @param suffixId the user's name suffix ID
- * @param male whether the user is male
- * @param birthdayMonth the user's birthday month (0-based, meaning 0 for
- January)
- * @param birthdayDay the user's birthday day
- * @param birthdayYear the user's birthday year
- * @param jobTitle the user's job title
- * @param groupIds the primary keys of the user's groups
- * @param organizationIds the primary keys of the user's organizations
- * @param roleIds the primary keys of the roles this user possesses
- * @param userGroupIds the primary keys of the user's user groups
- * @param addresses the user's addresses
- * @param emailAddresses the user's email addresses
- * @param phones the user's phone numbers
- * @param websites the user's websites
- * @param announcementsDelivers the announcements deliveries
- * @param sendEmail whether to send the user an email notification about
- their new account
- * @param serviceContext the user's service context (optionally
- <code>null</code>). Can set the universally unique identifier
- (with the <code>uuid</code> attribute), asset category IDs, asset
- tag names, and expando bridge attributes for the user.
- * @return the new user
- * @throws PortalException if the user's information was invalid, if the
- creator did not have permission to add users, if the email
- address was reserved, or some other portal exception occurred
- * @throws SystemException if a system exception occurred
- */
- public com.liferay.portal.model.User addUserWithWorkflow(long companyId,
- boolean autoPassword, java.lang.String password1,
- java.lang.String password2, boolean autoScreenName,
- java.lang.String screenName, java.lang.String emailAddress,
- long facebookId, 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,
- java.util.List<com.liferay.portal.model.Address> addresses,
- java.util.List<com.liferay.portal.model.EmailAddress> emailAddresses,
- java.util.List<com.liferay.portal.model.Phone> phones,
- java.util.List<com.liferay.portal.model.Website> websites,
- java.util.List<com.liferay.portlet.announcements.model.AnnouncementsDelivery> announcementsDelivers,
- boolean sendEmail,
- com.liferay.portal.service.ServiceContext serviceContext)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.addUserWithWorkflow(companyId, autoPassword,
- password1, password2, autoScreenName, screenName, emailAddress,
- facebookId, openId, locale, firstName, middleName, lastName,
- prefixId, suffixId, male, birthdayMonth, birthdayDay, birthdayYear,
- jobTitle, groupIds, organizationIds, roleIds, userGroupIds,
- addresses, emailAddresses, phones, websites, announcementsDelivers,
- sendEmail, serviceContext);
- }
- /**
- * Deletes the user's portrait image.
- *
- * @param userId the primary key of the user
- * @throws PortalException if a user with the primary key could not be
- found, if the user's portrait could not be found, or if the
- current user did not have permission to update the user
- * @throws SystemException if a system exception occurred
- */
- public void deletePortrait(long userId)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- _userService.deletePortrait(userId);
- }
- /**
- * Removes the user from the role.
- *
- * @param roleId the primary key of the role
- * @param userId the primary key of the user
- * @throws PortalException if a role or user with the primary key could not
- be found, or if the current user did not have permission to
- assign role members
- * @throws SystemException if a system exception occurred
- */
- public void deleteRoleUser(long roleId, long userId)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- _userService.deleteRoleUser(roleId, userId);
- }
- /**
- * Deletes the user.
- *
- * @param userId the primary key of the user
- * @throws PortalException if a user with the primary key could not be found
- or if the current user did not have permission to delete the user
- * @throws SystemException if a system exception occurred
- */
- public void deleteUser(long userId)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- _userService.deleteUser(userId);
- }
- /**
- * Returns the primary key of the default user for the company.
- *
- * @param companyId the primary key of the company
- * @return the primary key of the default user for the company
- * @throws PortalException if a default user for the company could not be
- found
- * @throws SystemException if a system exception occurred
- */
- public long getDefaultUserId(long companyId)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.getDefaultUserId(companyId);
- }
- /**
- * Returns the primary keys of all the users belonging to the group.
- *
- * @param groupId the primary key of the group
- * @return the primary keys of the users belonging to the group
- * @throws PortalException if the current user did not have permission to
- view group assignments
- * @throws SystemException if a system exception occurred
- */
- public long[] getGroupUserIds(long groupId)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.getGroupUserIds(groupId);
- }
- /**
- * Returns the primary keys of all the users belonging to the organization.
- *
- * @param organizationId the primary key of the organization
- * @return the primary keys of the users belonging to the organization
- * @throws PortalException if the current user did not have permission to
- view organization assignments
- * @throws SystemException if a system exception occurred
- */
- public long[] getOrganizationUserIds(long organizationId)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.getOrganizationUserIds(organizationId);
- }
- /**
- * Returns the primary keys of all the users belonging to the role.
- *
- * @param roleId the primary key of the role
- * @return the primary keys of the users belonging to the role
- * @throws PortalException if the current user did not have permission to
- view role members
- * @throws SystemException if a system exception occurred
- */
- public long[] getRoleUserIds(long roleId)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.getRoleUserIds(roleId);
- }
- /**
- * Returns the user with the email address.
- *
- * @param companyId the primary key of the user's company
- * @param emailAddress the user's email address
- * @return the user with the email address
- * @throws PortalException if a user with the email address could not be
- found or if the current user did not have permission to view the
- user
- * @throws SystemException if a system exception occurred
- */
- public com.liferay.portal.model.User getUserByEmailAddress(long companyId,
- java.lang.String emailAddress)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.getUserByEmailAddress(companyId, emailAddress);
- }
- /**
- * Returns the user with the primary key.
- *
- * @param userId the primary key of the user
- * @return the user with the primary key
- * @throws PortalException if a user with the primary key could not be found
- or if the current user did not have permission to view the user
- * @throws SystemException if a system exception occurred
- */
- public com.liferay.portal.model.User getUserById(long userId)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.getUserById(userId);
- }
- /**
- * Returns the user with the screen name.
- *
- * @param companyId the primary key of the user's company
- * @param screenName the user's screen name
- * @return the user with the screen name
- * @throws PortalException if a user with the screen name could not be found
- or if the current user did not have permission to veiw the user
- * @throws SystemException if a system exception occurred
- */
- public com.liferay.portal.model.User getUserByScreenName(long companyId,
- java.lang.String screenName)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.getUserByScreenName(companyId, screenName);
- }
- /**
- * Returns the primary key of the user with the email address.
- *
- * @param companyId the primary key of the user's company
- * @param emailAddress the user's email address
- * @return the primary key of the user with the email address
- * @throws PortalException if a user with the email address could not be
- found
- * @throws SystemException if a system exception occurred
- */
- public long getUserIdByEmailAddress(long companyId,
- java.lang.String emailAddress)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.getUserIdByEmailAddress(companyId, emailAddress);
- }
- /**
- * Returns the primary key of the user with the screen name.
- *
- * @param companyId the primary key of the user's company
- * @param screenName the user's screen name
- * @return the primary key of the user with the screen name
- * @throws PortalException if a user with the screen name could not be found
- * @throws SystemException if a system exception occurred
- */
- public long getUserIdByScreenName(long companyId,
- java.lang.String screenName)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.getUserIdByScreenName(companyId, screenName);
- }
- /**
- * Returns <code>true</code> if the user is a member of the group.
- *
- * @param groupId the primary key of the group
- * @param userId the primary key of the user
- * @return <code>true</code> if the user is a member of the group;
- <code>false</code> otherwise
- * @throws SystemException if a system exception occurred
- */
- public boolean hasGroupUser(long groupId, long userId)
- throws com.liferay.portal.kernel.exception.SystemException {
- return _userService.hasGroupUser(groupId, userId);
- }
- /**
- * Returns <code>true</code> if the user is a member of the role.
- *
- * @param roleId the primary key of the role
- * @param userId the primary key of the user
- * @return <code>true</code> if the user is a member of the role;
- <code>false</code> otherwise
- * @throws SystemException if a system exception occurred
- */
- public boolean hasRoleUser(long roleId, long userId)
- throws com.liferay.portal.kernel.exception.SystemException {
- return _userService.hasRoleUser(roleId, userId);
- }
- /**
- * Returns <code>true</code> if the user has the role with the name,
- * optionally through inheritance.
- *
- * @param companyId the primary key of the role's company
- * @param name the name of the role (must be a regular role, not an
- organization, site or provider role)
- * @param userId the primary key of the user
- * @param inherited whether to include roles inherited from organizations,
- sites, etc.
- * @return <code>true</code> if the user has the role; <code>false</code>
- otherwise
- * @throws PortalException if a role with the name could not be found
- * @throws SystemException if a system exception occurred
- */
- public boolean hasRoleUser(long companyId, java.lang.String name,
- long userId, boolean inherited)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.hasRoleUser(companyId, name, userId, inherited);
- }
- /**
- * Sets the users in the role, removing and adding users to the role as
- * necessary.
- *
- * @param roleId the primary key of the role
- * @param userIds the primary keys of the users
- * @throws PortalException if the current user did not have permission to
- assign role members
- * @throws SystemException if a system exception occurred
- */
- public void setRoleUsers(long roleId, long[] userIds)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- _userService.setRoleUsers(roleId, userIds);
- }
- /**
- * Sets the users in the user group, removing and adding users to the user
- * group as necessary.
- *
- * @param userGroupId the primary key of the user group
- * @param userIds the primary keys of the users
- * @throws PortalException if the current user did not have permission to
- assign group members
- * @throws SystemException if a system exception occurred
- */
- public void setUserGroupUsers(long userGroupId, long[] userIds)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- _userService.setUserGroupUsers(userGroupId, userIds);
- }
- /**
- * Removes the users from the group.
- *
- * @param groupId the primary key of the group
- * @param userIds the primary keys of the users
- * @throws PortalException if the current user did not have permission to
- modify group assignments
- * @throws SystemException if a system exception occurred
- */
- public void unsetGroupUsers(long groupId, long[] userIds,
- com.liferay.portal.service.ServiceContext serviceContext)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- _userService.unsetGroupUsers(groupId, userIds, serviceContext);
- }
- /**
- * Removes the users from the organization.
- *
- * @param organizationId the primary key of the organization
- * @param userIds the primary keys of the users
- * @throws PortalException if the current user did not have permission to
- modify organization assignments
- * @throws SystemException if a system exception occurred
- */
- public void unsetOrganizationUsers(long organizationId, long[] userIds)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- _userService.unsetOrganizationUsers(organizationId, userIds);
- }
- /**
- * Removes the users from the password policy.
- *
- * @param passwordPolicyId the primary key of the password policy
- * @param userIds the primary keys of the users
- * @throws PortalException if the current user did not have permission to
- modify policy assignments
- * @throws SystemException if a system exception occurred
- */
- public void unsetPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- _userService.unsetPasswordPolicyUsers(passwordPolicyId, userIds);
- }
- /**
- * Removes the users from the role.
- *
- * @param roleId the primary key of the role
- * @param userIds the primary keys of the users
- * @throws PortalException if the current user did not have permission to
- modify role assignments
- * @throws SystemException if a system exception occurred
- */
- public void unsetRoleUsers(long roleId, long[] userIds)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- _userService.unsetRoleUsers(roleId, userIds);
- }
- /**
- * Removes the users from the team.
- *
- * @param teamId the primary key of the team
- * @param userIds the primary keys of the users
- * @throws PortalException if the current user did not have permission to
- modify team assignments
- * @throws SystemException if a system exception occurred
- */
- public void unsetTeamUsers(long teamId, long[] userIds)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- _userService.unsetTeamUsers(teamId, userIds);
- }
- /**
- * Removes the users from the user group.
- *
- * @param userGroupId the primary key of the user group
- * @param userIds the primary keys of the users
- * @throws PortalException if the current user did not have permission to
- modify user group assignments
- * @throws SystemException if a system exception occurred
- */
- public void unsetUserGroupUsers(long userGroupId, long[] userIds)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- _userService.unsetUserGroupUsers(userGroupId, userIds);
- }
- /**
- * Updates the user's response to the terms of use agreement.
- *
- * @param userId the primary key of the user
- * @param agreedToTermsOfUse whether the user has agree to the terms of use
- * @return the user
- * @throws PortalException if the current user did not have permission to
- update the user's agreement to terms-of-use
- * @throws SystemException if a system exception occurred
- */
- public com.liferay.portal.model.User updateAgreedToTermsOfUse(long userId,
- boolean agreedToTermsOfUse)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.updateAgreedToTermsOfUse(userId, agreedToTermsOfUse);
- }
- /**
- * Updates the user's email address.
- *
- * @param userId the primary key of the user
- * @param password the user's password
- * @param emailAddress1 the user's new email address
- * @param emailAddress2 the user's new email address confirmation
- * @return the user
- * @throws PortalException if a user with the primary key could not be found
- or if the current user did not have permission to update the user
- * @throws SystemException if a system exception occurred
- */
- public com.liferay.portal.model.User updateEmailAddress(long userId,
- java.lang.String password, java.lang.String emailAddress1,
- java.lang.String emailAddress2,
- com.liferay.portal.service.ServiceContext serviceContext)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.updateEmailAddress(userId, password, emailAddress1,
- emailAddress2, serviceContext);
- }
- /**
- * Updates a user account that was automatically created when a guest user
- * participated in an action (e.g. posting a comment) and only provided his
- * name and email address.
- *
- * @param companyId the primary key of the user's company
- * @param autoPassword whether a password should be automatically generated
- for the user
- * @param password1 the user's password
- * @param password2 the user's password confirmation
- * @param autoScreenName whether a screen name should be automatically
- generated for the user
- * @param screenName the user's screen name
- * @param emailAddress the user's email address
- * @param facebookId the user's facebook ID
- * @param openId the user's OpenID
- * @param locale the user's locale
- * @param firstName the user's first name
- * @param middleName the user's middle name
- * @param lastName the user's last name
- * @param prefixId the user's name prefix ID
- * @param suffixId the user's name suffix ID
- * @param male whether the user is male
- * @param birthdayMonth the user's birthday month (0-based, meaning 0 for
- January)
- * @param birthdayDay the user's birthday day
- * @param birthdayYear the user's birthday year
- * @param jobTitle the user's job title
- * @param updateUserInformation whether to update the user's information
- * @param sendEmail whether to send the user an email notification about
- their new account
- * @param serviceContext the user's service context (optionally
- <code>null</code>). Can set the expando bridge attributes for the
- user.
- * @return the user
- * @throws PortalException if the user's information was invalid or if the
- email address was reserved
- * @throws SystemException if a system exception occurred
- */
- public com.liferay.portal.model.User updateIncompleteUser(long companyId,
- boolean autoPassword, java.lang.String password1,
- java.lang.String password2, boolean autoScreenName,
- java.lang.String screenName, java.lang.String emailAddress,
- long facebookId, 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, boolean updateUserInformation,
- boolean sendEmail,
- com.liferay.portal.service.ServiceContext serviceContext)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.updateIncompleteUser(companyId, autoPassword,
- password1, password2, autoScreenName, screenName, emailAddress,
- facebookId, openId, locale, firstName, middleName, lastName,
- prefixId, suffixId, male, birthdayMonth, birthdayDay, birthdayYear,
- jobTitle, updateUserInformation, sendEmail, serviceContext);
- }
- /**
- * Updates whether the user is locked out from logging in.
- *
- * @param userId the primary key of the user
- * @param lockout whether the user is locked out
- * @return the user
- * @throws PortalException if the user did not have permission to lock out
- the user
- * @throws SystemException if a system exception occurred
- */
- public com.liferay.portal.model.User updateLockoutById(long userId,
- boolean lockout)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.updateLockoutById(userId, lockout);
- }
- /**
- * Updates the user's OpenID.
- *
- * @param userId the primary key of the user
- * @param openId the new OpenID
- * @return the user
- * @throws PortalException if a user with the primary key could not be found
- or if the current user did not have permission to update the user
- * @throws SystemException if a system exception occurred
- */
- public com.liferay.portal.model.User updateOpenId(long userId,
- java.lang.String openId)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.updateOpenId(userId, openId);
- }
- /**
- * Sets the organizations that the user is in, removing and adding
- * organizations as necessary.
- *
- * @param userId the primary key of the user
- * @param organizationIds the primary keys of the organizations
- * @throws PortalException if a user with the primary key could not be found
- or if the current user did not have permission to update the user
- * @throws SystemException if a system exception occurred
- */
- public void updateOrganizations(long userId, long[] organizationIds,
- com.liferay.portal.service.ServiceContext serviceContext)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- _userService.updateOrganizations(userId, organizationIds, serviceContext);
- }
- /**
- * Updates the user's password without tracking or validation of the change.
- *
- * @param userId the primary key of the user
- * @param password1 the user's new password
- * @param password2 the user's new password confirmation
- * @param passwordReset whether the user should be asked to reset their
- password the next time they log in
- * @return the user
- * @throws PortalException if a user with the primary key could not be found
- or if the current user did not have permission to update the user
- * @throws SystemException if a system exception occurred
- */
- public com.liferay.portal.model.User updatePassword(long userId,
- java.lang.String password1, java.lang.String password2,
- boolean passwordReset)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.updatePassword(userId, password1, password2,
- passwordReset);
- }
- /**
- * Updates the user's portrait image.
- *
- * @param userId the primary key of the user
- * @param bytes the new portrait image data
- * @return the user
- * @throws PortalException if a user with the primary key could not be
- found, if the new portrait was invalid, or if the current user
- did not have permission to update the user
- * @throws SystemException if a system exception occurred
- */
- public com.liferay.portal.model.User updatePortrait(long userId,
- byte[] bytes)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.updatePortrait(userId, bytes);
- }
- /**
- * Updates the user's password reset question and answer.
- *
- * @param userId the primary key of the user
- * @param question the user's new password reset question
- * @param answer the user's new password reset answer
- * @return the user
- * @throws PortalException if a user with the primary key could not be
- found, if the new question or answer were invalid, or if the
- current user did not have permission to update the user
- * @throws SystemException if a system exception occurred
- */
- public com.liferay.portal.model.User updateReminderQuery(long userId,
- java.lang.String question, java.lang.String answer)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.updateReminderQuery(userId, question, answer);
- }
- /**
- * Updates the user's screen name.
- *
- * @param userId the primary key of the user
- * @param screenName the user's new screen name
- * @return the user
- * @throws PortalException if a user with the primary key could not be
- found, if the new screen name was invalid, or if the current user
- did not have permission to update the user
- * @throws SystemException if a system exception occurred
- */
- public com.liferay.portal.model.User updateScreenName(long userId,
- java.lang.String screenName)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.updateScreenName(userId, screenName);
- }
- /**
- * Updates the user's workflow status.
- *
- * @param userId the primary key of the user
- * @param status the user's new workflow status
- * @return the user
- * @throws PortalException if a user with the primary key could not be
- found, if the current user was updating her own status to
- anything but {@link WorkflowConstants.STATUS_APPROVED}, or if the
- current user did not have permission to update the user's
- workflow status.
- * @throws SystemException if a system exception occurred
- */
- public com.liferay.portal.model.User updateStatus(long userId, int status)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.updateStatus(userId, status);
- }
- /**
- * Updates the user with additional parameters.
- *
- * @param userId the primary key of the user
- * @param oldPassword the user's old password
- * @param newPassword1 the user's new password (optionally
- <code>null</code>)
- * @param newPassword2 the user's new password confirmation (optionally
- <code>null</code>)
- * @param passwordReset whether the user should be asked to reset their
- password the next time they login
- * @param reminderQueryQuestion the user's new password reset question
- * @param reminderQueryAnswer the user's new password reset answer
- * @param screenName the user's new screen name
- * @param emailAddress the user's new email address
- * @param facebookId the user's new Facebook ID
- * @param openId the user's new OpenID
- * @param languageId the user's new language ID
- * @param timeZoneId the user's new time zone ID
- * @param greeting the user's new greeting
- * @param comments the user's new comments
- * @param firstName the user's new first name
- * @param middleName the user's new middle name
- * @param lastName the user's new last name
- * @param prefixId the user's new name prefix ID
- * @param suffixId the user's new name suffix ID
- * @param male whether user is male
- * @param birthdayMonth the user's new birthday month (0-based, meaning 0
- for January)
- * @param birthdayDay the user's new birthday day
- * @param birthdayYear the user's birthday year
- * @param smsSn the user's new SMS screen name
- * @param aimSn the user's new AIM screen name
- * @param facebookSn the user's new Facebook screen name
- * @param icqSn the user's new ICQ screen name
- * @param jabberSn the user's new Jabber screen name
- * @param msnSn the user's new MSN screen name
- * @param mySpaceSn the user's new MySpace screen name
- * @param skypeSn the user's new Skype screen name
- * @param twitterSn the user's new Twitter screen name
- * @param ymSn the user's new Yahoo! Messenger screen name
- * @param jobTitle the user's new job title
- * @param groupIds the primary keys of the user's groups
- * @param organizationIds the primary keys of the user's organizations
- * @param roleIds the primary keys of the user's roles
- * @param userGroupRoles the user user's group roles
- * @param userGroupIds the primary keys of the user's user groups
- * @param addresses the user's addresses
- * @param emailAddresses the user's email addresses
- * @param phones the user's phone numbers
- * @param websites the user's websites
- * @param announcementsDelivers the announcements deliveries
- * @param serviceContext the user's service context (optionally
- <code>null</code>). Can set the universally unique identifier
- (with the <code>uuid</code> attribute), asset category IDs, asset
- tag names, and expando bridge attributes for the user.
- * @return the user
- * @throws PortalException if a user with the primary key could not be
- found, if the new information was invalid, or if the current user
- did not have permission to update the user
- * @throws SystemException if a system exception occurred
- */
- public com.liferay.portal.model.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, long facebookId,
- 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<com.liferay.portal.model.UserGroupRole> userGroupRoles,
- long[] userGroupIds,
- java.util.List<com.liferay.portal.model.Address> addresses,
- java.util.List<com.liferay.portal.model.EmailAddress> emailAddresses,
- java.util.List<com.liferay.portal.model.Phone> phones,
- java.util.List<com.liferay.portal.model.Website> websites,
- java.util.List<com.liferay.portlet.announcements.model.AnnouncementsDelivery> announcementsDelivers,
- com.liferay.portal.service.ServiceContext serviceContext)
- throws com.liferay.portal.kernel.exception.PortalException,
- com.liferay.portal.kernel.exception.SystemException {
- return _userService.updateUser(userId, oldPassword, newPassword1,
- newPassword2, passwordReset, reminderQueryQuestion,
- reminderQueryAnswer, screenName, emailAddress, facebookId, openId,
- languageId, timeZoneId, greeting, comments, firstName, middleName,
- lastName, prefixId, suffixId, male, birthdayMonth, birthdayDay,
- birthdayYear, smsSn, aimSn, facebookSn, icqSn, jabberSn, msnSn,
- mySpaceSn, skypeSn, twitterSn, ymSn, jobTitle, groupIds,
- organizationIds, roleIds, userGroupRoles, userGroupIds, addresses,
- emailAddresses, phones, websites, announcementsDelivers,
- serviceContext);
- }
- /**
- * Updates the user.
- *
- * @param userId the primary key of the user
- * @param oldPassword the user's old password
- * @param newPassword1 the user's new password (optionally
- <code>null</code>)
- * @param newPassword2 the user's new password confirmation (optionally
- <code>null</code>)
- * @param passwordReset whether the user should be asked to reset their
- password the next time they login
- * @param reminderQueryQuestion the user's new password reset question
- * @param reminderQueryAnswer the user's new password reset answer
- * @param screenName the user's new screen name
- * @param emailAddress the user's new email address
- * @param facebookId the user's new Facebook ID
- * @param openId the user's new OpenID
- * @param languageId the user's new language ID
- * @param timeZoneId the user's new time zone ID
- * @param greeting the user's new greeting
- * @param comments the user's new comments
- * @param firstName the user's new first name
- * @param middleName the user's new middle name
- * @param lastName the user's new last name
- * @param prefixId the user's new name prefix ID
- * @param suffixId the user's new name suffix ID
- * @param male whether user is male
- * @param birthdayMonth the user's new birthday month (0-based, meaning 0
- for January)
- * @param birthdayDay the user's new birthday day
- * @param birthdayYear the user's birthday year
- * @param smsSn the user's new SMS screen name
- * @param aimSn the user's new