com.liferay.portal.kernel.service.UserService Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present 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.kernel.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.announcements.kernel.model.AnnouncementsDelivery;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.jsonwebservice.JSONWebService;
import com.liferay.portal.kernel.model.Address;
import com.liferay.portal.kernel.model.EmailAddress;
import com.liferay.portal.kernel.model.Phone;
import com.liferay.portal.kernel.model.User;
import com.liferay.portal.kernel.model.UserGroupRole;
import com.liferay.portal.kernel.model.Website;
import com.liferay.portal.kernel.security.access.control.AccessControlled;
import com.liferay.portal.kernel.security.auth.PrincipalException;
import com.liferay.portal.kernel.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
import com.liferay.portal.kernel.util.OrderByComparator;
import java.util.List;
import java.util.Locale;
/**
* Provides the remote service interface for User. 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 UserServiceUtil
* @generated
*/
@AccessControlled
@JSONWebService
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface UserService extends BaseService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link UserServiceUtil} to access the user remote service. Add custom service methods to com.liferay.portal.service.impl.UserServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
/**
* Adds the users to the group.
*
* @param groupId the primary key of the group
* @param userIds the primary keys of the users
* @param serviceContext the service context to be applied (optionally
null)
*/
public void addGroupUsers(
long groupId, long[] userIds, ServiceContext serviceContext)
throws PortalException;
/**
* Adds the users to the organization.
*
* @param organizationId the primary key of the organization
* @param userIds the primary keys of the users
*/
public void addOrganizationUsers(long organizationId, long[] userIds)
throws PortalException;
/**
* 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
*/
public void addPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
throws PortalException;
/**
* Adds the users to the role.
*
* @param roleId the primary key of the role
* @param userIds the primary keys of the users
*/
public void addRoleUsers(long roleId, long[] userIds)
throws PortalException;
/**
* Adds the users to the team.
*
* @param teamId the primary key of the team
* @param userIds the primary keys of the users
*/
public void addTeamUsers(long teamId, long[] userIds)
throws PortalException;
/**
* Adds a user.
*
*
* 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.
*
*
* @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 service context to be applied (optionally
null). Can set the UUID (with the uuid
attribute), asset category IDs, asset tag names, and expando
bridge attributes for the user.
* @return the new user
*/
public 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, long prefixId,
long 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;
/**
* Adds a user with additional parameters.
*
*
* 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.
*
*
* @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 service context to be applied (optionally
null). Can set the UUID (with the uuid
attribute), asset category IDs, asset tag names, and expando
bridge attributes for the user.
* @return the new user
*/
public 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, long prefixId,
long suffixId, boolean male, int birthdayMonth, int birthdayDay,
int birthdayYear, String jobTitle, long[] groupIds,
long[] organizationIds, long[] roleIds, long[] userGroupIds,
List addresses, List emailAddresses,
List phones, List websites,
List announcementsDelivers,
boolean sendEmail, ServiceContext serviceContext)
throws PortalException;
/**
* Adds the users to the user group.
*
* @param userGroupId the primary key of the user group
* @param userIds the primary keys of the users
*/
public void addUserGroupUsers(long userGroupId, long[] userIds)
throws PortalException;
/**
* Adds a user with workflow.
*
*
* 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.
*
*
* @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 service context to be applied (optionally
null). Can set the UUID (with the uuid
attribute), asset category IDs, asset tag names, and expando
bridge attributes for the user.
* @return the new user
*/
public User addUserWithWorkflow(
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, long prefixId,
long 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;
/**
* Adds a user with workflow and additional parameters.
*
*
* 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.
*
*
* @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 service context to be applied (optionally
null). Can set the UUID (with the uuid
attribute), asset category IDs, asset tag names, and expando
bridge attributes for the user.
* @return the new user
*/
public User addUserWithWorkflow(
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, long prefixId,
long suffixId, boolean male, int birthdayMonth, int birthdayDay,
int birthdayYear, String jobTitle, long[] groupIds,
long[] organizationIds, long[] roleIds, long[] userGroupIds,
List addresses, List emailAddresses,
List phones, List websites,
List announcementsDelivers,
boolean sendEmail, ServiceContext serviceContext)
throws PortalException;
/**
* Deletes the user's portrait image.
*
* @param userId the primary key of the user
*/
public void deletePortrait(long userId) throws PortalException;
/**
* Removes the user from the role.
*
* @param roleId the primary key of the role
* @param userId the primary key of the user
*/
public void deleteRoleUser(long roleId, long userId) throws PortalException;
/**
* Deletes the user.
*
* @param userId the primary key of the user
*/
public void deleteUser(long userId) throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getCompanyUsers(long companyId, int start, int end)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getCompanyUsersCount(long companyId) throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public User getCurrentUser() throws PortalException;
/**
* 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long[] getGroupUserIds(long groupId) throws PortalException;
/**
* Returns all the users belonging to the group.
*
* @param groupId the primary key of the group
* @return the users belonging to the group
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getGroupUsers(long groupId) throws PortalException;
/**
* Returns the users belonging to a group.
*
* @param groupId the primary key of the group
* @param status the workflow status
* @param start the lower bound of the range of users
* @param end the upper bound of the range of users (not inclusive)
* @param obc the comparator to order the users by (optionally
null)
* @return the matching users
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getGroupUsers(
long groupId, int status, int start, int end,
OrderByComparator obc)
throws PortalException;
/**
* Returns the users belonging to a group.
*
* @param groupId the primary key of the group
* @param status the workflow status
* @param obc the comparator to order the users by (optionally
null)
* @return the matching users
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getGroupUsers(
long groupId, int status, OrderByComparator obc)
throws PortalException;
/**
* Returns the number of users with the status belonging to the group.
*
* @param groupId the primary key of the group
* @param status the workflow status
* @return the number of users with the status belonging to the group
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getGroupUsersCount(long groupId, int status)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getGtCompanyUsers(long gtUserId, long companyId, int size)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getGtOrganizationUsers(
long gtUserId, long organizationId, int size)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getGtUserGroupUsers(
long gtUserId, long userGroupId, int size)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getOrganizationsAndUserGroupsUsersCount(
long[] organizationIds, long[] userGroupIds)
throws PrincipalException;
/**
* 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long[] getOrganizationUserIds(long organizationId)
throws PortalException;
/**
* Returns all the users belonging to the organization.
*
* @param organizationId the primary key of the organization
* @return users belonging to the organization
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getOrganizationUsers(long organizationId)
throws PortalException;
/**
* Returns the users belonging to the organization with the status.
*
* @param organizationId the primary key of the organization
* @param status the workflow status
* @param start the lower bound of the range of users
* @param end the upper bound of the range of users (not inclusive)
* @param obc the comparator to order the users by (optionally
null)
* @return the matching users
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getOrganizationUsers(
long organizationId, int status, int start, int end,
OrderByComparator obc)
throws PortalException;
/**
* Returns the users belonging to the organization with the status.
*
* @param organizationId the primary key of the organization
* @param status the workflow status
* @param obc the comparator to order the users by (optionally
null)
* @return the matching users
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getOrganizationUsers(
long organizationId, int status, OrderByComparator obc)
throws PortalException;
/**
* Returns the number of users with the status belonging to the
* organization.
*
* @param organizationId the primary key of the organization
* @param status the workflow status
* @return the number of users with the status belonging to the organization
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getOrganizationUsersCount(long organizationId, int status)
throws PortalException;
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public String getOSGiServiceIdentifier();
/**
* 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long[] getRoleUserIds(long roleId) throws PortalException;
/**
* 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public User getUserByEmailAddress(long companyId, String emailAddress)
throws PortalException;
/**
* Returns the user with the primary key.
*
* @param userId the primary key of the user
* @return the user with the primary key
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public User getUserById(long userId) throws PortalException;
/**
* 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public User getUserByScreenName(long companyId, String screenName)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getUserGroupUsers(long userGroupId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getUserGroupUsers(long userGroupId, int start, int end)
throws PortalException;
/**
* 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long getUserIdByEmailAddress(long companyId, String emailAddress)
throws PortalException;
/**
* 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long getUserIdByScreenName(long companyId, String screenName)
throws PortalException;
/**
* Returns true 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 true if the user is a member of the group;
false otherwise
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean hasGroupUser(long groupId, long userId)
throws PortalException;
/**
* Returns true 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 true if the user is a member of the role;
false otherwise
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean hasRoleUser(long roleId, long userId) throws PortalException;
/**
* Returns true 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 true if the user has the role; false
otherwise
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean hasRoleUser(
long companyId, String name, long userId, boolean inherited)
throws PortalException;
/**
* Sends a password notification email to the user matching the email
* address. The portal's settings determine whether a password is sent
* explicitly or whether a link for resetting the user's password is sent.
* The method sends the email asynchronously and returns before the email is
* sent.
*
*
* The content of the notification email is specified with the
* admin.email.password portal property keys. They can be
* overridden via a portal-ext.properties file or modified
* through the Portal Settings UI.
*
*
* @param companyId the primary key of the user's company
* @param emailAddress the user's email address
* @return true if the notification email includes a new
password; false if the notification email only
contains a reset link
*/
public boolean sendPasswordByEmailAddress(
long companyId, String emailAddress)
throws PortalException;
/**
* Sends a password notification email to the user matching the screen name.
* The portal's settings determine whether a password is sent explicitly or
* whether a link for resetting the user's password is sent. The method
* sends the email asynchronously and returns before the email is sent.
*
*
* The content of the notification email is specified with the
* admin.email.password portal property keys. They can be
* overridden via a portal-ext.properties file or modified
* through the Portal Settings UI.
*
*
* @param companyId the primary key of the user's company
* @param screenName the user's screen name
* @return true if the notification email includes a new
password; false if the notification email only
contains a reset link
*/
public boolean sendPasswordByScreenName(long companyId, String screenName)
throws PortalException;
/**
* Sends a password notification email to the user matching the ID. The
* portal's settings determine whether a password is sent explicitly or
* whether a link for resetting the user's password is sent. The method
* sends the email asynchronously and returns before the email is sent.
*
*
* The content of the notification email is specified with the
* admin.email.password portal property keys. They can be
* overridden via a portal-ext.properties file or modified
* through the Portal Settings UI.
*
*
* @param userId the user's primary key
* @return true if the notification email includes a new
password; false if the notification email only
contains a reset link
*/
public boolean sendPasswordByUserId(long userId) throws PortalException;
/**
* 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
*/
public void setRoleUsers(long roleId, long[] userIds)
throws PortalException;
/**
* 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
*/
public void setUserGroupUsers(long userGroupId, long[] userIds)
throws PortalException;
/**
* Removes the users from the teams of a group.
*
* @param groupId the primary key of the group
* @param userIds the primary keys of the users
*/
public void unsetGroupTeamsUsers(long groupId, long[] userIds)
throws PortalException;
/**
* Removes the users from the group.
*
* @param groupId the primary key of the group
* @param userIds the primary keys of the users
* @param serviceContext the service context to be applied (optionally
null)
*/
public void unsetGroupUsers(
long groupId, long[] userIds, ServiceContext serviceContext)
throws PortalException;
/**
* Removes the users from the organization.
*
* @param organizationId the primary key of the organization
* @param userIds the primary keys of the users
*/
public void unsetOrganizationUsers(long organizationId, long[] userIds)
throws PortalException;
/**
* Removes the users from the password policy.
*
* @param passwordPolicyId the primary key of the password policy
* @param userIds the primary keys of the users
*/
public void unsetPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
throws PortalException;
/**
* Removes the users from the role.
*
* @param roleId the primary key of the role
* @param userIds the primary keys of the users
*/
public void unsetRoleUsers(long roleId, long[] userIds)
throws PortalException;
/**
* Removes the users from the team.
*
* @param teamId the primary key of the team
* @param userIds the primary keys of the users
*/
public void unsetTeamUsers(long teamId, long[] userIds)
throws PortalException;
/**
* Removes the users from the user group.
*
* @param userGroupId the primary key of the user group
* @param userIds the primary keys of the users
*/
public void unsetUserGroupUsers(long userGroupId, long[] userIds)
throws PortalException;
/**
* 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
*/
public User updateAgreedToTermsOfUse(
long userId, boolean agreedToTermsOfUse)
throws PortalException;
/**
* 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
* @param serviceContext the service context to be applied. Must set the
portal URL, main path, primary key of the layout, remote address,
remote host, and agent for the user.
* @return the user
*/
public User updateEmailAddress(
long userId, String password, String emailAddress1,
String emailAddress2, ServiceContext serviceContext)
throws PortalException;
/**
* 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 service context to be applied (optionally
null). Can set the expando bridge attributes for the
user.
* @return the user
*/
public User updateIncompleteUser(
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, long prefixId,
long suffixId, boolean male, int birthdayMonth, int birthdayDay,
int birthdayYear, String jobTitle, boolean updateUserInformation,
boolean sendEmail, ServiceContext serviceContext)
throws PortalException;
/**
* 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
*/
public User updateLockoutById(long userId, boolean lockout)
throws PortalException;
/**
* Updates the user's OpenID.
*
* @param userId the primary key of the user
* @param openId the new OpenID
* @return the user
*/
public User updateOpenId(long userId, String openId) throws PortalException;
/**
* 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
* @param serviceContext the service context to be applied. Must set whether
user indexing is enabled.
*/
public void updateOrganizations(
long userId, long[] organizationIds, ServiceContext serviceContext)
throws PortalException;
/**
* 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
*/
public User updatePassword(
long userId, String password1, String password2,
boolean passwordReset)
throws PortalException;
/**
* Updates the user's portrait image.
*
* @param userId the primary key of the user
* @param bytes the new portrait image data
* @return the user
*/
public User updatePortrait(long userId, byte[] bytes)
throws PortalException;
/**
* 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
*/
public User updateReminderQuery(long userId, String question, String answer)
throws PortalException;
/**
* 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
*/
public User updateScreenName(long userId, String screenName)
throws PortalException;
/**
* 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
* @deprecated As of Wilberforce (7.0.x), replaced by {@link
#updateStatus(long, int, ServiceContext)}
*/
@Deprecated
public User updateStatus(long userId, int status) throws PortalException;
/**
* Updates the user's workflow status.
*
* @param userId the primary key of the user
* @param status the user's new workflow status
* @param serviceContext the service context to be applied. You can specify
an unencrypted custom password (used by an LDAP listener) for the
user via attribute passwordUnencrypted.
* @return the user
*/
public User updateStatus(
long userId, int status, ServiceContext serviceContext)
throws PortalException;
/**
* 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
null)
* @param newPassword2 the user's new password confirmation (optionally
null)
* @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 portrait whether to update the user's portrait image
* @param portraitBytes the new portrait image data
* @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 facebookSn the user's new Facebook screen name
* @param jabberSn the user's new Jabber screen name
* @param skypeSn the user's new Skype screen name
* @param twitterSn the user's new Twitter 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 service context to be applied (optionally
null). Can set the UUID (with the uuid
attribute), asset category IDs, asset tag names, and expando
bridge attributes for the user.
* @return the user
*/
public User updateUser(
long userId, String oldPassword, String newPassword1,
String newPassword2, boolean passwordReset,
String reminderQueryQuestion, String reminderQueryAnswer,
String screenName, String emailAddress, long facebookId,
String openId, boolean portrait, byte[] portraitBytes,
String languageId, String timeZoneId, String greeting,
String comments, String firstName, String middleName,
String lastName, long prefixId, long suffixId, boolean male,
int birthdayMonth, int birthdayDay, int birthdayYear, String smsSn,
String facebookSn, String jabberSn, String skypeSn,
String twitterSn, String jobTitle, long[] groupIds,
long[] organizationIds, long[] roleIds,
List userGroupRoles, long[] userGroupIds,
List addresses, List emailAddresses,
List phones, List websites,
List announcementsDelivers,
ServiceContext serviceContext)
throws PortalException;
/**
* 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
null)
* @param newPassword2 the user's new password confirmation (optionally
null)
* @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 facebookSn the user's new Facebook screen name
* @param jabberSn the user's new Jabber screen name
* @param skypeSn the user's new Skype screen name
* @param twitterSn the user's new Twitter 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 service context to be applied (optionally
null). Can set the UUID (with the
uuid attribute), asset category IDs, asset tag
names, and expando bridge attributes for the user.
* @return the user
* @deprecated As of Wilberforce (7.0.x), replaced by {@link
#updateUser(long, String, String, String, boolean, String,
String, String, String, long, String, boolean, byte[],
String, String, String, String, String, String, String, long,
long, boolean, int, int, int, String, String, String, String,
String, String, long[], long[], long[], List, long[], List,
List, List, List, List, ServiceContext)}
*/
@Deprecated
public 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, long prefixId, long suffixId,
boolean male, int birthdayMonth, int birthdayDay, int birthdayYear,
String smsSn, String facebookSn, String jabberSn, String skypeSn,
String twitterSn, String jobTitle, long[] groupIds,
long[] organizationIds, long[] roleIds,
List userGroupRoles, long[] userGroupIds,
List addresses, List emailAddresses,
List phones, List websites,
List announcementsDelivers,
ServiceContext serviceContext)
throws PortalException;
/**
* 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
null)
* @param newPassword2 the user's new password confirmation (optionally
null)
* @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 facebookSn the user's new Facebook screen name
* @param jabberSn the user's new Jabber screen name
* @param skypeSn the user's new Skype screen name
* @param twitterSn the user's new Twitter 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 serviceContext the service context to be applied (optionally
null). Can set the UUID (with the uuid
attribute), asset category IDs, asset tag names, and expando
bridge attributes for the user.
* @return the user
*/
public 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, long prefixId, long suffixId,
boolean male, int birthdayMonth, int birthdayDay, int birthdayYear,
String smsSn, String facebookSn, String jabberSn, String skypeSn,
String twitterSn, String jobTitle, long[] groupIds,
long[] organizationIds, long[] roleIds,
List userGroupRoles, long[] userGroupIds,
ServiceContext serviceContext)
throws PortalException;
}