--- /dev/null
+/**\r
+ * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.\r
+ *\r
+ * This library is free software; you can redistribute it and/or modify it under\r
+ * the terms of the GNU Lesser General Public License as published by the Free\r
+ * Software Foundation; either version 2.1 of the License, or (at your option)\r
+ * any later version.\r
+ *\r
+ * This library is distributed in the hope that it will be useful, but WITHOUT\r
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
+ * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more\r
+ * details.\r
+ */\r
+\r
+package com.liferay.portal.service;\r
+\r
+import java.util.List;\r
+\r
+import com.liferay.portal.kernel.exception.PortalException;\r
+import com.liferay.portal.kernel.exception.SystemException;\r
+import com.liferay.portal.kernel.transaction.Isolation;\r
+import com.liferay.portal.kernel.transaction.Propagation;\r
+import com.liferay.portal.kernel.transaction.Transactional;\r
+import com.liferay.portal.kernel.util.OrderByComparator;\r
+import com.liferay.portal.model.User;\r
+\r
+/**\r
+ * The interface for the user local service.\r
+ *\r
+ * <p>\r
+ * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.\r
+ * </p>\r
+ *\r
+ * @author Brian Wing Shun Chan\r
+ * @see UserLocalServiceUtil\r
+ * @see com.liferay.portal.service.base.UserLocalServiceBaseImpl\r
+ * @see com.liferay.portal.service.impl.UserLocalServiceImpl\r
+ * @generated\r
+ */\r
+@Transactional(isolation = Isolation.PORTAL, rollbackFor = {\r
+ PortalException.class, SystemException.class})\r
+public interface ExtUserLocalService extends BaseLocalService,\r
+ PersistedModelLocalService {\r
+ /*\r
+ * NOTE FOR DEVELOPERS:\r
+ *\r
+ * Never modify or reference this interface directly. Always use {@link UserLocalServiceUtil} to access the user local service. Add custom service methods to {@link com.liferay.portal.service.impl.UserLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.\r
+ */\r
+\r
+ /**\r
+ * Adds the user to the database. Also notifies the appropriate model listeners.\r
+ *\r
+ * @param user the user\r
+ * @return the user that was added\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User addUser(\r
+ com.liferay.portal.model.User user)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Creates a new user with the primary key. Does not add the user to the database.\r
+ *\r
+ * @param userId the primary key for the new user\r
+ * @return the new user\r
+ */\r
+ public com.liferay.portal.model.User createUser(long userId);\r
+\r
+ /**\r
+ * Deletes the user with the primary key from the database. Also notifies the appropriate model listeners.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @return the user that was removed\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User deleteUser(long userId)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Deletes the user from the database. Also notifies the appropriate model listeners.\r
+ *\r
+ * @param user the user\r
+ * @return the user that was removed\r
+ * @throws PortalException\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User deleteUser(\r
+ com.liferay.portal.model.User user)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();\r
+\r
+ /**\r
+ * Performs a dynamic query on the database and returns the matching rows.\r
+ *\r
+ * @param dynamicQuery the dynamic query\r
+ * @return the matching rows\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @SuppressWarnings("rawtypes")\r
+ public java.util.List dynamicQuery(\r
+ com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Performs a dynamic query on the database and returns a range of the matching rows.\r
+ *\r
+ * <p>\r
+ * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.\r
+ * </p>\r
+ *\r
+ * @param dynamicQuery the dynamic query\r
+ * @param start the lower bound of the range of model instances\r
+ * @param end the upper bound of the range of model instances (not inclusive)\r
+ * @return the range of matching rows\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @SuppressWarnings("rawtypes")\r
+ public java.util.List dynamicQuery(\r
+ com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,\r
+ int end) throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Performs a dynamic query on the database and returns an ordered range of the matching rows.\r
+ *\r
+ * <p>\r
+ * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.\r
+ * </p>\r
+ *\r
+ * @param dynamicQuery the dynamic query\r
+ * @param start the lower bound of the range of model instances\r
+ * @param end the upper bound of the range of model instances (not inclusive)\r
+ * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)\r
+ * @return the ordered range of matching rows\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @SuppressWarnings("rawtypes")\r
+ public java.util.List dynamicQuery(\r
+ com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,\r
+ int end,\r
+ com.liferay.portal.kernel.util.OrderByComparator orderByComparator)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the number of rows that match the dynamic query.\r
+ *\r
+ * @param dynamicQuery the dynamic query\r
+ * @return the number of rows that match the dynamic query\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public long dynamicQueryCount(\r
+ com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public com.liferay.portal.model.User fetchUser(long userId)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the user with the primary key.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @return the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public com.liferay.portal.model.User getUser(long userId)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public com.liferay.portal.model.PersistedModel getPersistedModel(\r
+ java.io.Serializable primaryKeyObj)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns a range of all the users.\r
+ *\r
+ * <p>\r
+ * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.\r
+ * </p>\r
+ *\r
+ * @param start the lower bound of the range of users\r
+ * @param end the upper bound of the range of users (not inclusive)\r
+ * @return the range of users\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public java.util.List<com.liferay.portal.model.User> getUsers(int start,\r
+ int end) throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the number of users.\r
+ *\r
+ * @return the number of users\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public int getUsersCount()\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates the user in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.\r
+ *\r
+ * @param user the user\r
+ * @return the user that was updated\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updateUser(\r
+ com.liferay.portal.model.User user)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates the user in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.\r
+ *\r
+ * @param user the user\r
+ * @param merge whether to merge the user with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.\r
+ * @return the user that was updated\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updateUser(\r
+ com.liferay.portal.model.User user, boolean merge)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the Spring bean ID for this bean.\r
+ *\r
+ * @return the Spring bean ID for this bean\r
+ */\r
+ public java.lang.String getBeanIdentifier();\r
+\r
+ /**\r
+ * Sets the Spring bean ID for this bean.\r
+ *\r
+ * @param beanIdentifier the Spring bean ID for this bean\r
+ */\r
+ public void setBeanIdentifier(java.lang.String beanIdentifier);\r
+\r
+ public com.liferay.portal.model.User addDefaultAdminUser(long companyId,\r
+ java.lang.String screenName, java.lang.String emailAddress,\r
+ java.util.Locale locale, java.lang.String firstName,\r
+ java.lang.String middleName, java.lang.String lastName)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Adds the user to the default groups, unless the user is already in these\r
+ * groups. The default groups can be specified in\r
+ * <code>portal.properties</code> with the key\r
+ * <code>admin.default.group.names</code>.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void addDefaultGroups(long userId)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Adds the user to the default roles, unless the user already has these\r
+ * roles. The default roles can be specified in\r
+ * <code>portal.properties</code> with the key\r
+ * <code>admin.default.role.names</code>.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void addDefaultRoles(long userId)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Adds the user to the default user groups, unless the user is already in\r
+ * these user groups. The default user groups can be specified in\r
+ * <code>portal.properties</code> with the property\r
+ * <code>admin.default.user.group.names</code>.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void addDefaultUserGroups(long userId)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Adds the users to the group.\r
+ *\r
+ * @param groupId the primary key of the group\r
+ * @param userIds the primary keys of the users\r
+ * @throws PortalException if a group or user with the primary key could not\r
+ be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void addGroupUsers(long groupId, long[] userIds)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Adds the users to the organization.\r
+ *\r
+ * @param organizationId the primary key of the organization\r
+ * @param userIds the primary keys of the users\r
+ * @throws PortalException if an organization or user with the primary key\r
+ could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void addOrganizationUsers(long organizationId, long[] userIds)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Assigns the password policy to the users, removing any other currently\r
+ * assigned password policies.\r
+ *\r
+ * @param passwordPolicyId the primary key of the password policy\r
+ * @param userIds the primary keys of the users\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void addPasswordPolicyUsers(long passwordPolicyId, long[] userIds)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Adds the users to the role.\r
+ *\r
+ * @param roleId the primary key of the role\r
+ * @param userIds the primary keys of the users\r
+ * @throws PortalException if a role or user with the primary key could not\r
+ be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void addRoleUsers(long roleId, long[] userIds)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Adds the users to the team.\r
+ *\r
+ * @param teamId the primary key of the team\r
+ * @param userIds the primary keys of the users\r
+ * @throws PortalException if a team or user with the primary key could not\r
+ be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void addTeamUsers(long teamId, long[] userIds)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Adds a user.\r
+ *\r
+ * <p>\r
+ * This method handles the creation and bookkeeping of the user including\r
+ * its resources, metadata, and internal data structures. It is not\r
+ * necessary to make subsequent calls to any methods to setup default\r
+ * groups, resources, etc.\r
+ * </p>\r
+ *\r
+ * @param creatorUserId the primary key of the creator\r
+ * @param companyId the primary key of the user's company\r
+ * @param autoPassword whether a password should be automatically generated\r
+ for the user\r
+ * @param password1 the user's password\r
+ * @param password2 the user's password confirmation\r
+ * @param autoScreenName whether a screen name should be automatically\r
+ generated for the user\r
+ * @param screenName the user's screen name\r
+ * @param emailAddress the user's email address\r
+ * @param facebookId the user's facebook ID\r
+ * @param openId the user's OpenID\r
+ * @param locale the user's locale\r
+ * @param firstName the user's first name\r
+ * @param middleName the user's middle name\r
+ * @param lastName the user's last name\r
+ * @param prefixId the user's name prefix ID\r
+ * @param suffixId the user's name suffix ID\r
+ * @param male whether the user is male\r
+ * @param birthdayMonth the user's birthday month (0-based, meaning 0 for\r
+ January)\r
+ * @param birthdayDay the user's birthday day\r
+ * @param birthdayYear the user's birthday year\r
+ * @param jobTitle the user's job title\r
+ * @param groupIds the primary keys of the user's groups\r
+ * @param organizationIds the primary keys of the user's organizations\r
+ * @param roleIds the primary keys of the roles this user possesses\r
+ * @param userGroupIds the primary keys of the user's user groups\r
+ * @param sendEmail whether to send the user an email notification about\r
+ their new account\r
+ * @param serviceContext the user's service context (optionally\r
+ <code>null</code>). Can set the universally unique identifier\r
+ (with the <code>uuid</code> attribute), asset category IDs, asset\r
+ tag names, and expando bridge attributes for the user.\r
+ * @return the new user\r
+ * @throws PortalException if the user's information was invalid\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User addUser(long creatorUserId,\r
+ long companyId, boolean autoPassword, java.lang.String password1,\r
+ java.lang.String password2, boolean autoScreenName,\r
+ java.lang.String screenName, java.lang.String emailAddress,\r
+ long facebookId, java.lang.String openId, java.util.Locale locale,\r
+ java.lang.String firstName, java.lang.String middleName,\r
+ java.lang.String lastName, int prefixId, int suffixId, boolean male,\r
+ int birthdayMonth, int birthdayDay, int birthdayYear,\r
+ java.lang.String jobTitle, long[] groupIds, long[] organizationIds,\r
+ long[] roleIds, long[] userGroupIds, boolean sendEmail,\r
+ com.liferay.portal.service.ServiceContext serviceContext)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Adds the users to the user group.\r
+ *\r
+ * @param userGroupId the primary key of the user group\r
+ * @param userIds the primary keys of the users\r
+ * @throws PortalException if a user group or user with the primary could\r
+ could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void addUserGroupUsers(long userGroupId, long[] userIds)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Adds a user with workflow.\r
+ *\r
+ * <p>\r
+ * This method handles the creation and bookkeeping of the user including\r
+ * its resources, metadata, and internal data structures. It is not\r
+ * necessary to make subsequent calls to any methods to setup default\r
+ * groups, resources, etc.\r
+ * </p>\r
+ *\r
+ * @param creatorUserId the primary key of the creator\r
+ * @param companyId the primary key of the user's company\r
+ * @param autoPassword whether a password should be automatically generated\r
+ for the user\r
+ * @param password1 the user's password\r
+ * @param password2 the user's password confirmation\r
+ * @param autoScreenName whether a screen name should be automatically\r
+ generated for the user\r
+ * @param screenName the user's screen name\r
+ * @param emailAddress the user's email address\r
+ * @param facebookId the user's facebook ID\r
+ * @param openId the user's OpenID\r
+ * @param locale the user's locale\r
+ * @param firstName the user's first name\r
+ * @param middleName the user's middle name\r
+ * @param lastName the user's last name\r
+ * @param prefixId the user's name prefix ID\r
+ * @param suffixId the user's name suffix ID\r
+ * @param male whether the user is male\r
+ * @param birthdayMonth the user's birthday month (0-based, meaning 0 for\r
+ January)\r
+ * @param birthdayDay the user's birthday day\r
+ * @param birthdayYear the user's birthday year\r
+ * @param jobTitle the user's job title\r
+ * @param groupIds the primary keys of the user's groups\r
+ * @param organizationIds the primary keys of the user's organizations\r
+ * @param roleIds the primary keys of the roles this user possesses\r
+ * @param userGroupIds the primary keys of the user's user groups\r
+ * @param sendEmail whether to send the user an email notification about\r
+ their new account\r
+ * @param serviceContext the user's service context (optionally\r
+ <code>null</code>). Can set the universally unique identifier\r
+ (with the <code>uuid</code> attribute), asset category IDs, asset\r
+ tag names, and expando bridge attributes for the user.\r
+ * @return the new user\r
+ * @throws PortalException if the user's information was invalid\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User addUserWithWorkflow(\r
+ long creatorUserId, long companyId, boolean autoPassword,\r
+ java.lang.String password1, java.lang.String password2,\r
+ boolean autoScreenName, java.lang.String screenName,\r
+ java.lang.String emailAddress, long facebookId,\r
+ java.lang.String openId, java.util.Locale locale,\r
+ java.lang.String firstName, java.lang.String middleName,\r
+ java.lang.String lastName, int prefixId, int suffixId, boolean male,\r
+ int birthdayMonth, int birthdayDay, int birthdayYear,\r
+ java.lang.String jobTitle, long[] groupIds, long[] organizationIds,\r
+ long[] roleIds, long[] userGroupIds, boolean sendEmail,\r
+ com.liferay.portal.service.ServiceContext serviceContext)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Attempts to authenticate the user by their email address and password,\r
+ * while using the AuthPipeline.\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param emailAddress the user's email address\r
+ * @param password the user's password\r
+ * @param headerMap the header map from the authentication request\r
+ * @param parameterMap the parameter map from the authentication request\r
+ * @param resultsMap the map of authentication results (may be nil). After\r
+ a succesful authentication the user's primary key will be placed\r
+ under the key <code>userId</code>.\r
+ * @return the authentication status. This can be {@link\r
+ com.liferay.portal.security.auth.Authenticator#FAILURE}\r
+ indicating that the user's credentials are invalid, {@link\r
+ com.liferay.portal.security.auth.Authenticator#SUCCESS}\r
+ indicating a successful login, or {@link\r
+ com.liferay.portal.security.auth.Authenticator#DNE} indicating\r
+ that a user with that login does not exist.\r
+ * @throws PortalException if <code>emailAddress</code> or\r
+ <code>password</code> was <code>null</code>\r
+ * @throws SystemException if a system exception occurred\r
+ * @see com.liferay.portal.security.auth.AuthPipeline\r
+ */\r
+ public int authenticateByEmailAddress(long companyId,\r
+ java.lang.String emailAddress, java.lang.String password,\r
+ java.util.Map<java.lang.String, java.lang.String[]> headerMap,\r
+ java.util.Map<java.lang.String, java.lang.String[]> parameterMap,\r
+ java.util.Map<java.lang.String, java.lang.Object> resultsMap)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Attempts to authenticate the user by their screen name and password,\r
+ * while using the AuthPipeline.\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param screenName the user's screen name\r
+ * @param password the user's password\r
+ * @param headerMap the header map from the authentication request\r
+ * @param parameterMap the parameter map from the authentication request\r
+ * @param resultsMap the map of authentication results (may be nil). After\r
+ a succesful authentication the user's primary key will be placed\r
+ under the key <code>userId</code>.\r
+ * @return the authentication status. This can be {@link\r
+ com.liferay.portal.security.auth.Authenticator#FAILURE}\r
+ indicating that the user's credentials are invalid, {@link\r
+ com.liferay.portal.security.auth.Authenticator#SUCCESS}\r
+ indicating a successful login, or {@link\r
+ com.liferay.portal.security.auth.Authenticator#DNE} indicating\r
+ that a user with that login does not exist.\r
+ * @throws PortalException if <code>screenName</code> or\r
+ <code>password</code> was <code>null</code>\r
+ * @throws SystemException if a system exception occurred\r
+ * @see com.liferay.portal.security.auth.AuthPipeline\r
+ */\r
+ public int authenticateByScreenName(long companyId,\r
+ java.lang.String screenName, java.lang.String password,\r
+ java.util.Map<java.lang.String, java.lang.String[]> headerMap,\r
+ java.util.Map<java.lang.String, java.lang.String[]> parameterMap,\r
+ java.util.Map<java.lang.String, java.lang.Object> resultsMap)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Attempts to authenticate the user by their primary key and password,\r
+ * while using the AuthPipeline.\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param userId the user's primary key\r
+ * @param password the user's password\r
+ * @param headerMap the header map from the authentication request\r
+ * @param parameterMap the parameter map from the authentication request\r
+ * @param resultsMap the map of authentication results (may be nil). After\r
+ a succesful authentication the user's primary key will be placed\r
+ under the key <code>userId</code>.\r
+ * @return the authentication status. This can be {@link\r
+ com.liferay.portal.security.auth.Authenticator#FAILURE}\r
+ indicating that the user's credentials are invalid, {@link\r
+ com.liferay.portal.security.auth.Authenticator#SUCCESS}\r
+ indicating a successful login, or {@link\r
+ com.liferay.portal.security.auth.Authenticator#DNE} indicating\r
+ that a user with that login does not exist.\r
+ * @throws PortalException if <code>userId</code> or <code>password</code>\r
+ was <code>null</code>\r
+ * @throws SystemException if a system exception occurred\r
+ * @see com.liferay.portal.security.auth.AuthPipeline\r
+ */\r
+ public int authenticateByUserId(long companyId, long userId,\r
+ java.lang.String password,\r
+ java.util.Map<java.lang.String, java.lang.String[]> headerMap,\r
+ java.util.Map<java.lang.String, java.lang.String[]> parameterMap,\r
+ java.util.Map<java.lang.String, java.lang.Object> resultsMap)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Attempts to authenticate the user using HTTP basic access authentication,\r
+ * without using the AuthPipeline. Primarily used for authenticating users\r
+ * of <code>tunnel-web</code>.\r
+ *\r
+ * <p>\r
+ * Authentication type specifies what <code>login</code> contains.The valid\r
+ * values are:\r
+ * </p>\r
+ *\r
+ * <ul>\r
+ * <li>\r
+ * <code>CompanyConstants.AUTH_TYPE_EA</code> - <code>login</code> is the\r
+ * user's email address\r
+ * </li>\r
+ * <li>\r
+ * <code>CompanyConstants.AUTH_TYPE_SN</code> - <code>login</code> is the\r
+ * user's screen name\r
+ * </li>\r
+ * <li>\r
+ * <code>CompanyConstants.AUTH_TYPE_ID</code> - <code>login</code> is the\r
+ * user's primary key\r
+ * </li>\r
+ * </ul>\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param authType the type of authentication to perform\r
+ * @param login either the user's email address, screen name, or primary\r
+ key depending on the value of <code>authType</code>\r
+ * @param password the user's password\r
+ * @return the authentication status. This can be {@link\r
+ com.liferay.portal.security.auth.Authenticator#FAILURE}\r
+ indicating that the user's credentials are invalid, {@link\r
+ com.liferay.portal.security.auth.Authenticator#SUCCESS}\r
+ indicating a successful login, or {@link\r
+ com.liferay.portal.security.auth.Authenticator#DNE} indicating\r
+ that a user with that login does not exist.\r
+ * @throws PortalException if a portal exception occurred\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public long authenticateForBasic(long companyId, java.lang.String authType,\r
+ java.lang.String login, java.lang.String password)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Attempts to authenticate the user using HTTP digest access\r
+ * authentication, without using the AuthPipeline. Primarily used for\r
+ * authenticating users of <code>tunnel-web</code>.\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param username either the user's email address, screen name, or primary\r
+ key\r
+ * @param realm unused\r
+ * @param nonce the number used once\r
+ * @param method the request method\r
+ * @param uri the request URI\r
+ * @param response the authentication response hash\r
+ * @return the user's primary key if authentication is succesful;\r
+ <code>0</code> otherwise\r
+ * @throws PortalException if a portal exception occurred\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public long authenticateForDigest(long companyId,\r
+ java.lang.String username, java.lang.String realm,\r
+ java.lang.String nonce, java.lang.String method, java.lang.String uri,\r
+ java.lang.String response)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Attempts to authenticate the user using JAAS credentials, without using\r
+ * the AuthPipeline.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param encPassword the encrypted password\r
+ * @return <code>true</code> if authentication is successful;\r
+ <code>false</code> otherwise\r
+ */\r
+ public boolean authenticateForJAAS(long userId, java.lang.String encPassword);\r
+\r
+ /**\r
+ * Checks if the user is currently locked out based on the password policy,\r
+ * and performs maintenance on the user's lockout and failed login data.\r
+ *\r
+ * @param user the user\r
+ * @throws PortalException if the user was determined to still be locked out\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void checkLockout(com.liferay.portal.model.User user)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Adds a failed login attempt to the user and updates the user's last\r
+ * failed login date.\r
+ *\r
+ * @param user the user\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void checkLoginFailure(com.liferay.portal.model.User user)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Adds a failed login attempt to the user with the email address and\r
+ * updates the user's last failed login date.\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param emailAddress the user's email address\r
+ * @throws PortalException if a user with the email address could not be\r
+ found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void checkLoginFailureByEmailAddress(long companyId,\r
+ java.lang.String emailAddress)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Adds a failed login attempt to the user and updates the user's last\r
+ * failed login date.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void checkLoginFailureById(long userId)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Adds a failed login attempt to the user with the screen name and updates\r
+ * the user's last failed login date.\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param screenName the user's screen name\r
+ * @throws PortalException if a user with the screen name could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void checkLoginFailureByScreenName(long companyId,\r
+ java.lang.String screenName)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Checks if the user's password is expired based on the password policy,\r
+ * and performs maintenance on the user's grace login and password reset\r
+ * data.\r
+ *\r
+ * @param user the user\r
+ * @throws PortalException if the user's password has expired and the grace\r
+ login limit has been exceeded\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void checkPasswordExpired(com.liferay.portal.model.User user)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Removes all the users from the organization.\r
+ *\r
+ * @param organizationId the primary key of the organization\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void clearOrganizationUsers(long organizationId)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Removes all the users from the user group.\r
+ *\r
+ * @param userGroupId the primary key of the user group\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void clearUserGroupUsers(long userGroupId)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Completes the user's registration by generating a password and sending\r
+ * the confirmation email.\r
+ *\r
+ * @param user the user\r
+ * @param serviceContext the user's service context. Can set whether a\r
+ password should be generated (with the <code>autoPassword</code>\r
+ attribute) and whether the confirmation email should be sent\r
+ (with the <code>sendEmail</code> attribute) for the user.\r
+ * @throws PortalException if a portal exception occurred\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void completeUserRegistration(com.liferay.portal.model.User user,\r
+ com.liferay.portal.service.ServiceContext serviceContext)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Decrypts the user's primary key and password from their encrypted forms.\r
+ * Used for decrypting a user's credentials from the values stored in an\r
+ * automatic login cookie.\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param name the encrypted primary key of the user\r
+ * @param password the encrypted password of the user\r
+ * @return the user's primary key and password\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ or if the user's password was incorrect\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.kernel.util.KeyValuePair decryptUserId(\r
+ long companyId, java.lang.String name, java.lang.String password)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Deletes the user's portrait image.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ or if the user's portrait could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void deletePortrait(long userId)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Removes the user from the role.\r
+ *\r
+ * @param roleId the primary key of the role\r
+ * @param userId the primary key of the user\r
+ * @throws PortalException if a role or user with the primary key could not\r
+ be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void deleteRoleUser(long roleId, long userId)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Removes the user from the user group.\r
+ *\r
+ * @param userGroupId the primary key of the user group\r
+ * @param userId the primary key of the user\r
+ * @throws PortalException if a portal exception occurred\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void deleteUserGroupUser(long userGroupId, long userId)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Encrypts the primary key of the user. Used when encrypting the user's\r
+ * credentials for storage in an automatic login cookie.\r
+ *\r
+ * @param name the primary key of the user\r
+ * @return the user's encrypted primary key\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public java.lang.String encryptUserId(java.lang.String name)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the user with the email address.\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param emailAddress the user's email address\r
+ * @return the user with the email address, or <code>null</code> if a user\r
+ with the email address could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public com.liferay.portal.model.User fetchUserByEmailAddress(\r
+ long companyId, java.lang.String emailAddress)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the user with the primary key.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @return the user with the primary key, or <code>null</code> if a user\r
+ with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public com.liferay.portal.model.User fetchUserById(long userId)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the user with the screen name.\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param screenName the user's screen name\r
+ * @return the user with the screen name, or <code>null</code> if a user\r
+ with the screen name could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public com.liferay.portal.model.User fetchUserByScreenName(long companyId,\r
+ java.lang.String screenName)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public List<com.liferay.portal.model.User> findUsersByEmail(String email)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+\r
+ /**\r
+ * Returns a range of all the users belonging to the company.\r
+ *\r
+ * <p>\r
+ * Useful when paginating results. Returns a maximum of <code>end -\r
+ * start</code> instances. <code>start</code> and <code>end</code> are not\r
+ * primary keys, they are indexes in the result set. Thus, <code>0</code>\r
+ * refers to the first result in the set. Setting both <code>start</code>\r
+ * and <code>end</code> to {@link\r
+ * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full\r
+ * result set.\r
+ * </p>\r
+ *\r
+ * @param companyId the primary key of the company\r
+ * @param start the lower bound of the range of users\r
+ * @param end the upper bound of the range of users (not inclusive)\r
+ * @return the range of users belonging to the company\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public java.util.List<com.liferay.portal.model.User> getCompanyUsers(\r
+ long companyId, int start, int end)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the number of users belonging to the company.\r
+ *\r
+ * @param companyId the primary key of the company\r
+ * @return the number of users belonging to the company\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public int getCompanyUsersCount(long companyId)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the default user for the company.\r
+ *\r
+ * @param companyId the primary key of the company\r
+ * @return the default user for the company\r
+ * @throws PortalException if a default user for the company could not be\r
+ found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public com.liferay.portal.model.User getDefaultUser(long companyId)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the primary key of the default user for the company.\r
+ *\r
+ * @param companyId the primary key of the company\r
+ * @return the primary key of the default user for the company\r
+ * @throws PortalException if a default user for the company could not be\r
+ found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public long getDefaultUserId(long companyId)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the primary keys of all the users belonging to the group.\r
+ *\r
+ * @param groupId the primary key of the group\r
+ * @return the primary keys of the users belonging to the group\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public long[] getGroupUserIds(long groupId)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns all the users belonging to the group.\r
+ *\r
+ * @param groupId the primary key of the group\r
+ * @return the users belonging to the group\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public java.util.List<com.liferay.portal.model.User> getGroupUsers(\r
+ long groupId)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the number of users belonging to the group.\r
+ *\r
+ * @param groupId the primary key of the group\r
+ * @return the number of users belonging to the group\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public int getGroupUsersCount(long groupId)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the number of users with the status belonging to the group.\r
+ *\r
+ * @param groupId the primary key of the group\r
+ * @param status the workflow status\r
+ * @return the number of users with the status belonging to the group\r
+ * @throws PortalException if a group with the primary key could not be\r
+ found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public int getGroupUsersCount(long groupId, int status)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns all the users who have not had any announcements of the type\r
+ * delivered, excluding the default user.\r
+ *\r
+ * @param type the type of announcement\r
+ * @return the users who have not had any annoucements of the type delivered\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public java.util.List<com.liferay.portal.model.User> getNoAnnouncementsDeliveries(\r
+ java.lang.String type)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns all the users who do not have any contacts.\r
+ *\r
+ * @return the users who do not have any contacts\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public java.util.List<com.liferay.portal.model.User> getNoContacts()\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns all the users who do not belong to any groups, excluding the\r
+ * default user.\r
+ *\r
+ * @return the users who do not belong to any groups\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public java.util.List<com.liferay.portal.model.User> getNoGroups()\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the primary keys of all the users belonging to the organization.\r
+ *\r
+ * @param organizationId the primary key of the organization\r
+ * @return the primary keys of the users belonging to the organization\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public long[] getOrganizationUserIds(long organizationId)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns all the users belonging to the organization.\r
+ *\r
+ * @param organizationId the primary key of the organization\r
+ * @return the users belonging to the organization\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public java.util.List<com.liferay.portal.model.User> getOrganizationUsers(\r
+ long organizationId)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+ \r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public List<User> getOrganizationUsers(long organizationId,\r
+ int start, int stop) throws SystemException;\r
+ \r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public List<User> getOrganizationUsers(long organizationId,\r
+ int start, int stop, OrderByComparator orderComp) throws SystemException;\r
+\r
+ /**\r
+ * Returns the number of users belonging to the organization.\r
+ *\r
+ * @param organizationId the primary key of the organization\r
+ * @return the number of users belonging to the organization\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public int getOrganizationUsersCount(long organizationId)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the number of users with the status belonging to the\r
+ * organization.\r
+ *\r
+ * @param organizationId the primary key of the organization\r
+ * @param status the workflow status\r
+ * @return the number of users with the status belonging to the organization\r
+ * @throws PortalException if an organization with the primary key could not\r
+ be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public int getOrganizationUsersCount(long organizationId, int status)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the primary keys of all the users belonging to the role.\r
+ *\r
+ * @param roleId the primary key of the role\r
+ * @return the primary keys of the users belonging to the role\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public long[] getRoleUserIds(long roleId)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns all the users belonging to the role.\r
+ *\r
+ * @param roleId the primary key of the role\r
+ * @return the users belonging to the role\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public java.util.List<com.liferay.portal.model.User> getRoleUsers(\r
+ long roleId) throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns a range of all the users belonging to the role.\r
+ *\r
+ * <p>\r
+ * Useful when paginating results. Returns a maximum of <code>end -\r
+ * start</code> instances. <code>start</code> and <code>end</code> are not\r
+ * primary keys, they are indexes in the result set. Thus, <code>0</code>\r
+ * refers to the first result in the set. Setting both <code>start</code>\r
+ * and <code>end</code> to {@link\r
+ * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full\r
+ * result set.\r
+ * </p>\r
+ *\r
+ * @param roleId the primary key of the role\r
+ * @param start the lower bound of the range of users\r
+ * @param end the upper bound of the range of users (not inclusive)\r
+ * @return the range of users belonging to the role\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public java.util.List<com.liferay.portal.model.User> getRoleUsers(\r
+ long roleId, int start, int end)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the number of users belonging to the role.\r
+ *\r
+ * @param roleId the primary key of the role\r
+ * @return the number of users belonging to the role\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public int getRoleUsersCount(long roleId)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the number of users with the status belonging to the role.\r
+ *\r
+ * @param roleId the primary key of the role\r
+ * @param status the workflow status\r
+ * @return the number of users with the status belonging to the role\r
+ * @throws PortalException if an role with the primary key could not be\r
+ found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public int getRoleUsersCount(long roleId, int status)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns an ordered range of all the users with a social relation of the\r
+ * type with the user.\r
+ *\r
+ * <p>\r
+ * Useful when paginating results. Returns a maximum of <code>end -\r
+ * start</code> instances. <code>start</code> and <code>end</code> are not\r
+ * primary keys, they are indexes in the result set. Thus, <code>0</code>\r
+ * refers to the first result in the set. Setting both <code>start</code>\r
+ * and <code>end</code> to {@link\r
+ * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full\r
+ * result set.\r
+ * </p>\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param type the type of social relation. The possible types can be found\r
+ in {@link\r
+ com.liferay.portlet.social.model.SocialRelationConstants}.\r
+ * @param start the lower bound of the range of users\r
+ * @param end the upper bound of the range of users (not inclusive)\r
+ * @param obc the comparator to order the users by (optionally\r
+ <code>null</code>)\r
+ * @return the ordered range of users with a social relation of the type\r
+ with the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public java.util.List<com.liferay.portal.model.User> getSocialUsers(\r
+ long userId, int type, int start, int end,\r
+ com.liferay.portal.kernel.util.OrderByComparator obc)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns an ordered range of all the users with a social relation with the\r
+ * user.\r
+ *\r
+ * <p>\r
+ * Useful when paginating results. Returns a maximum of <code>end -\r
+ * start</code> instances. <code>start</code> and <code>end</code> are not\r
+ * primary keys, they are indexes in the result set. Thus, <code>0</code>\r
+ * refers to the first result in the set. Setting both <code>start</code>\r
+ * and <code>end</code> to {@link\r
+ * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full\r
+ * result set.\r
+ * </p>\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param start the lower bound of the range of users\r
+ * @param end the upper bound of the range of users (not inclusive)\r
+ * @param obc the comparator to order the users by (optionally\r
+ <code>null</code>)\r
+ * @return the ordered range of users with a social relation with the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public java.util.List<com.liferay.portal.model.User> getSocialUsers(\r
+ long userId, int start, int end,\r
+ com.liferay.portal.kernel.util.OrderByComparator obc)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns an ordered range of all the users with a mutual social relation\r
+ * of the type with both of the given users.\r
+ *\r
+ * <p>\r
+ * Useful when paginating results. Returns a maximum of <code>end -\r
+ * start</code> instances. <code>start</code> and <code>end</code> are not\r
+ * primary keys, they are indexes in the result set. Thus, <code>0</code>\r
+ * refers to the first result in the set. Setting both <code>start</code>\r
+ * and <code>end</code> to {@link\r
+ * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full\r
+ * result set.\r
+ * </p>\r
+ *\r
+ * @param userId1 the primary key of the first user\r
+ * @param userId2 the primary key of the second user\r
+ * @param type the type of social relation. The possible types can be found\r
+ in {@link\r
+ com.liferay.portlet.social.model.SocialRelationConstants}.\r
+ * @param start the lower bound of the range of users\r
+ * @param end the upper bound of the range of users (not inclusive)\r
+ * @param obc the comparator to order the users by (optionally\r
+ <code>null</code>)\r
+ * @return the ordered range of users with a mutual social relation of the\r
+ type with the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public java.util.List<com.liferay.portal.model.User> getSocialUsers(\r
+ long userId1, long userId2, int type, int start, int end,\r
+ com.liferay.portal.kernel.util.OrderByComparator obc)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns an ordered range of all the users with a mutual social relation\r
+ * with both of the given users.\r
+ *\r
+ * <p>\r
+ * Useful when paginating results. Returns a maximum of <code>end -\r
+ * start</code> instances. <code>start</code> and <code>end</code> are not\r
+ * primary keys, they are indexes in the result set. Thus, <code>0</code>\r
+ * refers to the first result in the set. Setting both <code>start</code>\r
+ * and <code>end</code> to {@link\r
+ * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full\r
+ * result set.\r
+ * </p>\r
+ *\r
+ * @param userId1 the primary key of the first user\r
+ * @param userId2 the primary key of the second user\r
+ * @param start the lower bound of the range of users\r
+ * @param end the upper bound of the range of users (not inclusive)\r
+ * @param obc the comparator to order the users by (optionally\r
+ <code>null</code>)\r
+ * @return the ordered range of users with a mutual social relation with the\r
+ user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public java.util.List<com.liferay.portal.model.User> getSocialUsers(\r
+ long userId1, long userId2, int start, int end,\r
+ com.liferay.portal.kernel.util.OrderByComparator obc)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the number of users with a social relation with the user.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @return the number of users with a social relation with the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public int getSocialUsersCount(long userId)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the number of users with a social relation of the type with the\r
+ * user.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param type the type of social relation. The possible types can be found\r
+ in {@link\r
+ com.liferay.portlet.social.model.SocialRelationConstants}.\r
+ * @return the number of users with a social relation of the type with the\r
+ user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public int getSocialUsersCount(long userId, int type)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the number of users with a mutual social relation with both of\r
+ * the given users.\r
+ *\r
+ * @param userId1 the primary key of the first user\r
+ * @param userId2 the primary key of the second user\r
+ * @return the number of users with a mutual social relation with the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public int getSocialUsersCount(long userId1, long userId2)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the number of users with a mutual social relation of the type\r
+ * with both of the given users.\r
+ *\r
+ * @param userId1 the primary key of the first user\r
+ * @param userId2 the primary key of the second user\r
+ * @param type the type of social relation. The possible types can be found\r
+ in {@link\r
+ com.liferay.portlet.social.model.SocialRelationConstants}.\r
+ * @return the number of users with a mutual social relation of the type\r
+ with the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public int getSocialUsersCount(long userId1, long userId2, int type)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the user with the contact ID.\r
+ *\r
+ * @param contactId the user's contact ID\r
+ * @return the user with the contact ID\r
+ * @throws PortalException if a user with the contact ID could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public com.liferay.portal.model.User getUserByContactId(long contactId)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the user with the email address.\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param emailAddress the user's email address\r
+ * @return the user with the email address\r
+ * @throws PortalException if a user with the email address could not be\r
+ found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public com.liferay.portal.model.User getUserByEmailAddress(long companyId,\r
+ java.lang.String emailAddress)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the user with the Facebook ID.\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param facebookId the user's Facebook ID\r
+ * @return the user with the Facebook ID\r
+ * @throws PortalException if a user with the Facebook ID could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public com.liferay.portal.model.User getUserByFacebookId(long companyId,\r
+ long facebookId)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the user with the primary key.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @return the user with the primary key\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public com.liferay.portal.model.User getUserById(long userId)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the user with the primary key from the company.\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param userId the primary key of the user\r
+ * @return the user with the primary key\r
+ * @throws PortalException if a user with the primary key from the company\r
+ could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public com.liferay.portal.model.User getUserById(long companyId, long userId)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the user with the OpenID.\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param openId the user's OpenID\r
+ * @return the user with the OpenID\r
+ * @throws PortalException if a user with the OpenID could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public com.liferay.portal.model.User getUserByOpenId(long companyId,\r
+ java.lang.String openId)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the user with the portrait ID.\r
+ *\r
+ * @param portraitId the user's portrait ID\r
+ * @return the user with the portrait ID\r
+ * @throws PortalException if a user with the portrait ID could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public com.liferay.portal.model.User getUserByPortraitId(long portraitId)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the user with the screen name.\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param screenName the user's screen name\r
+ * @return the user with the screen name\r
+ * @throws PortalException if a user with the screen name could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public com.liferay.portal.model.User getUserByScreenName(long companyId,\r
+ java.lang.String screenName)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the user with the universally unique identifier.\r
+ *\r
+ * @param uuid the user's universally unique identifier\r
+ * @return the user with the universally unique identifier\r
+ * @throws PortalException if a user with the universally unique identifier\r
+ could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public com.liferay.portal.model.User getUserByUuid(java.lang.String uuid)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns all the users belonging to the user group.\r
+ *\r
+ * @param userGroupId the primary key of the user group\r
+ * @return the users belonging to the user group\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public java.util.List<com.liferay.portal.model.User> getUserGroupUsers(\r
+ long userGroupId)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the number of users belonging to the user group.\r
+ *\r
+ * @param userGroupId the primary key of the user group\r
+ * @return the number of users belonging to the user group\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public int getUserGroupUsersCount(long userGroupId)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the number of users with the status belonging to the user group.\r
+ *\r
+ * @param userGroupId the primary key of the user group\r
+ * @param status the workflow status\r
+ * @return the number of users with the status belonging to the user group\r
+ * @throws PortalException if a user group with the primary key could not be\r
+ found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public int getUserGroupUsersCount(long userGroupId, int status)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the primary key of the user with the email address.\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param emailAddress the user's email address\r
+ * @return the primary key of the user with the email address\r
+ * @throws PortalException if a user with the email address could not be\r
+ found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public long getUserIdByEmailAddress(long companyId,\r
+ java.lang.String emailAddress)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the primary key of the user with the screen name.\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param screenName the user's screen name\r
+ * @return the primary key of the user with the screen name\r
+ * @throws PortalException if a user with the screen name could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public long getUserIdByScreenName(long companyId,\r
+ java.lang.String screenName)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns <code>true</code> if the user is a member of the group.\r
+ *\r
+ * @param groupId the primary key of the group\r
+ * @param userId the primary key of the user\r
+ * @return <code>true</code> if the user is a member of the group;\r
+ <code>false</code> otherwise\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public boolean hasGroupUser(long groupId, long userId)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns <code>true</code> if the user is a member of the organization.\r
+ *\r
+ * @param organizationId the primary key of the organization\r
+ * @param userId the primary key of the user\r
+ * @return <code>true</code> if the user is a member of the organization;\r
+ <code>false</code> otherwise\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public boolean hasOrganizationUser(long organizationId, long userId)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns <code>true</code> if the password policy has been assigned to the\r
+ * user.\r
+ *\r
+ * @param passwordPolicyId the primary key of the password policy\r
+ * @param userId the primary key of the user\r
+ * @return <code>true</code> if the password policy is assigned to the user;\r
+ <code>false</code> otherwise\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public boolean hasPasswordPolicyUser(long passwordPolicyId, long userId)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns <code>true</code> if the user is a member of the role.\r
+ *\r
+ * @param roleId the primary key of the role\r
+ * @param userId the primary key of the user\r
+ * @return <code>true</code> if the user is a member of the role;\r
+ <code>false</code> otherwise\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public boolean hasRoleUser(long roleId, long userId)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns <code>true</code> if the user has the role with the name,\r
+ * optionally through inheritance.\r
+ *\r
+ * @param companyId the primary key of the role's company\r
+ * @param name the name of the role (must be a regular role, not an\r
+ organization, site or provider role)\r
+ * @param userId the primary key of the user\r
+ * @param inherited whether to include roles inherited from organizations,\r
+ sites, etc.\r
+ * @return <code>true</code> if the user has the role; <code>false</code>\r
+ otherwise\r
+ * @throws PortalException if a role with the name could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public boolean hasRoleUser(long companyId, java.lang.String name,\r
+ long userId, boolean inherited)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns <code>true</code> if the user is a member of the team.\r
+ *\r
+ * @param teamId the primary key of the team\r
+ * @param userId the primary key of the user\r
+ * @return <code>true</code> if the user is a member of the team;\r
+ <code>false</code> otherwise\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public boolean hasTeamUser(long teamId, long userId)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns <code>true</code> if the user is a member of the user group.\r
+ *\r
+ * @param userGroupId the primary key of the user group\r
+ * @param userId the primary key of the user\r
+ * @return <code>true</code> if the user is a member of the user group;\r
+ <code>false</code> otherwise\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public boolean hasUserGroupUser(long userGroupId, long userId)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns <code>true</code> if the user's password is expired.\r
+ *\r
+ * @param user the user\r
+ * @return <code>true</code> if the user's password is expired;\r
+ <code>false</code> otherwise\r
+ * @throws PortalException if the password policy for the user could not be\r
+ found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public boolean isPasswordExpired(com.liferay.portal.model.User user)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns <code>true</code> if the user's password is expiring soon.\r
+ *\r
+ * @param user the user\r
+ * @return <code>true</code> if the user's password is expiring soon;\r
+ <code>false</code> otherwise\r
+ * @throws PortalException if the password policy for the user could not be\r
+ found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public boolean isPasswordExpiringSoon(com.liferay.portal.model.User user)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public com.liferay.portal.model.User loadGetDefaultUser(long companyId)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns an ordered range of all the users who match the keywords and\r
+ * status, without using the indexer. It is preferable to use the indexed\r
+ * version {@link #search(long, String, int, LinkedHashMap, int, int, Sort)}\r
+ * instead of this method wherever possible for performance reasons.\r
+ *\r
+ * <p>\r
+ * Useful when paginating results. Returns a maximum of <code>end -\r
+ * start</code> instances. <code>start</code> and <code>end</code> are not\r
+ * primary keys, they are indexes in the result set. Thus, <code>0</code>\r
+ * refers to the first result in the set. Setting both <code>start</code>\r
+ * and <code>end</code> to {@link\r
+ * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full\r
+ * result set.\r
+ * </p>\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param keywords the keywords (space separated), which may occur in the\r
+ user's first name, middle name, last name, screen name, or email\r
+ address\r
+ * @param status the workflow status\r
+ * @param params the finder parameters (optionally <code>null</code>). For\r
+ more information see {@link\r
+ com.liferay.portal.service.persistence.UserFinder}.\r
+ * @param start the lower bound of the range of users\r
+ * @param end the upper bound of the range of users (not inclusive)\r
+ * @param obc the comparator to order the users by (optionally\r
+ <code>null</code>)\r
+ * @return the matching users\r
+ * @throws SystemException if a system exception occurred\r
+ * @see com.liferay.portal.service.persistence.UserFinder\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public java.util.List<com.liferay.portal.model.User> search(\r
+ long companyId, java.lang.String keywords, int status,\r
+ java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,\r
+ int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns an ordered range of all the users who match the keywords and\r
+ * status, using the indexer. It is preferable to use this method instead of\r
+ * the non-indexed version whenever possible for performance reasons.\r
+ *\r
+ * <p>\r
+ * Useful when paginating results. Returns a maximum of <code>end -\r
+ * start</code> instances. <code>start</code> and <code>end</code> are not\r
+ * primary keys, they are indexes in the result set. Thus, <code>0</code>\r
+ * refers to the first result in the set. Setting both <code>start</code>\r
+ * and <code>end</code> to {@link\r
+ * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full\r
+ * result set.\r
+ * </p>\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param keywords the keywords (space separated), which may occur in the\r
+ user's first name, middle name, last name, screen name, or email\r
+ address\r
+ * @param status the workflow status\r
+ * @param params the indexer parameters (optionally <code>null</code>). For\r
+ more information see {@link\r
+ com.liferay.portlet.usersadmin.util.UserIndexer}.\r
+ * @param start the lower bound of the range of users\r
+ * @param end the upper bound of the range of users (not inclusive)\r
+ * @param sort the field and direction to sort by (optionally\r
+ <code>null</code>)\r
+ * @return the matching users\r
+ * @throws SystemException if a system exception occurred\r
+ * @see com.liferay.portlet.usersadmin.util.UserIndexer\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public com.liferay.portal.kernel.search.Hits search(long companyId,\r
+ java.lang.String keywords, int status,\r
+ java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,\r
+ int start, int end, com.liferay.portal.kernel.search.Sort sort)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns an ordered range of all the users with the status, and whose\r
+ * first name, middle name, last name, screen name, and email address match\r
+ * the keywords specified for them, without using the indexer. It is\r
+ * preferable to use the indexed version {@link #search(long, String,\r
+ * String, String, String, String, int, LinkedHashMap, boolean, int, int,\r
+ * Sort)} instead of this method wherever possible for performance reasons.\r
+ *\r
+ * <p>\r
+ * Useful when paginating results. Returns a maximum of <code>end -\r
+ * start</code> instances. <code>start</code> and <code>end</code> are not\r
+ * primary keys, they are indexes in the result set. Thus, <code>0</code>\r
+ * refers to the first result in the set. Setting both <code>start</code>\r
+ * and <code>end</code> to {@link\r
+ * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full\r
+ * result set.\r
+ * </p>\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param firstName the first name keywords (space separated)\r
+ * @param middleName the middle name keywords\r
+ * @param lastName the last name keywords\r
+ * @param screenName the screen name keywords\r
+ * @param emailAddress the email address keywords\r
+ * @param status the workflow status\r
+ * @param params the finder parameters (optionally <code>null</code>). For\r
+ more information see {@link\r
+ com.liferay.portal.service.persistence.UserFinder}.\r
+ * @param andSearch whether every field must match its keywords, or just\r
+ one field. For example, "users with the first name 'bob' and\r
+ last name 'smith'" vs "users with the first name 'bob'\r
+ or the last name 'smith'".\r
+ * @param start the lower bound of the range of users\r
+ * @param end the upper bound of the range of users (not inclusive)\r
+ * @param obc the comparator to order the users by (optionally\r
+ <code>null</code>)\r
+ * @return the matching users\r
+ * @throws SystemException if a system exception occurred\r
+ * @see com.liferay.portal.service.persistence.UserFinder\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public java.util.List<com.liferay.portal.model.User> search(\r
+ long companyId, java.lang.String firstName,\r
+ java.lang.String middleName, java.lang.String lastName,\r
+ java.lang.String screenName, java.lang.String emailAddress, int status,\r
+ java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,\r
+ boolean andSearch, int start, int end,\r
+ com.liferay.portal.kernel.util.OrderByComparator obc)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns an ordered range of all the users with the status, and whose\r
+ * first name, middle name, last name, screen name, and email address match\r
+ * the keywords specified for them, using the indexer. It is preferable to\r
+ * use this method instead of the non-indexed version whenever possible for\r
+ * performance reasons.\r
+ *\r
+ * <p>\r
+ * Useful when paginating results. Returns a maximum of <code>end -\r
+ * start</code> instances. <code>start</code> and <code>end</code> are not\r
+ * primary keys, they are indexes in the result set. Thus, <code>0</code>\r
+ * refers to the first result in the set. Setting both <code>start</code>\r
+ * and <code>end</code> to {@link\r
+ * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full\r
+ * result set.\r
+ * </p>\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param firstName the first name keywords (space separated)\r
+ * @param middleName the middle name keywords\r
+ * @param lastName the last name keywords\r
+ * @param screenName the screen name keywords\r
+ * @param emailAddress the email address keywords\r
+ * @param status the workflow status\r
+ * @param params the indexer parameters (optionally <code>null</code>). For\r
+ more information see {@link\r
+ com.liferay.portlet.usersadmin.util.UserIndexer}.\r
+ * @param andSearch whether every field must match its keywords, or just\r
+ one field. For example, "users with the first name 'bob' and\r
+ last name 'smith'" vs "users with the first name 'bob'\r
+ or the last name 'smith'".\r
+ * @param start the lower bound of the range of users\r
+ * @param end the upper bound of the range of users (not inclusive)\r
+ * @param sort the field and direction to sort by (optionally\r
+ <code>null</code>)\r
+ * @return the matching users\r
+ * @throws SystemException if a system exception occurred\r
+ * @see com.liferay.portlet.usersadmin.util.UserIndexer\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public com.liferay.portal.kernel.search.Hits search(long companyId,\r
+ java.lang.String firstName, java.lang.String middleName,\r
+ java.lang.String lastName, java.lang.String screenName,\r
+ java.lang.String emailAddress, int status,\r
+ java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,\r
+ boolean andSearch, int start, int end,\r
+ com.liferay.portal.kernel.search.Sort sort)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the number of users who match the keywords and status.\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param keywords the keywords (space separated), which may occur in the\r
+ user's first name, middle name, last name, screen name, or email\r
+ address\r
+ * @param status the workflow status\r
+ * @param params the finder parameters (optionally <code>null</code>). For\r
+ more information see {@link\r
+ com.liferay.portal.service.persistence.UserFinder}.\r
+ * @return the number matching users\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public int searchCount(long companyId, java.lang.String keywords,\r
+ int status,\r
+ java.util.LinkedHashMap<java.lang.String, java.lang.Object> params)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Returns the number of users with the status, and whose first name, middle\r
+ * name, last name, screen name, and email address match the keywords\r
+ * specified for them.\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param firstName the first name keywords (space separated)\r
+ * @param middleName the middle name keywords\r
+ * @param lastName the last name keywords\r
+ * @param screenName the screen name keywords\r
+ * @param emailAddress the email address keywords\r
+ * @param status the workflow status\r
+ * @param params the finder parameters (optionally <code>null</code>). For\r
+ more information see {@link\r
+ com.liferay.portal.service.persistence.UserFinder}.\r
+ * @param andSearch whether every field must match its keywords, or just\r
+ one field. For example, "users with the first name 'bob' and\r
+ last name 'smith'" vs "users with the first name 'bob'\r
+ or the last name 'smith'".\r
+ * @return the number of matching users\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
+ public int searchCount(long companyId, java.lang.String firstName,\r
+ java.lang.String middleName, java.lang.String lastName,\r
+ java.lang.String screenName, java.lang.String emailAddress, int status,\r
+ java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,\r
+ boolean andSearch)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Sends an email address verification to the user.\r
+ *\r
+ * @param user the verification email recipient\r
+ * @param emailAddress the recipient's email address\r
+ * @param serviceContext the service context. Must set the portal URL, main\r
+ path, primary key of the layout, remote address, remote host, and\r
+ agent for the user.\r
+ * @throws PortalException if a portal exception occurred\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void sendEmailAddressVerification(\r
+ com.liferay.portal.model.User user, java.lang.String emailAddress,\r
+ com.liferay.portal.service.ServiceContext serviceContext)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Sends the password email to the user with the email address. The content\r
+ * of this email can be specified in <code>portal.properties</code> with the\r
+ * <code>admin.email.password</code> keys.\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param emailAddress the user's email address\r
+ * @param fromName the name of the individual that the email should be from\r
+ * @param fromAddress the address of the individual that the email should\r
+ be from\r
+ * @param subject the email subject. If <code>null</code>, the subject\r
+ specified in <code>portal.properties</code> will be used.\r
+ * @param body the email body. If <code>null</code>, the body specified in\r
+ <code>portal.properties</code> will be used.\r
+ * @param serviceContext the user's service context\r
+ * @throws PortalException if a user with the email address could not be\r
+ found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void sendPassword(long companyId, java.lang.String emailAddress,\r
+ java.lang.String fromName, java.lang.String fromAddress,\r
+ java.lang.String subject, java.lang.String body,\r
+ com.liferay.portal.service.ServiceContext serviceContext)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Sets the users in the role, removing and adding users to the role as\r
+ * necessary.\r
+ *\r
+ * @param roleId the primary key of the role\r
+ * @param userIds the primary keys of the users\r
+ * @throws PortalException if a portal exception occurred\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void setRoleUsers(long roleId, long[] userIds)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Sets the users in the user group, removing and adding users to the user\r
+ * group as necessary.\r
+ *\r
+ * @param userGroupId the primary key of the user group\r
+ * @param userIds the primary keys of the users\r
+ * @throws PortalException if a portal exception occurred\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void setUserGroupUsers(long userGroupId, long[] userIds)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Removes the users from the teams of a group.\r
+ *\r
+ * @param groupId the primary key of the group\r
+ * @param userIds the primary keys of the users\r
+ * @throws PortalException if a portal exception occurred\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void unsetGroupTeamsUsers(long groupId, long[] userIds)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Removes the users from the group.\r
+ *\r
+ * @param groupId the primary key of the group\r
+ * @param userIds the primary keys of the users\r
+ * @throws PortalException if a portal exception occurred\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void unsetGroupUsers(long groupId, long[] userIds,\r
+ com.liferay.portal.service.ServiceContext serviceContext)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Removes the users from the organization.\r
+ *\r
+ * @param organizationId the primary key of the organization\r
+ * @param userIds the primary keys of the users\r
+ * @throws PortalException if a portal exception occurred\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void unsetOrganizationUsers(long organizationId, long[] userIds)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Removes the users from the password policy.\r
+ *\r
+ * @param passwordPolicyId the primary key of the password policy\r
+ * @param userIds the primary keys of the users\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void unsetPasswordPolicyUsers(long passwordPolicyId, long[] userIds)\r
+ throws com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Removes the users from the role.\r
+ *\r
+ * @param roleId the primary key of the role\r
+ * @param users the users\r
+ * @throws PortalException if a portal exception occurred\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void unsetRoleUsers(long roleId,\r
+ java.util.List<com.liferay.portal.model.User> users)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Removes the users from the role.\r
+ *\r
+ * @param roleId the primary key of the role\r
+ * @param userIds the primary keys of the users\r
+ * @throws PortalException if a portal exception occurred\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void unsetRoleUsers(long roleId, long[] userIds)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Removes the users from the team.\r
+ *\r
+ * @param teamId the primary key of the team\r
+ * @param userIds the primary keys of the users\r
+ * @throws PortalException if a portal exception occurred\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void unsetTeamUsers(long teamId, long[] userIds)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Removes the users from the user group.\r
+ *\r
+ * @param userGroupId the primary key of the user group\r
+ * @param userIds the primary keys of the users\r
+ * @throws PortalException if a portal exception occurred\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void unsetUserGroupUsers(long userGroupId, long[] userIds)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates whether the user has agreed to the terms of use.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param agreedToTermsOfUse whether the user has agreet to the terms of\r
+ use\r
+ * @return the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updateAgreedToTermsOfUse(long userId,\r
+ boolean agreedToTermsOfUse)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates the user's asset with the new asset categories and tag names,\r
+ * removing and adding asset categories and tag names as necessary.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param user ID the primary key of the user\r
+ * @param assetCategoryIds the primary key's of the new asset categories\r
+ * @param assetTagNames the new asset tag names\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void updateAsset(long userId, com.liferay.portal.model.User user,\r
+ long[] assetCategoryIds, java.lang.String[] assetTagNames)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates the user's creation date.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param createDate the new creation date\r
+ * @return the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updateCreateDate(long userId,\r
+ java.util.Date createDate)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates the user's email address.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param password the user's password\r
+ * @param emailAddress1 the user's new email address\r
+ * @param emailAddress2 the user's new email address confirmation\r
+ * @return the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updateEmailAddress(long userId,\r
+ java.lang.String password, java.lang.String emailAddress1,\r
+ java.lang.String emailAddress2)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates the user's email address or sends verification email.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param password the user's password\r
+ * @param emailAddress1 the user's new email address\r
+ * @param emailAddress2 the user's new email address confirmation\r
+ * @return the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updateEmailAddress(long userId,\r
+ java.lang.String password, java.lang.String emailAddress1,\r
+ java.lang.String emailAddress2,\r
+ com.liferay.portal.service.ServiceContext serviceContext)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates whether the user has verified email address.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param emailAddressVerified whether the user has verified email address\r
+ * @return the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updateEmailAddressVerified(\r
+ long userId, boolean emailAddressVerified)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates the user's Facebook ID.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param facebookId the user's new Facebook ID\r
+ * @return the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updateFacebookId(long userId,\r
+ long facebookId)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Sets the groups the user is in, removing and adding groups as necessary.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param newGroupIds the primary keys of the groups\r
+ * @throws PortalException if a portal exception occurred\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void updateGroups(long userId, long[] newGroupIds,\r
+ com.liferay.portal.service.ServiceContext serviceContext)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates a user account that was automatically created when a guest user\r
+ * participated in an action (e.g. posting a comment) and only provided his\r
+ * name and email address.\r
+ *\r
+ * @param creatorUserId the primary key of the creator\r
+ * @param companyId the primary key of the user's company\r
+ * @param autoPassword whether a password should be automatically generated\r
+ for the user\r
+ * @param password1 the user's password\r
+ * @param password2 the user's password confirmation\r
+ * @param autoScreenName whether a screen name should be automatically\r
+ generated for the user\r
+ * @param screenName the user's screen name\r
+ * @param emailAddress the user's email address\r
+ * @param facebookId the user's facebook ID\r
+ * @param openId the user's OpenID\r
+ * @param locale the user's locale\r
+ * @param firstName the user's first name\r
+ * @param middleName the user's middle name\r
+ * @param lastName the user's last name\r
+ * @param prefixId the user's name prefix ID\r
+ * @param suffixId the user's name suffix ID\r
+ * @param male whether the user is male\r
+ * @param birthdayMonth the user's birthday month (0-based, meaning 0 for\r
+ January)\r
+ * @param birthdayDay the user's birthday day\r
+ * @param birthdayYear the user's birthday year\r
+ * @param jobTitle the user's job title\r
+ * @param updateUserInformation whether to update the user's information\r
+ * @param sendEmail whether to send the user an email notification about\r
+ their new account\r
+ * @param serviceContext the user's service context (optionally\r
+ <code>null</code>). Can set expando bridge attributes for the\r
+ user.\r
+ * @return the user\r
+ * @throws PortalException if the user's information was invalid\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updateIncompleteUser(\r
+ long creatorUserId, long companyId, boolean autoPassword,\r
+ java.lang.String password1, java.lang.String password2,\r
+ boolean autoScreenName, java.lang.String screenName,\r
+ java.lang.String emailAddress, long facebookId,\r
+ java.lang.String openId, java.util.Locale locale,\r
+ java.lang.String firstName, java.lang.String middleName,\r
+ java.lang.String lastName, int prefixId, int suffixId, boolean male,\r
+ int birthdayMonth, int birthdayDay, int birthdayYear,\r
+ java.lang.String jobTitle, boolean updateUserInformation,\r
+ boolean sendEmail,\r
+ com.liferay.portal.service.ServiceContext serviceContext)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates the user's job title.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param jobTitle the user's job title\r
+ * @return the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ or if a contact could not be found matching the user's contact ID\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updateJobTitle(long userId,\r
+ java.lang.String jobTitle)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates the user's last login with the current time and the IP address.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param loginIP the IP address the user logged in from\r
+ * @return the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updateLastLogin(long userId,\r
+ java.lang.String loginIP)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates whether the user is locked out from logging in.\r
+ *\r
+ * @param user the user\r
+ * @param lockout whether the user is locked out\r
+ * @return the user\r
+ * @throws PortalException if a portal exception occurred\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updateLockout(\r
+ com.liferay.portal.model.User user, boolean lockout)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates whether the user is locked out from logging in.\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param emailAddress the user's email address\r
+ * @param lockout whether the user is locked out\r
+ * @return the user\r
+ * @throws PortalException if a user with the email address could not be\r
+ found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updateLockoutByEmailAddress(\r
+ long companyId, java.lang.String emailAddress, boolean lockout)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates whether the user is locked out from logging in.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param lockout whether the user is locked out\r
+ * @return the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updateLockoutById(long userId,\r
+ boolean lockout)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates whether the user is locked out from logging in.\r
+ *\r
+ * @param companyId the primary key of the user's company\r
+ * @param screenName the user's screen name\r
+ * @param lockout whether the user is locked out\r
+ * @return the user\r
+ * @throws PortalException if a user with the screen name could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updateLockoutByScreenName(\r
+ long companyId, java.lang.String screenName, boolean lockout)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates the user's modified date.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param modifiedDate the new modified date\r
+ * @return the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updateModifiedDate(long userId,\r
+ java.util.Date modifiedDate)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates the user's OpenID.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param openId the new OpenID\r
+ * @return the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updateOpenId(long userId,\r
+ java.lang.String openId)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Sets the organizations that the user is in, removing and adding\r
+ * organizations as necessary.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param newOrganizationIds the primary keys of the organizations\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void updateOrganizations(long userId, long[] newOrganizationIds,\r
+ com.liferay.portal.service.ServiceContext serviceContext)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates the user's password without tracking or validation of the change.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param password1 the user's new password\r
+ * @param password2 the user's new password confirmation\r
+ * @param passwordReset whether the user should be asked to reset their\r
+ password the next time they log in\r
+ * @return the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updatePassword(long userId,\r
+ java.lang.String password1, java.lang.String password2,\r
+ boolean passwordReset)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates the user's password, optionally with tracking and validation of\r
+ * the change.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param password1 the user's new password\r
+ * @param password2 the user's new password confirmation\r
+ * @param passwordReset whether the user should be asked to reset their\r
+ password the next time they login\r
+ * @param silentUpdate whether the password should be updated without being\r
+ tracked, or validated. Primarily used for password imports.\r
+ * @return the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updatePassword(long userId,\r
+ java.lang.String password1, java.lang.String password2,\r
+ boolean passwordReset, boolean silentUpdate)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates the user's password with manually input information. This method\r
+ * should only be used when performing maintenance.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param password the user's new password\r
+ * @param passwordEncrypted the user's new encrypted password\r
+ * @param passwordReset whether the user should be asked to reset their\r
+ password the next time they login\r
+ * @param passwordModifiedDate the new password modified date\r
+ * @return the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updatePasswordManually(long userId,\r
+ java.lang.String password, boolean passwordEncrypted,\r
+ boolean passwordReset, java.util.Date passwordModifiedDate)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates whether the user should be asked to reset their password the next\r
+ * time they login.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param passwordReset whether the user should be asked to reset their\r
+ password the next time they login\r
+ * @return the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updatePasswordReset(long userId,\r
+ boolean passwordReset)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates the user's portrait image.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param bytes the new portrait image data\r
+ * @return the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ or if the new portrait was invalid\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updatePortrait(long userId,\r
+ byte[] bytes)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates the user's password reset question and answer.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param question the user's new password reset question\r
+ * @param answer the user's new password reset answer\r
+ * @return the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ or if the new question or answer were invalid\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updateReminderQuery(long userId,\r
+ java.lang.String question, java.lang.String answer)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates the user's screen name.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param screenName the user's new screen name\r
+ * @return the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ or if the new screen name was invalid\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updateScreenName(long userId,\r
+ java.lang.String screenName)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates the user's workflow status.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param status the user's new workflow status\r
+ * @return the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updateStatus(long userId, int status)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Updates the user.\r
+ *\r
+ * @param userId the primary key of the user\r
+ * @param oldPassword the user's old password\r
+ * @param newPassword1 the user's new password (optionally\r
+ <code>null</code>)\r
+ * @param newPassword2 the user's new password confirmation (optionally\r
+ <code>null</code>)\r
+ * @param passwordReset whether the user should be asked to reset their\r
+ password the next time they login\r
+ * @param reminderQueryQuestion the user's new password reset question\r
+ * @param reminderQueryAnswer the user's new password reset answer\r
+ * @param screenName the user's new screen name\r
+ * @param emailAddress the user's new email address\r
+ * @param facebookId the user's new Facebook ID\r
+ * @param openId the user's new OpenID\r
+ * @param languageId the user's new language ID\r
+ * @param timeZoneId the user's new time zone ID\r
+ * @param greeting the user's new greeting\r
+ * @param comments the user's new comments\r
+ * @param firstName the user's new first name\r
+ * @param middleName the user's new middle name\r
+ * @param lastName the user's new last name\r
+ * @param prefixId the user's new name prefix ID\r
+ * @param suffixId the user's new name suffix ID\r
+ * @param male whether user is male\r
+ * @param birthdayMonth the user's new birthday month (0-based, meaning 0\r
+ for January)\r
+ * @param birthdayDay the user's new birthday day\r
+ * @param birthdayYear the user's birthday year\r
+ * @param smsSn the user's new SMS screen name\r
+ * @param aimSn the user's new AIM screen name\r
+ * @param facebookSn the user's new Facebook screen name\r
+ * @param icqSn the user's new ICQ screen name\r
+ * @param jabberSn the user's new Jabber screen name\r
+ * @param msnSn the user's new MSN screen name\r
+ * @param mySpaceSn the user's new MySpace screen name\r
+ * @param skypeSn the user's new Skype screen name\r
+ * @param twitterSn the user's new Twitter screen name\r
+ * @param ymSn the user's new Yahoo! Messenger screen name\r
+ * @param jobTitle the user's new job title\r
+ * @param groupIds the primary keys of the user's groups\r
+ * @param organizationIds the primary keys of the user's organizations\r
+ * @param roleIds the primary keys of the user's roles\r
+ * @param userGroupRoles the user user's group roles\r
+ * @param userGroupIds the primary keys of the user's user groups\r
+ * @param serviceContext the user's service context (optionally\r
+ <code>null</code>). Can set the universally unique identifier\r
+ (with the <code>uuid</code> attribute), asset category IDs, asset\r
+ tag names, and expando bridge attributes for the user.\r
+ * @return the user\r
+ * @throws PortalException if a user with the primary key could not be found\r
+ or if the new information was invalid\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public com.liferay.portal.model.User updateUser(long userId,\r
+ java.lang.String oldPassword, java.lang.String newPassword1,\r
+ java.lang.String newPassword2, boolean passwordReset,\r
+ java.lang.String reminderQueryQuestion,\r
+ java.lang.String reminderQueryAnswer, java.lang.String screenName,\r
+ java.lang.String emailAddress, long facebookId,\r
+ java.lang.String openId, java.lang.String languageId,\r
+ java.lang.String timeZoneId, java.lang.String greeting,\r
+ java.lang.String comments, java.lang.String firstName,\r
+ java.lang.String middleName, java.lang.String lastName, int prefixId,\r
+ int suffixId, boolean male, int birthdayMonth, int birthdayDay,\r
+ int birthdayYear, java.lang.String smsSn, java.lang.String aimSn,\r
+ java.lang.String facebookSn, java.lang.String icqSn,\r
+ java.lang.String jabberSn, java.lang.String msnSn,\r
+ java.lang.String mySpaceSn, java.lang.String skypeSn,\r
+ java.lang.String twitterSn, java.lang.String ymSn,\r
+ java.lang.String jobTitle, long[] groupIds, long[] organizationIds,\r
+ long[] roleIds,\r
+ java.util.List<com.liferay.portal.model.UserGroupRole> userGroupRoles,\r
+ long[] userGroupIds,\r
+ com.liferay.portal.service.ServiceContext serviceContext)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+\r
+ /**\r
+ * Verifies the email address of the ticket.\r
+ *\r
+ * @param ticketKey the ticket key\r
+ * @throws PortalException if a ticket matching the ticket key could not be\r
+ found, if the ticket has expired, if the ticket is an email\r
+ address ticket, or if the email address is invalid\r
+ * @throws SystemException if a system exception occurred\r
+ */\r
+ public void verifyEmailAddress(java.lang.String ticketKey)\r
+ throws com.liferay.portal.kernel.exception.PortalException,\r
+ com.liferay.portal.kernel.exception.SystemException;\r
+}
\ No newline at end of file