Liferay 6.2-ce-ga5

com.liferay.portal.service
Class UserLocalServiceWrapper

java.lang.Object
  extended by com.liferay.portal.service.UserLocalServiceWrapper
All Implemented Interfaces:
BaseLocalService, PersistedModelLocalService, ServiceWrapper<UserLocalService>, UserLocalService

@ProviderType
public class UserLocalServiceWrapper
extends Object
implements UserLocalService, ServiceWrapper<UserLocalService>

Provides a wrapper for UserLocalService.

See Also:
UserLocalService
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
UserLocalServiceWrapper(UserLocalService userLocalService)
           
 
Method Summary
 User addDefaultAdminUser(long companyId, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName)
          Adds a default admin user for the company.
 void addDefaultGroups(long userId)
          Adds the user to the default groups, unless the user is already in these groups.
 void addDefaultRoles(long userId)
          Adds the user to the default roles, unless the user already has these roles.
 void addDefaultUserGroups(long userId)
          Adds the user to the default user groups, unless the user is already in these user groups.
 void addGroupUser(long groupId, long userId)
           
 void addGroupUser(long groupId, User user)
           
 void addGroupUsers(long groupId, List<User> Users)
           
 void addGroupUsers(long groupId, long[] userIds)
           
 void addOrganizationUser(long organizationId, long userId)
           
 void addOrganizationUser(long organizationId, User user)
           
 void addOrganizationUsers(long organizationId, List<User> Users)
           
 void addOrganizationUsers(long organizationId, long[] userIds)
           
 void addPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
          Assigns the password policy to the users, removing any other currently assigned password policies.
 void addRoleUser(long roleId, long userId)
           
 void addRoleUser(long roleId, User user)
           
 void addRoleUsers(long roleId, List<User> Users)
           
 void addRoleUsers(long roleId, long[] userIds)
           
 void addTeamUser(long teamId, long userId)
           
 void addTeamUser(long teamId, User user)
           
 void addTeamUsers(long teamId, List<User> Users)
           
 void addTeamUsers(long teamId, long[] userIds)
           
 User addUser(long creatorUserId, long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, long facebookId, String openId, Locale locale, String firstName, String middleName, String lastName, int prefixId, int suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, ServiceContext serviceContext)
          Adds a user.
 User addUser(User user)
          Adds the user to the database.
 void addUserGroupUser(long userGroupId, long userId)
           
 void addUserGroupUser(long userGroupId, User user)
           
 void addUserGroupUsers(long userGroupId, List<User> Users)
           
 void addUserGroupUsers(long userGroupId, long[] userIds)
           
 User addUserWithWorkflow(long creatorUserId, long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, long facebookId, String openId, Locale locale, String firstName, String middleName, String lastName, int prefixId, int suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, long[] userGroupIds, boolean sendEmail, ServiceContext serviceContext)
          Adds a user with workflow.
 int authenticateByEmailAddress(long companyId, String emailAddress, String password, Map<String,String[]> headerMap, Map<String,String[]> parameterMap, Map<String,Object> resultsMap)
          Attempts to authenticate the user by their email address and password, while using the AuthPipeline.
 int authenticateByScreenName(long companyId, String screenName, String password, Map<String,String[]> headerMap, Map<String,String[]> parameterMap, Map<String,Object> resultsMap)
          Attempts to authenticate the user by their screen name and password, while using the AuthPipeline.
 int authenticateByUserId(long companyId, long userId, String password, Map<String,String[]> headerMap, Map<String,String[]> parameterMap, Map<String,Object> resultsMap)
          Attempts to authenticate the user by their primary key and password, while using the AuthPipeline.
 long authenticateForBasic(long companyId, String authType, String login, String password)
          Attempts to authenticate the user using HTTP basic access authentication, without using the AuthPipeline.
 long authenticateForDigest(long companyId, String username, String realm, String nonce, String method, String uri, String response)
          Attempts to authenticate the user using HTTP digest access authentication, without using the AuthPipeline.
 boolean authenticateForJAAS(long userId, String encPassword)
          Attempts to authenticate the user using JAAS credentials, without using the AuthPipeline.
 void checkLockout(User user)
          Checks if the user is currently locked out based on the password policy, and performs maintenance on the user's lockout and failed login data.
 void checkLoginFailure(User user)
          Adds a failed login attempt to the user and updates the user's last failed login date.
 void checkLoginFailureByEmailAddress(long companyId, String emailAddress)
          Adds a failed login attempt to the user with the email address and updates the user's last failed login date.
 void checkLoginFailureById(long userId)
          Adds a failed login attempt to the user and updates the user's last failed login date.
 void checkLoginFailureByScreenName(long companyId, String screenName)
          Adds a failed login attempt to the user with the screen name and updates the user's last failed login date.
 void checkPasswordExpired(User user)
          Checks if the user's password is expired based on the password policy, and performs maintenance on the user's grace login and password reset data.
 void clearGroupUsers(long groupId)
           
 void clearOrganizationUsers(long organizationId)
           
 void clearRoleUsers(long roleId)
           
 void clearTeamUsers(long teamId)
           
 void clearUserGroupUsers(long userGroupId)
           
 void completeUserRegistration(User user, ServiceContext serviceContext)
          Completes the user's registration by generating a password and sending the confirmation email.
 User createUser(long userId)
          Creates a new user with the primary key.
 KeyValuePair decryptUserId(long companyId, String name, String password)
          Decrypts the user's primary key and password from their encrypted forms.
 void deleteGroupUser(long groupId, long userId)
           
 void deleteGroupUser(long groupId, User user)
           
 void deleteGroupUsers(long groupId, List<User> Users)
           
 void deleteGroupUsers(long groupId, long[] userIds)
           
 void deleteOrganizationUser(long organizationId, long userId)
           
 void deleteOrganizationUser(long organizationId, User user)
           
 void deleteOrganizationUsers(long organizationId, List<User> Users)
           
 void deleteOrganizationUsers(long organizationId, long[] userIds)
           
 void deletePortrait(long userId)
          Deletes the user's portrait image.
 void deleteRoleUser(long roleId, long userId)
           
 void deleteRoleUser(long roleId, User user)
           
 void deleteRoleUsers(long roleId, List<User> Users)
           
 void deleteRoleUsers(long roleId, long[] userIds)
           
 void deleteTeamUser(long teamId, long userId)
           
 void deleteTeamUser(long teamId, User user)
           
 void deleteTeamUsers(long teamId, List<User> Users)
           
 void deleteTeamUsers(long teamId, long[] userIds)
           
 User deleteUser(long userId)
          Deletes the user with the primary key from the database.
 User deleteUser(User user)
          Deletes the user from the database.
 void deleteUserGroupUser(long userGroupId, long userId)
           
 void deleteUserGroupUser(long userGroupId, User user)
           
 void deleteUserGroupUsers(long userGroupId, List<User> Users)
           
 void deleteUserGroupUsers(long userGroupId, long[] userIds)
           
 DynamicQuery dynamicQuery()
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
 String encryptUserId(String name)
          Encrypts the primary key of the user.
 User fetchUser(long userId)
           
 User fetchUserByEmailAddress(long companyId, String emailAddress)
          Returns the user with the email address.
 User fetchUserByFacebookId(long companyId, long facebookId)
          Returns the user with the Facebook ID.
 User fetchUserById(long userId)
          Returns the user with the primary key.
 User fetchUserByOpenId(long companyId, String openId)
          Returns the user with the OpenID.
 User fetchUserByScreenName(long companyId, String screenName)
          Returns the user with the screen name.
 User fetchUserByUuidAndCompanyId(String uuid, long companyId)
          Returns the user with the matching UUID and company.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 List<User> getCompanyUsers(long companyId, int start, int end)
          Returns a range of all the users belonging to the company.
 int getCompanyUsersCount(long companyId)
          Returns the number of users belonging to the company.
 User getDefaultUser(long companyId)
          Returns the default user for the company.
 long getDefaultUserId(long companyId)
          Returns the primary key of the default user for the company.
 long[] getGroupUserIds(long groupId)
          Returns the primary keys of all the users belonging to the group.
 List<User> getGroupUsers(long groupId)
           
 List<User> getGroupUsers(long groupId, int start, int end)
           
 List<User> getGroupUsers(long groupId, int start, int end, OrderByComparator orderByComparator)
           
 int getGroupUsersCount(long groupId)
           
 int getGroupUsersCount(long groupId, int status)
          Returns the number of users with the status belonging to the group.
 List<User> getInheritedRoleUsers(long roleId, int start, int end, OrderByComparator obc)
           
 List<User> getNoAnnouncementsDeliveries(String type)
          Returns all the users who have not had any announcements of the type delivered, excluding the default user.
 List<User> getNoContacts()
          Returns all the users who do not have any contacts.
 List<User> getNoGroups()
          Returns all the users who do not belong to any groups, excluding the default user.
 long[] getOrganizationUserIds(long organizationId)
          Returns the primary keys of all the users belonging to the organization.
 List<User> getOrganizationUsers(long organizationId)
           
 List<User> getOrganizationUsers(long organizationId, int start, int end)
           
 List<User> getOrganizationUsers(long organizationId, int start, int end, OrderByComparator orderByComparator)
           
 int getOrganizationUsersCount(long organizationId)
           
 int getOrganizationUsersCount(long organizationId, int status)
          Returns the number of users with the status belonging to the organization.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 long[] getRoleUserIds(long roleId)
          Returns the primary keys of all the users belonging to the role.
 List<User> getRoleUsers(long roleId)
           
 List<User> getRoleUsers(long roleId, int start, int end)
           
 List<User> getRoleUsers(long roleId, int start, int end, OrderByComparator orderByComparator)
           
 int getRoleUsersCount(long roleId)
           
 int getRoleUsersCount(long roleId, int status)
          Returns the number of users with the status belonging to the role.
 List<User> getSocialUsers(long userId, int type, int start, int end, OrderByComparator obc)
          Returns an ordered range of all the users with a social relation of the type with the user.
 List<User> getSocialUsers(long userId, int start, int end, OrderByComparator obc)
          Returns an ordered range of all the users with a social relation with the user.
 List<User> getSocialUsers(long userId1, long userId2, int type, int start, int end, OrderByComparator obc)
          Returns an ordered range of all the users with a mutual social relation of the type with both of the given users.
 List<User> getSocialUsers(long userId1, long userId2, int start, int end, OrderByComparator obc)
          Returns an ordered range of all the users with a mutual social relation with both of the given users.
 int getSocialUsersCount(long userId)
          Returns the number of users with a social relation with the user.
 int getSocialUsersCount(long userId, int type)
          Returns the number of users with a social relation of the type with the user.
 int getSocialUsersCount(long userId1, long userId2)
          Returns the number of users with a mutual social relation with both of the given users.
 int getSocialUsersCount(long userId1, long userId2, int type)
          Returns the number of users with a mutual social relation of the type with both of the given users.
 List<User> getTeamUsers(long teamId)
           
 List<User> getTeamUsers(long teamId, int start, int end)
           
 List<User> getTeamUsers(long teamId, int start, int end, OrderByComparator orderByComparator)
           
 int getTeamUsersCount(long teamId)
           
 User getUser(long userId)
          Returns the user with the primary key.
 User getUserByContactId(long contactId)
          Returns the user with the contact ID.
 User getUserByEmailAddress(long companyId, String emailAddress)
          Returns the user with the email address.
 User getUserByFacebookId(long companyId, long facebookId)
          Returns the user with the Facebook ID.
 User getUserById(long userId)
          Returns the user with the primary key.
 User getUserById(long companyId, long userId)
          Returns the user with the primary key from the company.
 User getUserByOpenId(long companyId, String openId)
          Returns the user with the OpenID.
 User getUserByPortraitId(long portraitId)
          Returns the user with the portrait ID.
 User getUserByScreenName(long companyId, String screenName)
          Returns the user with the screen name.
 User getUserByUuid(String uuid)
          Deprecated. As of 6.2.0, replaced by getUserByUuidAndCompanyId(String, long)
 User getUserByUuidAndCompanyId(String uuid, long companyId)
          Returns the user with the matching UUID and company.
 List<User> getUserGroupUsers(long userGroupId)
           
 List<User> getUserGroupUsers(long userGroupId, int start, int end)
           
 List<User> getUserGroupUsers(long userGroupId, int start, int end, OrderByComparator orderByComparator)
           
 int getUserGroupUsersCount(long userGroupId)
           
 int getUserGroupUsersCount(long userGroupId, int status)
          Returns the number of users with the status belonging to the user group.
 long getUserIdByEmailAddress(long companyId, String emailAddress)
          Returns the primary key of the user with the email address.
 long getUserIdByScreenName(long companyId, String screenName)
          Returns the primary key of the user with the screen name.
 List<User> getUsers(int start, int end)
          Returns a range of all the users.
 int getUsersCount()
          Returns the number of users.
 UserLocalService getWrappedService()
           
 UserLocalService getWrappedUserLocalService()
          Deprecated. As of 6.1.0, replaced by getWrappedService()
 boolean hasGroupUser(long groupId, long userId)
           
 boolean hasGroupUsers(long groupId)
           
 boolean hasOrganizationUser(long organizationId, long userId)
           
 boolean hasOrganizationUsers(long organizationId)
           
 boolean hasPasswordPolicyUser(long passwordPolicyId, long userId)
          Returns true if the password policy has been assigned to the user.
 boolean hasRoleUser(long roleId, long userId)
           
 boolean hasRoleUser(long companyId, String name, long userId, boolean inherited)
          Returns true if the user has the role with the name, optionally through inheritance.
 boolean hasRoleUsers(long roleId)
           
 boolean hasTeamUser(long teamId, long userId)
           
 boolean hasTeamUsers(long teamId)
           
 boolean hasUserGroupUser(long userGroupId, long userId)
           
 boolean hasUserGroupUsers(long userGroupId)
           
 boolean isPasswordExpired(User user)
          Returns true if the user's password is expired.
 boolean isPasswordExpiringSoon(User user)
          Returns true if the password policy is configured to warn the user that his password is expiring and the remaining time until expiration is equal or less than the configured warning time.
 User loadGetDefaultUser(long companyId)
          Returns the default user for the company.
 List<User> search(long companyId, String keywords, int status, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator obc)
          Returns an ordered range of all the users who match the keywords and status, without using the indexer.
 Hits search(long companyId, String keywords, int status, LinkedHashMap<String,Object> params, int start, int end, Sort sort)
          Returns an ordered range of all the users who match the keywords and status, using the indexer.
 List<User> search(long companyId, String firstName, String middleName, String lastName, String screenName, String emailAddress, int status, LinkedHashMap<String,Object> params, boolean andSearch, int start, int end, OrderByComparator obc)
          Returns an ordered range of all the users with the status, and whose first name, middle name, last name, screen name, and email address match the keywords specified for them, without using the indexer.
 Hits search(long companyId, String firstName, String middleName, String lastName, String screenName, String emailAddress, int status, LinkedHashMap<String,Object> params, boolean andSearch, int start, int end, Sort sort)
          Returns an ordered range of all the users with the status, and whose first name, middle name, last name, screen name, and email address match the keywords specified for them, using the indexer.
 int searchCount(long companyId, String keywords, int status, LinkedHashMap<String,Object> params)
          Returns the number of users who match the keywords and status.
 int searchCount(long companyId, String firstName, String middleName, String lastName, String screenName, String emailAddress, int status, LinkedHashMap<String,Object> params, boolean andSearch)
          Returns the number of users with the status, and whose first name, middle name, last name, screen name, and email address match the keywords specified for them.
 void sendEmailAddressVerification(User user, String emailAddress, ServiceContext serviceContext)
          Sends an email address verification to the user.
 void sendPassword(long companyId, String emailAddress, String fromName, String fromAddress, String subject, String body, ServiceContext serviceContext)
          Sends the password email to the user with the email address.
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setGroupUsers(long groupId, long[] userIds)
           
 void setOrganizationUsers(long organizationId, long[] userIds)
           
 void setRoleUsers(long roleId, long[] userIds)
           
 void setTeamUsers(long teamId, long[] userIds)
           
 void setUserGroupUsers(long userGroupId, long[] userIds)
           
 void setWrappedService(UserLocalService userLocalService)
           
 void setWrappedUserLocalService(UserLocalService userLocalService)
          Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portal.service.UserLocalService)
 void unsetGroupTeamsUsers(long groupId, long[] userIds)
          Removes the users from the teams of a group.
 void unsetGroupUsers(long groupId, long[] userIds, ServiceContext serviceContext)
          Removes the users from the group.
 void unsetOrganizationUsers(long organizationId, long[] userIds)
          Removes the users from the organization.
 void unsetPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
          Removes the users from the password policy.
 void unsetRoleUsers(long roleId, List<User> users)
          Removes the users from the role.
 void unsetRoleUsers(long roleId, long[] userIds)
          Removes the users from the role.
 void unsetTeamUsers(long teamId, long[] userIds)
          Removes the users from the team.
 void unsetUserGroupUsers(long userGroupId, long[] userIds)
          Removes the users from the user group.
 User updateAgreedToTermsOfUse(long userId, boolean agreedToTermsOfUse)
          Updates whether the user has agreed to the terms of use.
 void updateAsset(long userId, User user, long[] assetCategoryIds, String[] assetTagNames)
          Updates the user's asset with the new asset categories and tag names, removing and adding asset categories and tag names as necessary.
 User updateCreateDate(long userId, Date createDate)
          Updates the user's creation date.
 User updateEmailAddress(long userId, String password, String emailAddress1, String emailAddress2)
          Updates the user's email address.
 User updateEmailAddress(long userId, String password, String emailAddress1, String emailAddress2, ServiceContext serviceContext)
          Updates the user's email address or sends verification email.
 User updateEmailAddressVerified(long userId, boolean emailAddressVerified)
          Updates whether the user has verified email address.
 User updateFacebookId(long userId, long facebookId)
          Updates the user's Facebook ID.
 void updateGroups(long userId, long[] newGroupIds, ServiceContext serviceContext)
          Sets the groups the user is in, removing and adding groups as necessary.
 User updateIncompleteUser(long creatorUserId, long companyId, boolean autoPassword, String password1, String password2, boolean autoScreenName, String screenName, String emailAddress, long facebookId, String openId, Locale locale, String firstName, String middleName, String lastName, int prefixId, int suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String jobTitle, boolean updateUserInformation, boolean sendEmail, ServiceContext serviceContext)
          Updates a user account that was automatically created when a guest user participated in an action (e.g. posting a comment) and only provided his name and email address.
 User updateJobTitle(long userId, String jobTitle)
          Updates the user's job title.
 User updateLastLogin(long userId, String loginIP)
          Updates the user's last login with the current time and the IP address.
 User updateLockout(User user, boolean lockout)
          Updates whether the user is locked out from logging in.
 User updateLockoutByEmailAddress(long companyId, String emailAddress, boolean lockout)
          Updates whether the user is locked out from logging in.
 User updateLockoutById(long userId, boolean lockout)
          Updates whether the user is locked out from logging in.
 User updateLockoutByScreenName(long companyId, String screenName, boolean lockout)
          Updates whether the user is locked out from logging in.
 User updateModifiedDate(long userId, Date modifiedDate)
          Updates the user's modified date.
 User updateOpenId(long userId, String openId)
          Updates the user's OpenID.
 void updateOrganizations(long userId, long[] newOrganizationIds, ServiceContext serviceContext)
          Sets the organizations that the user is in, removing and adding organizations as necessary.
 User updatePassword(long userId, String password1, String password2, boolean passwordReset)
          Updates the user's password without tracking or validation of the change.
 User updatePassword(long userId, String password1, String password2, boolean passwordReset, boolean silentUpdate)
          Updates the user's password, optionally with tracking and validation of the change.
 User updatePasswordManually(long userId, String password, boolean passwordEncrypted, boolean passwordReset, Date passwordModifiedDate)
          Updates the user's password with manually input information.
 User updatePasswordReset(long userId, boolean passwordReset)
          Updates whether the user should be asked to reset their password the next time they login.
 User updatePortrait(long userId, byte[] bytes)
          Updates the user's portrait image.
 User updateReminderQuery(long userId, String question, String answer)
          Updates the user's password reset question and answer.
 User updateScreenName(long userId, String screenName)
          Updates the user's screen name.
 User updateStatus(long userId, int status)
          Deprecated. As of 7.0.0, replaced by updateStatus(long, int, ServiceContext)
 User updateStatus(long userId, int status, ServiceContext serviceContext)
          Updates the user's workflow status.
 User updateUser(long userId, String oldPassword, String newPassword1, String newPassword2, boolean passwordReset, String reminderQueryQuestion, String reminderQueryAnswer, String screenName, String emailAddress, long facebookId, String openId, String languageId, String timeZoneId, String greeting, String comments, String firstName, String middleName, String lastName, int prefixId, int suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String smsSn, String aimSn, String facebookSn, String icqSn, String jabberSn, String msnSn, String mySpaceSn, String skypeSn, String twitterSn, String ymSn, String jobTitle, long[] groupIds, long[] organizationIds, long[] roleIds, List<UserGroupRole> userGroupRoles, long[] userGroupIds, ServiceContext serviceContext)
          Updates the user.
 User updateUser(User user)
          Updates the user in the database or adds it if it does not yet exist.
 void verifyEmailAddress(String ticketKey)
          Verifies the email address of the ticket.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserLocalServiceWrapper

public UserLocalServiceWrapper(UserLocalService userLocalService)
Method Detail

addUser

public User addUser(User user)
             throws SystemException
Adds the user to the database. Also notifies the appropriate model listeners.

Specified by:
addUser in interface UserLocalService
Parameters:
user - the user
Returns:
the user that was added
Throws:
SystemException - if a system exception occurred

createUser

public User createUser(long userId)
Creates a new user with the primary key. Does not add the user to the database.

Specified by:
createUser in interface UserLocalService
Parameters:
userId - the primary key for the new user
Returns:
the new user

deleteUser

public User deleteUser(long userId)
                throws PortalException,
                       SystemException
Deletes the user with the primary key from the database. Also notifies the appropriate model listeners.

Specified by:
deleteUser in interface UserLocalService
Parameters:
userId - the primary key of the user
Returns:
the user that was removed
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

deleteUser

public User deleteUser(User user)
                throws PortalException,
                       SystemException
Deletes the user from the database. Also notifies the appropriate model listeners.

Specified by:
deleteUser in interface UserLocalService
Parameters:
user - the user
Returns:
the user that was removed
Throws:
PortalException
SystemException - if a system exception occurred

dynamicQuery

public DynamicQuery dynamicQuery()
Specified by:
dynamicQuery in interface UserLocalService

dynamicQuery

public List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Specified by:
dynamicQuery in interface UserLocalService
Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

public List dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end)
                  throws SystemException
Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from UserModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Specified by:
dynamicQuery in interface UserLocalService
Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

public List dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end,
                         OrderByComparator orderByComparator)
                  throws SystemException
Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from UserModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Specified by:
dynamicQuery in interface UserLocalService
Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Specified by:
dynamicQueryCount in interface UserLocalService
Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery,
                              Projection projection)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Specified by:
dynamicQueryCount in interface UserLocalService
Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchUser

public User fetchUser(long userId)
               throws SystemException
Specified by:
fetchUser in interface UserLocalService
Throws:
SystemException

fetchUserByUuidAndCompanyId

public User fetchUserByUuidAndCompanyId(String uuid,
                                        long companyId)
                                 throws SystemException
Returns the user with the matching UUID and company.

Specified by:
fetchUserByUuidAndCompanyId in interface UserLocalService
Parameters:
uuid - the user's UUID
companyId - the primary key of the company
Returns:
the matching user, or null if a matching user could not be found
Throws:
SystemException - if a system exception occurred

getUser

public User getUser(long userId)
             throws PortalException,
                    SystemException
Returns the user with the primary key.

Specified by:
getUser in interface UserLocalService
Parameters:
userId - the primary key of the user
Returns:
the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

getPersistedModel

public PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Specified by:
getPersistedModel in interface UserLocalService
Throws:
PortalException
SystemException

getUserByUuidAndCompanyId

public User getUserByUuidAndCompanyId(String uuid,
                                      long companyId)
                               throws PortalException,
                                      SystemException
Returns the user with the matching UUID and company.

Specified by:
getUserByUuidAndCompanyId in interface UserLocalService
Parameters:
uuid - the user's UUID
companyId - the primary key of the company
Returns:
the matching user
Throws:
PortalException - if a matching user could not be found
SystemException - if a system exception occurred

getUsers

public List<User> getUsers(int start,
                           int end)
                    throws SystemException
Returns a range of all the users.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from UserModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Specified by:
getUsers in interface UserLocalService
Parameters:
start - the lower bound of the range of users
end - the upper bound of the range of users (not inclusive)
Returns:
the range of users
Throws:
SystemException - if a system exception occurred

getUsersCount

public int getUsersCount()
                  throws SystemException
Returns the number of users.

Specified by:
getUsersCount in interface UserLocalService
Returns:
the number of users
Throws:
SystemException - if a system exception occurred

updateUser

public User updateUser(User user)
                throws SystemException
Updates the user in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Specified by:
updateUser in interface UserLocalService
Parameters:
user - the user
Returns:
the user that was updated
Throws:
SystemException - if a system exception occurred

addGroupUser

public void addGroupUser(long groupId,
                         long userId)
                  throws SystemException
Specified by:
addGroupUser in interface UserLocalService
Throws:
SystemException - if a system exception occurred

addGroupUser

public void addGroupUser(long groupId,
                         User user)
                  throws SystemException
Specified by:
addGroupUser in interface UserLocalService
Throws:
SystemException - if a system exception occurred

addGroupUsers

public void addGroupUsers(long groupId,
                          long[] userIds)
                   throws PortalException,
                          SystemException
Specified by:
addGroupUsers in interface UserLocalService
Throws:
PortalException
SystemException - if a system exception occurred

addGroupUsers

public void addGroupUsers(long groupId,
                          List<User> Users)
                   throws PortalException,
                          SystemException
Specified by:
addGroupUsers in interface UserLocalService
Throws:
PortalException
SystemException - if a system exception occurred

clearGroupUsers

public void clearGroupUsers(long groupId)
                     throws SystemException
Specified by:
clearGroupUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

deleteGroupUser

public void deleteGroupUser(long groupId,
                            long userId)
                     throws SystemException
Specified by:
deleteGroupUser in interface UserLocalService
Throws:
SystemException - if a system exception occurred

deleteGroupUser

public void deleteGroupUser(long groupId,
                            User user)
                     throws SystemException
Specified by:
deleteGroupUser in interface UserLocalService
Throws:
SystemException - if a system exception occurred

deleteGroupUsers

public void deleteGroupUsers(long groupId,
                             long[] userIds)
                      throws SystemException
Specified by:
deleteGroupUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

deleteGroupUsers

public void deleteGroupUsers(long groupId,
                             List<User> Users)
                      throws SystemException
Specified by:
deleteGroupUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

getGroupUsers

public List<User> getGroupUsers(long groupId)
                         throws SystemException
Specified by:
getGroupUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

getGroupUsers

public List<User> getGroupUsers(long groupId,
                                int start,
                                int end)
                         throws SystemException
Specified by:
getGroupUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

getGroupUsers

public List<User> getGroupUsers(long groupId,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException
Specified by:
getGroupUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

getGroupUsersCount

public int getGroupUsersCount(long groupId)
                       throws SystemException
Specified by:
getGroupUsersCount in interface UserLocalService
Throws:
SystemException - if a system exception occurred

hasGroupUser

public boolean hasGroupUser(long groupId,
                            long userId)
                     throws SystemException
Specified by:
hasGroupUser in interface UserLocalService
Throws:
SystemException - if a system exception occurred

hasGroupUsers

public boolean hasGroupUsers(long groupId)
                      throws SystemException
Specified by:
hasGroupUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

setGroupUsers

public void setGroupUsers(long groupId,
                          long[] userIds)
                   throws SystemException
Specified by:
setGroupUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

addOrganizationUser

public void addOrganizationUser(long organizationId,
                                long userId)
                         throws SystemException
Specified by:
addOrganizationUser in interface UserLocalService
Throws:
SystemException - if a system exception occurred

addOrganizationUser

public void addOrganizationUser(long organizationId,
                                User user)
                         throws SystemException
Specified by:
addOrganizationUser in interface UserLocalService
Throws:
SystemException - if a system exception occurred

addOrganizationUsers

public void addOrganizationUsers(long organizationId,
                                 long[] userIds)
                          throws PortalException,
                                 SystemException
Specified by:
addOrganizationUsers in interface UserLocalService
Throws:
PortalException
SystemException - if a system exception occurred

addOrganizationUsers

public void addOrganizationUsers(long organizationId,
                                 List<User> Users)
                          throws PortalException,
                                 SystemException
Specified by:
addOrganizationUsers in interface UserLocalService
Throws:
PortalException
SystemException - if a system exception occurred

clearOrganizationUsers

public void clearOrganizationUsers(long organizationId)
                            throws SystemException
Specified by:
clearOrganizationUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

deleteOrganizationUser

public void deleteOrganizationUser(long organizationId,
                                   long userId)
                            throws SystemException
Specified by:
deleteOrganizationUser in interface UserLocalService
Throws:
SystemException - if a system exception occurred

deleteOrganizationUser

public void deleteOrganizationUser(long organizationId,
                                   User user)
                            throws SystemException
Specified by:
deleteOrganizationUser in interface UserLocalService
Throws:
SystemException - if a system exception occurred

deleteOrganizationUsers

public void deleteOrganizationUsers(long organizationId,
                                    long[] userIds)
                             throws SystemException
Specified by:
deleteOrganizationUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

deleteOrganizationUsers

public void deleteOrganizationUsers(long organizationId,
                                    List<User> Users)
                             throws SystemException
Specified by:
deleteOrganizationUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

getOrganizationUsers

public List<User> getOrganizationUsers(long organizationId)
                                throws SystemException
Specified by:
getOrganizationUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

getOrganizationUsers

public List<User> getOrganizationUsers(long organizationId,
                                       int start,
                                       int end)
                                throws SystemException
Specified by:
getOrganizationUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

getOrganizationUsers

public List<User> getOrganizationUsers(long organizationId,
                                       int start,
                                       int end,
                                       OrderByComparator orderByComparator)
                                throws SystemException
Specified by:
getOrganizationUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

getOrganizationUsersCount

public int getOrganizationUsersCount(long organizationId)
                              throws SystemException
Specified by:
getOrganizationUsersCount in interface UserLocalService
Throws:
SystemException - if a system exception occurred

hasOrganizationUser

public boolean hasOrganizationUser(long organizationId,
                                   long userId)
                            throws SystemException
Specified by:
hasOrganizationUser in interface UserLocalService
Throws:
SystemException - if a system exception occurred

hasOrganizationUsers

public boolean hasOrganizationUsers(long organizationId)
                             throws SystemException
Specified by:
hasOrganizationUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

setOrganizationUsers

public void setOrganizationUsers(long organizationId,
                                 long[] userIds)
                          throws SystemException
Specified by:
setOrganizationUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

addRoleUser

public void addRoleUser(long roleId,
                        long userId)
                 throws SystemException
Specified by:
addRoleUser in interface UserLocalService
Throws:
SystemException - if a system exception occurred

addRoleUser

public void addRoleUser(long roleId,
                        User user)
                 throws SystemException
Specified by:
addRoleUser in interface UserLocalService
Throws:
SystemException - if a system exception occurred

addRoleUsers

public void addRoleUsers(long roleId,
                         long[] userIds)
                  throws PortalException,
                         SystemException
Specified by:
addRoleUsers in interface UserLocalService
Throws:
PortalException
SystemException - if a system exception occurred

addRoleUsers

public void addRoleUsers(long roleId,
                         List<User> Users)
                  throws PortalException,
                         SystemException
Specified by:
addRoleUsers in interface UserLocalService
Throws:
PortalException
SystemException - if a system exception occurred

clearRoleUsers

public void clearRoleUsers(long roleId)
                    throws SystemException
Specified by:
clearRoleUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

deleteRoleUser

public void deleteRoleUser(long roleId,
                           long userId)
                    throws PortalException,
                           SystemException
Specified by:
deleteRoleUser in interface UserLocalService
Throws:
PortalException
SystemException - if a system exception occurred

deleteRoleUser

public void deleteRoleUser(long roleId,
                           User user)
                    throws PortalException,
                           SystemException
Specified by:
deleteRoleUser in interface UserLocalService
Throws:
PortalException
SystemException - if a system exception occurred

deleteRoleUsers

public void deleteRoleUsers(long roleId,
                            long[] userIds)
                     throws SystemException
Specified by:
deleteRoleUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

deleteRoleUsers

public void deleteRoleUsers(long roleId,
                            List<User> Users)
                     throws SystemException
Specified by:
deleteRoleUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

getRoleUsers

public List<User> getRoleUsers(long roleId)
                        throws SystemException
Specified by:
getRoleUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

getRoleUsers

public List<User> getRoleUsers(long roleId,
                               int start,
                               int end)
                        throws SystemException
Specified by:
getRoleUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

getRoleUsers

public List<User> getRoleUsers(long roleId,
                               int start,
                               int end,
                               OrderByComparator orderByComparator)
                        throws SystemException
Specified by:
getRoleUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

getRoleUsersCount

public int getRoleUsersCount(long roleId)
                      throws SystemException
Specified by:
getRoleUsersCount in interface UserLocalService
Throws:
SystemException - if a system exception occurred

hasRoleUser

public boolean hasRoleUser(long roleId,
                           long userId)
                    throws SystemException
Specified by:
hasRoleUser in interface UserLocalService
Throws:
SystemException - if a system exception occurred

hasRoleUsers

public boolean hasRoleUsers(long roleId)
                     throws SystemException
Specified by:
hasRoleUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

setRoleUsers

public void setRoleUsers(long roleId,
                         long[] userIds)
                  throws PortalException,
                         SystemException
Specified by:
setRoleUsers in interface UserLocalService
Throws:
PortalException
SystemException - if a system exception occurred

addTeamUser

public void addTeamUser(long teamId,
                        long userId)
                 throws SystemException
Specified by:
addTeamUser in interface UserLocalService
Throws:
SystemException - if a system exception occurred

addTeamUser

public void addTeamUser(long teamId,
                        User user)
                 throws SystemException
Specified by:
addTeamUser in interface UserLocalService
Throws:
SystemException - if a system exception occurred

addTeamUsers

public void addTeamUsers(long teamId,
                         long[] userIds)
                  throws PortalException,
                         SystemException
Specified by:
addTeamUsers in interface UserLocalService
Throws:
PortalException
SystemException - if a system exception occurred

addTeamUsers

public void addTeamUsers(long teamId,
                         List<User> Users)
                  throws PortalException,
                         SystemException
Specified by:
addTeamUsers in interface UserLocalService
Throws:
PortalException
SystemException - if a system exception occurred

clearTeamUsers

public void clearTeamUsers(long teamId)
                    throws SystemException
Specified by:
clearTeamUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

deleteTeamUser

public void deleteTeamUser(long teamId,
                           long userId)
                    throws SystemException
Specified by:
deleteTeamUser in interface UserLocalService
Throws:
SystemException - if a system exception occurred

deleteTeamUser

public void deleteTeamUser(long teamId,
                           User user)
                    throws SystemException
Specified by:
deleteTeamUser in interface UserLocalService
Throws:
SystemException - if a system exception occurred

deleteTeamUsers

public void deleteTeamUsers(long teamId,
                            long[] userIds)
                     throws SystemException
Specified by:
deleteTeamUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

deleteTeamUsers

public void deleteTeamUsers(long teamId,
                            List<User> Users)
                     throws SystemException
Specified by:
deleteTeamUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

getTeamUsers

public List<User> getTeamUsers(long teamId)
                        throws SystemException
Specified by:
getTeamUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

getTeamUsers

public List<User> getTeamUsers(long teamId,
                               int start,
                               int end)
                        throws SystemException
Specified by:
getTeamUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

getTeamUsers

public List<User> getTeamUsers(long teamId,
                               int start,
                               int end,
                               OrderByComparator orderByComparator)
                        throws SystemException
Specified by:
getTeamUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

getTeamUsersCount

public int getTeamUsersCount(long teamId)
                      throws SystemException
Specified by:
getTeamUsersCount in interface UserLocalService
Throws:
SystemException - if a system exception occurred

hasTeamUser

public boolean hasTeamUser(long teamId,
                           long userId)
                    throws SystemException
Specified by:
hasTeamUser in interface UserLocalService
Throws:
SystemException - if a system exception occurred

hasTeamUsers

public boolean hasTeamUsers(long teamId)
                     throws SystemException
Specified by:
hasTeamUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

setTeamUsers

public void setTeamUsers(long teamId,
                         long[] userIds)
                  throws SystemException
Specified by:
setTeamUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

addUserGroupUser

public void addUserGroupUser(long userGroupId,
                             long userId)
                      throws SystemException
Specified by:
addUserGroupUser in interface UserLocalService
Throws:
SystemException - if a system exception occurred

addUserGroupUser

public void addUserGroupUser(long userGroupId,
                             User user)
                      throws SystemException
Specified by:
addUserGroupUser in interface UserLocalService
Throws:
SystemException - if a system exception occurred

addUserGroupUsers

public void addUserGroupUsers(long userGroupId,
                              long[] userIds)
                       throws PortalException,
                              SystemException
Specified by:
addUserGroupUsers in interface UserLocalService
Throws:
PortalException
SystemException - if a system exception occurred

addUserGroupUsers

public void addUserGroupUsers(long userGroupId,
                              List<User> Users)
                       throws PortalException,
                              SystemException
Specified by:
addUserGroupUsers in interface UserLocalService
Throws:
PortalException
SystemException - if a system exception occurred

clearUserGroupUsers

public void clearUserGroupUsers(long userGroupId)
                         throws SystemException
Specified by:
clearUserGroupUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

deleteUserGroupUser

public void deleteUserGroupUser(long userGroupId,
                                long userId)
                         throws PortalException,
                                SystemException
Specified by:
deleteUserGroupUser in interface UserLocalService
Throws:
PortalException
SystemException - if a system exception occurred

deleteUserGroupUser

public void deleteUserGroupUser(long userGroupId,
                                User user)
                         throws PortalException,
                                SystemException
Specified by:
deleteUserGroupUser in interface UserLocalService
Throws:
PortalException
SystemException - if a system exception occurred

deleteUserGroupUsers

public void deleteUserGroupUsers(long userGroupId,
                                 long[] userIds)
                          throws SystemException
Specified by:
deleteUserGroupUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

deleteUserGroupUsers

public void deleteUserGroupUsers(long userGroupId,
                                 List<User> Users)
                          throws SystemException
Specified by:
deleteUserGroupUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

getUserGroupUsers

public List<User> getUserGroupUsers(long userGroupId)
                             throws SystemException
Specified by:
getUserGroupUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

getUserGroupUsers

public List<User> getUserGroupUsers(long userGroupId,
                                    int start,
                                    int end)
                             throws SystemException
Specified by:
getUserGroupUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

getUserGroupUsers

public List<User> getUserGroupUsers(long userGroupId,
                                    int start,
                                    int end,
                                    OrderByComparator orderByComparator)
                             throws SystemException
Specified by:
getUserGroupUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

getUserGroupUsersCount

public int getUserGroupUsersCount(long userGroupId)
                           throws SystemException
Specified by:
getUserGroupUsersCount in interface UserLocalService
Throws:
SystemException - if a system exception occurred

hasUserGroupUser

public boolean hasUserGroupUser(long userGroupId,
                                long userId)
                         throws SystemException
Specified by:
hasUserGroupUser in interface UserLocalService
Throws:
SystemException - if a system exception occurred

hasUserGroupUsers

public boolean hasUserGroupUsers(long userGroupId)
                          throws SystemException
Specified by:
hasUserGroupUsers in interface UserLocalService
Throws:
SystemException - if a system exception occurred

setUserGroupUsers

public void setUserGroupUsers(long userGroupId,
                              long[] userIds)
                       throws PortalException,
                              SystemException
Specified by:
setUserGroupUsers in interface UserLocalService
Throws:
PortalException
SystemException - if a system exception occurred

getBeanIdentifier

public String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Specified by:
getBeanIdentifier in interface UserLocalService
Returns:
the Spring bean ID for this bean

setBeanIdentifier

public void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Specified by:
setBeanIdentifier in interface UserLocalService
Parameters:
beanIdentifier - the Spring bean ID for this bean

addDefaultAdminUser

public User addDefaultAdminUser(long companyId,
                                String screenName,
                                String emailAddress,
                                Locale locale,
                                String firstName,
                                String middleName,
                                String lastName)
                         throws PortalException,
                                SystemException
Adds a default admin user for the company.

Specified by:
addDefaultAdminUser in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
screenName - the user's screen name
emailAddress - the user's email address
locale - the user's locale
firstName - the user's first name
middleName - the user's middle name
lastName - the user's last name
Returns:
the new default admin user
Throws:
PortalException - n if a portal exception occurred
SystemException - if a system exception occurred

addDefaultGroups

public void addDefaultGroups(long userId)
                      throws PortalException,
                             SystemException
Adds the user to the default groups, unless the user is already in these groups. The default groups can be specified in portal.properties with the key admin.default.group.names.

Specified by:
addDefaultGroups in interface UserLocalService
Parameters:
userId - the primary key of the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

addDefaultRoles

public void addDefaultRoles(long userId)
                     throws PortalException,
                            SystemException
Adds the user to the default roles, unless the user already has these roles. The default roles can be specified in portal.properties with the key admin.default.role.names.

Specified by:
addDefaultRoles in interface UserLocalService
Parameters:
userId - the primary key of the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

addDefaultUserGroups

public void addDefaultUserGroups(long userId)
                          throws PortalException,
                                 SystemException
Adds the user to the default user groups, unless the user is already in these user groups. The default user groups can be specified in portal.properties with the property admin.default.user.group.names.

Specified by:
addDefaultUserGroups in interface UserLocalService
Parameters:
userId - the primary key of the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

addPasswordPolicyUsers

public void addPasswordPolicyUsers(long passwordPolicyId,
                                   long[] userIds)
                            throws SystemException
Assigns the password policy to the users, removing any other currently assigned password policies.

Specified by:
addPasswordPolicyUsers in interface UserLocalService
Parameters:
passwordPolicyId - the primary key of the password policy
userIds - the primary keys of the users
Throws:
SystemException - if a system exception occurred

addUser

public User addUser(long creatorUserId,
                    long companyId,
                    boolean autoPassword,
                    String password1,
                    String password2,
                    boolean autoScreenName,
                    String screenName,
                    String emailAddress,
                    long facebookId,
                    String openId,
                    Locale locale,
                    String firstName,
                    String middleName,
                    String lastName,
                    int prefixId,
                    int suffixId,
                    boolean male,
                    int birthdayMonth,
                    int birthdayDay,
                    int birthdayYear,
                    String jobTitle,
                    long[] groupIds,
                    long[] organizationIds,
                    long[] roleIds,
                    long[] userGroupIds,
                    boolean sendEmail,
                    ServiceContext serviceContext)
             throws PortalException,
                    SystemException
Adds a user.

This method handles the creation and bookkeeping of the user including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, etc.

Specified by:
addUser in interface UserLocalService
Parameters:
creatorUserId - the primary key of the creator
companyId - the primary key of the user's company
autoPassword - whether a password should be automatically generated for the user
password1 - the user's password
password2 - the user's password confirmation
autoScreenName - whether a screen name should be automatically generated for the user
screenName - the user's screen name
emailAddress - the user's email address
facebookId - the user's facebook ID
openId - the user's OpenID
locale - the user's locale
firstName - the user's first name
middleName - the user's middle name
lastName - the user's last name
prefixId - the user's name prefix ID
suffixId - the user's name suffix ID
male - whether the user is male
birthdayMonth - the user's birthday month (0-based, meaning 0 for January)
birthdayDay - the user's birthday day
birthdayYear - the user's birthday year
jobTitle - the user's job title
groupIds - the primary keys of the user's groups
organizationIds - the primary keys of the user's organizations
roleIds - the primary keys of the roles this user possesses
userGroupIds - the primary keys of the user's user groups
sendEmail - whether to send the user an email notification about their new account
serviceContext - the service context to be applied (optionally null). Can set the UUID (with the uuid attribute), asset category IDs, asset tag names, and expando bridge attributes for the user.
Returns:
the new user
Throws:
PortalException - if the user's information was invalid
SystemException - if a system exception occurred

addUserWithWorkflow

public User addUserWithWorkflow(long creatorUserId,
                                long companyId,
                                boolean autoPassword,
                                String password1,
                                String password2,
                                boolean autoScreenName,
                                String screenName,
                                String emailAddress,
                                long facebookId,
                                String openId,
                                Locale locale,
                                String firstName,
                                String middleName,
                                String lastName,
                                int prefixId,
                                int suffixId,
                                boolean male,
                                int birthdayMonth,
                                int birthdayDay,
                                int birthdayYear,
                                String jobTitle,
                                long[] groupIds,
                                long[] organizationIds,
                                long[] roleIds,
                                long[] userGroupIds,
                                boolean sendEmail,
                                ServiceContext serviceContext)
                         throws PortalException,
                                SystemException
Adds a user with workflow.

This method handles the creation and bookkeeping of the user including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, etc.

Specified by:
addUserWithWorkflow in interface UserLocalService
Parameters:
creatorUserId - the primary key of the creator
companyId - the primary key of the user's company
autoPassword - whether a password should be automatically generated for the user
password1 - the user's password
password2 - the user's password confirmation
autoScreenName - whether a screen name should be automatically generated for the user
screenName - the user's screen name
emailAddress - the user's email address
facebookId - the user's facebook ID
openId - the user's OpenID
locale - the user's locale
firstName - the user's first name
middleName - the user's middle name
lastName - the user's last name
prefixId - the user's name prefix ID
suffixId - the user's name suffix ID
male - whether the user is male
birthdayMonth - the user's birthday month (0-based, meaning 0 for January)
birthdayDay - the user's birthday day
birthdayYear - the user's birthday year
jobTitle - the user's job title
groupIds - the primary keys of the user's groups
organizationIds - the primary keys of the user's organizations
roleIds - the primary keys of the roles this user possesses
userGroupIds - the primary keys of the user's user groups
sendEmail - whether to send the user an email notification about their new account
serviceContext - the service context to be applied (optionally null). Can set the UUID (with the uuid attribute), asset category IDs, asset tag names, and expando bridge attributes for the user.
Returns:
the new user
Throws:
PortalException - if the user's information was invalid
SystemException - if a system exception occurred

authenticateByEmailAddress

public int authenticateByEmailAddress(long companyId,
                                      String emailAddress,
                                      String password,
                                      Map<String,String[]> headerMap,
                                      Map<String,String[]> parameterMap,
                                      Map<String,Object> resultsMap)
                               throws PortalException,
                                      SystemException
Attempts to authenticate the user by their email address and password, while using the AuthPipeline.

Specified by:
authenticateByEmailAddress in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
emailAddress - the user's email address
password - the user's password
headerMap - the header map from the authentication request
parameterMap - the parameter map from the authentication request
resultsMap - the map of authentication results (may be nil). After a succesful authentication the user's primary key will be placed under the key userId.
Returns:
the authentication status. This can be Authenticator.FAILURE indicating that the user's credentials are invalid, Authenticator.SUCCESS indicating a successful login, or Authenticator.DNE indicating that a user with that login does not exist.
Throws:
PortalException - if emailAddress or password was null
SystemException - if a system exception occurred
See Also:
AuthPipeline

authenticateByScreenName

public int authenticateByScreenName(long companyId,
                                    String screenName,
                                    String password,
                                    Map<String,String[]> headerMap,
                                    Map<String,String[]> parameterMap,
                                    Map<String,Object> resultsMap)
                             throws PortalException,
                                    SystemException
Attempts to authenticate the user by their screen name and password, while using the AuthPipeline.

Specified by:
authenticateByScreenName in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
screenName - the user's screen name
password - the user's password
headerMap - the header map from the authentication request
parameterMap - the parameter map from the authentication request
resultsMap - the map of authentication results (may be nil). After a succesful authentication the user's primary key will be placed under the key userId.
Returns:
the authentication status. This can be Authenticator.FAILURE indicating that the user's credentials are invalid, Authenticator.SUCCESS indicating a successful login, or Authenticator.DNE indicating that a user with that login does not exist.
Throws:
PortalException - if screenName or password was null
SystemException - if a system exception occurred
See Also:
AuthPipeline

authenticateByUserId

public int authenticateByUserId(long companyId,
                                long userId,
                                String password,
                                Map<String,String[]> headerMap,
                                Map<String,String[]> parameterMap,
                                Map<String,Object> resultsMap)
                         throws PortalException,
                                SystemException
Attempts to authenticate the user by their primary key and password, while using the AuthPipeline.

Specified by:
authenticateByUserId in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
userId - the user's primary key
password - the user's password
headerMap - the header map from the authentication request
parameterMap - the parameter map from the authentication request
resultsMap - the map of authentication results (may be nil). After a succesful authentication the user's primary key will be placed under the key userId.
Returns:
the authentication status. This can be Authenticator.FAILURE indicating that the user's credentials are invalid, Authenticator.SUCCESS indicating a successful login, or Authenticator.DNE indicating that a user with that login does not exist.
Throws:
PortalException - if userId or password was null
SystemException - if a system exception occurred
See Also:
AuthPipeline

authenticateForBasic

public long authenticateForBasic(long companyId,
                                 String authType,
                                 String login,
                                 String password)
                          throws PortalException,
                                 SystemException
Attempts to authenticate the user using HTTP basic access authentication, without using the AuthPipeline. Primarily used for authenticating users of tunnel-web.

Authentication type specifies what login contains.The valid values are:

Specified by:
authenticateForBasic in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
authType - the type of authentication to perform
login - either the user's email address, screen name, or primary key depending on the value of authType
password - the user's password
Returns:
the authentication status. This can be Authenticator.FAILURE indicating that the user's credentials are invalid, Authenticator.SUCCESS indicating a successful login, or Authenticator.DNE indicating that a user with that login does not exist.
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

authenticateForDigest

public long authenticateForDigest(long companyId,
                                  String username,
                                  String realm,
                                  String nonce,
                                  String method,
                                  String uri,
                                  String response)
                           throws PortalException,
                                  SystemException
Attempts to authenticate the user using HTTP digest access authentication, without using the AuthPipeline. Primarily used for authenticating users of tunnel-web.

Specified by:
authenticateForDigest in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
username - either the user's email address, screen name, or primary key
realm - unused
nonce - the number used once
method - the request method
uri - the request URI
response - the authentication response hash
Returns:
the user's primary key if authentication is succesful; 0 otherwise
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

authenticateForJAAS

public boolean authenticateForJAAS(long userId,
                                   String encPassword)
Attempts to authenticate the user using JAAS credentials, without using the AuthPipeline.

Specified by:
authenticateForJAAS in interface UserLocalService
Parameters:
userId - the primary key of the user
encPassword - the encrypted password
Returns:
true if authentication is successful; false otherwise

checkLockout

public void checkLockout(User user)
                  throws PortalException,
                         SystemException
Checks if the user is currently locked out based on the password policy, and performs maintenance on the user's lockout and failed login data.

Specified by:
checkLockout in interface UserLocalService
Parameters:
user - the user
Throws:
PortalException - if the user was determined to still be locked out
SystemException - if a system exception occurred

checkLoginFailure

public void checkLoginFailure(User user)
                       throws SystemException
Adds a failed login attempt to the user and updates the user's last failed login date.

Specified by:
checkLoginFailure in interface UserLocalService
Parameters:
user - the user
Throws:
SystemException - if a system exception occurred

checkLoginFailureByEmailAddress

public void checkLoginFailureByEmailAddress(long companyId,
                                            String emailAddress)
                                     throws PortalException,
                                            SystemException
Adds a failed login attempt to the user with the email address and updates the user's last failed login date.

Specified by:
checkLoginFailureByEmailAddress in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
emailAddress - the user's email address
Throws:
PortalException - if a user with the email address could not be found
SystemException - if a system exception occurred

checkLoginFailureById

public void checkLoginFailureById(long userId)
                           throws PortalException,
                                  SystemException
Adds a failed login attempt to the user and updates the user's last failed login date.

Specified by:
checkLoginFailureById in interface UserLocalService
Parameters:
userId - the primary key of the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

checkLoginFailureByScreenName

public void checkLoginFailureByScreenName(long companyId,
                                          String screenName)
                                   throws PortalException,
                                          SystemException
Adds a failed login attempt to the user with the screen name and updates the user's last failed login date.

Specified by:
checkLoginFailureByScreenName in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
screenName - the user's screen name
Throws:
PortalException - if a user with the screen name could not be found
SystemException - if a system exception occurred

checkPasswordExpired

public void checkPasswordExpired(User user)
                          throws PortalException,
                                 SystemException
Checks if the user's password is expired based on the password policy, and performs maintenance on the user's grace login and password reset data.

Specified by:
checkPasswordExpired in interface UserLocalService
Parameters:
user - the user
Throws:
PortalException - if the user's password has expired and the grace login limit has been exceeded
SystemException - if a system exception occurred

completeUserRegistration

public void completeUserRegistration(User user,
                                     ServiceContext serviceContext)
                              throws PortalException,
                                     SystemException
Completes the user's registration by generating a password and sending the confirmation email.

Specified by:
completeUserRegistration in interface UserLocalService
Parameters:
user - the user
serviceContext - the service context to be applied. You can specify an unencrypted custom password for the user via attribute passwordUnencrypted. You automatically generate a password for the user by setting attribute autoPassword to true. You can send a confirmation email to the user by setting attribute sendEmail to true.
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

decryptUserId

public KeyValuePair decryptUserId(long companyId,
                                  String name,
                                  String password)
                           throws PortalException,
                                  SystemException
Decrypts the user's primary key and password from their encrypted forms. Used for decrypting a user's credentials from the values stored in an automatic login cookie.

Specified by:
decryptUserId in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
name - the encrypted primary key of the user
password - the encrypted password of the user
Returns:
the user's primary key and password
Throws:
PortalException - if a user with the primary key could not be found or if the user's password was incorrect
SystemException - if a system exception occurred

deletePortrait

public void deletePortrait(long userId)
                    throws PortalException,
                           SystemException
Deletes the user's portrait image.

Specified by:
deletePortrait in interface UserLocalService
Parameters:
userId - the primary key of the user
Throws:
PortalException - if a user with the primary key could not be found or if the user's portrait could not be found
SystemException - if a system exception occurred

encryptUserId

public String encryptUserId(String name)
                     throws PortalException,
                            SystemException
Encrypts the primary key of the user. Used when encrypting the user's credentials for storage in an automatic login cookie.

Specified by:
encryptUserId in interface UserLocalService
Parameters:
name - the primary key of the user
Returns:
the user's encrypted primary key
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

fetchUserByEmailAddress

public User fetchUserByEmailAddress(long companyId,
                                    String emailAddress)
                             throws SystemException
Returns the user with the email address.

Specified by:
fetchUserByEmailAddress in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
emailAddress - the user's email address
Returns:
the user with the email address, or null if a user with the email address could not be found
Throws:
SystemException - if a system exception occurred

fetchUserByFacebookId

public User fetchUserByFacebookId(long companyId,
                                  long facebookId)
                           throws SystemException
Returns the user with the Facebook ID.

Specified by:
fetchUserByFacebookId in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
facebookId - the user's Facebook ID
Returns:
the user with the Facebook ID, or null if a user with the Facebook ID could not be found
Throws:
SystemException - if a system exception occurred

fetchUserById

public User fetchUserById(long userId)
                   throws SystemException
Returns the user with the primary key.

Specified by:
fetchUserById in interface UserLocalService
Parameters:
userId - the primary key of the user
Returns:
the user with the primary key, or null if a user with the primary key could not be found
Throws:
SystemException - if a system exception occurred

fetchUserByOpenId

public User fetchUserByOpenId(long companyId,
                              String openId)
                       throws SystemException
Returns the user with the OpenID.

Specified by:
fetchUserByOpenId in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
openId - the user's OpenID
Returns:
the user with the OpenID, or null if a user with the OpenID could not be found
Throws:
SystemException - if a system exception occurred

fetchUserByScreenName

public User fetchUserByScreenName(long companyId,
                                  String screenName)
                           throws SystemException
Returns the user with the screen name.

Specified by:
fetchUserByScreenName in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
screenName - the user's screen name
Returns:
the user with the screen name, or null if a user with the screen name could not be found
Throws:
SystemException - if a system exception occurred

getCompanyUsers

public List<User> getCompanyUsers(long companyId,
                                  int start,
                                  int end)
                           throws SystemException
Returns a range of all the users belonging to the company.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Specified by:
getCompanyUsers in interface UserLocalService
Parameters:
companyId - the primary key of the company
start - the lower bound of the range of users
end - the upper bound of the range of users (not inclusive)
Returns:
the range of users belonging to the company
Throws:
SystemException - if a system exception occurred

getCompanyUsersCount

public int getCompanyUsersCount(long companyId)
                         throws SystemException
Returns the number of users belonging to the company.

Specified by:
getCompanyUsersCount in interface UserLocalService
Parameters:
companyId - the primary key of the company
Returns:
the number of users belonging to the company
Throws:
SystemException - if a system exception occurred

getDefaultUser

public User getDefaultUser(long companyId)
                    throws PortalException,
                           SystemException
Returns the default user for the company.

Specified by:
getDefaultUser in interface UserLocalService
Parameters:
companyId - the primary key of the company
Returns:
the default user for the company
Throws:
PortalException - if a default user for the company could not be found
SystemException - if a system exception occurred

getDefaultUserId

public long getDefaultUserId(long companyId)
                      throws PortalException,
                             SystemException
Returns the primary key of the default user for the company.

Specified by:
getDefaultUserId in interface UserLocalService
Parameters:
companyId - the primary key of the company
Returns:
the primary key of the default user for the company
Throws:
PortalException - if a default user for the company could not be found
SystemException - if a system exception occurred

getGroupUserIds

public long[] getGroupUserIds(long groupId)
                       throws SystemException
Returns the primary keys of all the users belonging to the group.

Specified by:
getGroupUserIds in interface UserLocalService
Parameters:
groupId - the primary key of the group
Returns:
the primary keys of the users belonging to the group
Throws:
SystemException - if a system exception occurred

getGroupUsersCount

public int getGroupUsersCount(long groupId,
                              int status)
                       throws PortalException,
                              SystemException
Returns the number of users with the status belonging to the group.

Specified by:
getGroupUsersCount in interface UserLocalService
Parameters:
groupId - the primary key of the group
status - the workflow status
Returns:
the number of users with the status belonging to the group
Throws:
PortalException - if a group with the primary key could not be found
SystemException - if a system exception occurred

getInheritedRoleUsers

public List<User> getInheritedRoleUsers(long roleId,
                                        int start,
                                        int end,
                                        OrderByComparator obc)
                                 throws PortalException,
                                        SystemException
Specified by:
getInheritedRoleUsers in interface UserLocalService
Throws:
PortalException
SystemException

getNoAnnouncementsDeliveries

public List<User> getNoAnnouncementsDeliveries(String type)
                                        throws SystemException
Returns all the users who have not had any announcements of the type delivered, excluding the default user.

Specified by:
getNoAnnouncementsDeliveries in interface UserLocalService
Parameters:
type - the type of announcement
Returns:
the users who have not had any annoucements of the type delivered
Throws:
SystemException - if a system exception occurred

getNoContacts

public List<User> getNoContacts()
                         throws SystemException
Returns all the users who do not have any contacts.

Specified by:
getNoContacts in interface UserLocalService
Returns:
the users who do not have any contacts
Throws:
SystemException - if a system exception occurred

getNoGroups

public List<User> getNoGroups()
                       throws SystemException
Returns all the users who do not belong to any groups, excluding the default user.

Specified by:
getNoGroups in interface UserLocalService
Returns:
the users who do not belong to any groups
Throws:
SystemException - if a system exception occurred

getOrganizationUserIds

public long[] getOrganizationUserIds(long organizationId)
                              throws SystemException
Returns the primary keys of all the users belonging to the organization.

Specified by:
getOrganizationUserIds in interface UserLocalService
Parameters:
organizationId - the primary key of the organization
Returns:
the primary keys of the users belonging to the organization
Throws:
SystemException - if a system exception occurred

getOrganizationUsersCount

public int getOrganizationUsersCount(long organizationId,
                                     int status)
                              throws PortalException,
                                     SystemException
Returns the number of users with the status belonging to the organization.

Specified by:
getOrganizationUsersCount in interface UserLocalService
Parameters:
organizationId - the primary key of the organization
status - the workflow status
Returns:
the number of users with the status belonging to the organization
Throws:
PortalException - if an organization with the primary key could not be found
SystemException - if a system exception occurred

getRoleUserIds

public long[] getRoleUserIds(long roleId)
                      throws SystemException
Returns the primary keys of all the users belonging to the role.

Specified by:
getRoleUserIds in interface UserLocalService
Parameters:
roleId - the primary key of the role
Returns:
the primary keys of the users belonging to the role
Throws:
SystemException - if a system exception occurred

getRoleUsersCount

public int getRoleUsersCount(long roleId,
                             int status)
                      throws PortalException,
                             SystemException
Returns the number of users with the status belonging to the role.

Specified by:
getRoleUsersCount in interface UserLocalService
Parameters:
roleId - the primary key of the role
status - the workflow status
Returns:
the number of users with the status belonging to the role
Throws:
PortalException - if an role with the primary key could not be found
SystemException - if a system exception occurred

getSocialUsers

public List<User> getSocialUsers(long userId,
                                 int type,
                                 int start,
                                 int end,
                                 OrderByComparator obc)
                          throws PortalException,
                                 SystemException
Returns an ordered range of all the users with a social relation of the type with the user.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Specified by:
getSocialUsers in interface UserLocalService
Parameters:
userId - the primary key of the user
type - the type of social relation. The possible types can be found in SocialRelationConstants.
start - the lower bound of the range of users
end - the upper bound of the range of users (not inclusive)
obc - the comparator to order the users by (optionally null)
Returns:
the ordered range of users with a social relation of the type with the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

getSocialUsers

public List<User> getSocialUsers(long userId,
                                 int start,
                                 int end,
                                 OrderByComparator obc)
                          throws PortalException,
                                 SystemException
Returns an ordered range of all the users with a social relation with the user.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Specified by:
getSocialUsers in interface UserLocalService
Parameters:
userId - the primary key of the user
start - the lower bound of the range of users
end - the upper bound of the range of users (not inclusive)
obc - the comparator to order the users by (optionally null)
Returns:
the ordered range of users with a social relation with the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

getSocialUsers

public List<User> getSocialUsers(long userId1,
                                 long userId2,
                                 int type,
                                 int start,
                                 int end,
                                 OrderByComparator obc)
                          throws PortalException,
                                 SystemException
Returns an ordered range of all the users with a mutual social relation of the type with both of the given users.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Specified by:
getSocialUsers in interface UserLocalService
Parameters:
userId1 - the primary key of the first user
userId2 - the primary key of the second user
type - the type of social relation. The possible types can be found in SocialRelationConstants.
start - the lower bound of the range of users
end - the upper bound of the range of users (not inclusive)
obc - the comparator to order the users by (optionally null)
Returns:
the ordered range of users with a mutual social relation of the type with the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

getSocialUsers

public List<User> getSocialUsers(long userId1,
                                 long userId2,
                                 int start,
                                 int end,
                                 OrderByComparator obc)
                          throws PortalException,
                                 SystemException
Returns an ordered range of all the users with a mutual social relation with both of the given users.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Specified by:
getSocialUsers in interface UserLocalService
Parameters:
userId1 - the primary key of the first user
userId2 - the primary key of the second user
start - the lower bound of the range of users
end - the upper bound of the range of users (not inclusive)
obc - the comparator to order the users by (optionally null)
Returns:
the ordered range of users with a mutual social relation with the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

getSocialUsersCount

public int getSocialUsersCount(long userId)
                        throws PortalException,
                               SystemException
Returns the number of users with a social relation with the user.

Specified by:
getSocialUsersCount in interface UserLocalService
Parameters:
userId - the primary key of the user
Returns:
the number of users with a social relation with the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

getSocialUsersCount

public int getSocialUsersCount(long userId,
                               int type)
                        throws PortalException,
                               SystemException
Returns the number of users with a social relation of the type with the user.

Specified by:
getSocialUsersCount in interface UserLocalService
Parameters:
userId - the primary key of the user
type - the type of social relation. The possible types can be found in SocialRelationConstants.
Returns:
the number of users with a social relation of the type with the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

getSocialUsersCount

public int getSocialUsersCount(long userId1,
                               long userId2)
                        throws PortalException,
                               SystemException
Returns the number of users with a mutual social relation with both of the given users.

Specified by:
getSocialUsersCount in interface UserLocalService
Parameters:
userId1 - the primary key of the first user
userId2 - the primary key of the second user
Returns:
the number of users with a mutual social relation with the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

getSocialUsersCount

public int getSocialUsersCount(long userId1,
                               long userId2,
                               int type)
                        throws PortalException,
                               SystemException
Returns the number of users with a mutual social relation of the type with both of the given users.

Specified by:
getSocialUsersCount in interface UserLocalService
Parameters:
userId1 - the primary key of the first user
userId2 - the primary key of the second user
type - the type of social relation. The possible types can be found in SocialRelationConstants.
Returns:
the number of users with a mutual social relation of the type with the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

getUserByContactId

public User getUserByContactId(long contactId)
                        throws PortalException,
                               SystemException
Returns the user with the contact ID.

Specified by:
getUserByContactId in interface UserLocalService
Parameters:
contactId - the user's contact ID
Returns:
the user with the contact ID
Throws:
PortalException - if a user with the contact ID could not be found
SystemException - if a system exception occurred

getUserByEmailAddress

public User getUserByEmailAddress(long companyId,
                                  String emailAddress)
                           throws PortalException,
                                  SystemException
Returns the user with the email address.

Specified by:
getUserByEmailAddress in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
emailAddress - the user's email address
Returns:
the user with the email address
Throws:
PortalException - if a user with the email address could not be found
SystemException - if a system exception occurred

getUserByFacebookId

public User getUserByFacebookId(long companyId,
                                long facebookId)
                         throws PortalException,
                                SystemException
Returns the user with the Facebook ID.

Specified by:
getUserByFacebookId in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
facebookId - the user's Facebook ID
Returns:
the user with the Facebook ID
Throws:
PortalException - if a user with the Facebook ID could not be found
SystemException - if a system exception occurred

getUserById

public User getUserById(long userId)
                 throws PortalException,
                        SystemException
Returns the user with the primary key.

Specified by:
getUserById in interface UserLocalService
Parameters:
userId - the primary key of the user
Returns:
the user with the primary key
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

getUserById

public User getUserById(long companyId,
                        long userId)
                 throws PortalException,
                        SystemException
Returns the user with the primary key from the company.

Specified by:
getUserById in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
userId - the primary key of the user
Returns:
the user with the primary key
Throws:
PortalException - if a user with the primary key from the company could not be found
SystemException - if a system exception occurred

getUserByOpenId

public User getUserByOpenId(long companyId,
                            String openId)
                     throws PortalException,
                            SystemException
Returns the user with the OpenID.

Specified by:
getUserByOpenId in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
openId - the user's OpenID
Returns:
the user with the OpenID
Throws:
PortalException - if a user with the OpenID could not be found
SystemException - if a system exception occurred

getUserByPortraitId

public User getUserByPortraitId(long portraitId)
                         throws PortalException,
                                SystemException
Returns the user with the portrait ID.

Specified by:
getUserByPortraitId in interface UserLocalService
Parameters:
portraitId - the user's portrait ID
Returns:
the user with the portrait ID
Throws:
PortalException - if a user with the portrait ID could not be found
SystemException - if a system exception occurred

getUserByScreenName

public User getUserByScreenName(long companyId,
                                String screenName)
                         throws PortalException,
                                SystemException
Returns the user with the screen name.

Specified by:
getUserByScreenName in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
screenName - the user's screen name
Returns:
the user with the screen name
Throws:
PortalException - if a user with the screen name could not be found
SystemException - if a system exception occurred

getUserByUuid

public User getUserByUuid(String uuid)
                   throws PortalException,
                          SystemException
Deprecated. As of 6.2.0, replaced by getUserByUuidAndCompanyId(String, long)

Returns the user with the UUID.

Specified by:
getUserByUuid in interface UserLocalService
Parameters:
uuid - the user's UUID
Returns:
the user with the UUID
Throws:
PortalException - if a user with the UUID could not be found
SystemException - if a system exception occurred

getUserGroupUsersCount

public int getUserGroupUsersCount(long userGroupId,
                                  int status)
                           throws PortalException,
                                  SystemException
Returns the number of users with the status belonging to the user group.

Specified by:
getUserGroupUsersCount in interface UserLocalService
Parameters:
userGroupId - the primary key of the user group
status - the workflow status
Returns:
the number of users with the status belonging to the user group
Throws:
PortalException - if a user group with the primary key could not be found
SystemException - if a system exception occurred

getUserIdByEmailAddress

public long getUserIdByEmailAddress(long companyId,
                                    String emailAddress)
                             throws PortalException,
                                    SystemException
Returns the primary key of the user with the email address.

Specified by:
getUserIdByEmailAddress in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
emailAddress - the user's email address
Returns:
the primary key of the user with the email address
Throws:
PortalException - if a user with the email address could not be found
SystemException - if a system exception occurred

getUserIdByScreenName

public long getUserIdByScreenName(long companyId,
                                  String screenName)
                           throws PortalException,
                                  SystemException
Returns the primary key of the user with the screen name.

Specified by:
getUserIdByScreenName in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
screenName - the user's screen name
Returns:
the primary key of the user with the screen name
Throws:
PortalException - if a user with the screen name could not be found
SystemException - if a system exception occurred

hasPasswordPolicyUser

public boolean hasPasswordPolicyUser(long passwordPolicyId,
                                     long userId)
                              throws SystemException
Returns true if the password policy has been assigned to the user.

Specified by:
hasPasswordPolicyUser in interface UserLocalService
Parameters:
passwordPolicyId - the primary key of the password policy
userId - the primary key of the user
Returns:
true if the password policy is assigned to the user; false otherwise
Throws:
SystemException - if a system exception occurred

hasRoleUser

public boolean hasRoleUser(long companyId,
                           String name,
                           long userId,
                           boolean inherited)
                    throws PortalException,
                           SystemException
Returns true if the user has the role with the name, optionally through inheritance.

Specified by:
hasRoleUser in interface UserLocalService
Parameters:
companyId - the primary key of the role's company
name - the name of the role (must be a regular role, not an organization, site or provider role)
userId - the primary key of the user
inherited - whether to include roles inherited from organizations, sites, etc.
Returns:
true if the user has the role; false otherwise
Throws:
PortalException - if a role with the name could not be found
SystemException - if a system exception occurred

isPasswordExpired

public boolean isPasswordExpired(User user)
                          throws PortalException,
                                 SystemException
Returns true if the user's password is expired.

Specified by:
isPasswordExpired in interface UserLocalService
Parameters:
user - the user
Returns:
true if the user's password is expired; false otherwise
Throws:
PortalException - if the password policy for the user could not be found
SystemException - if a system exception occurred

isPasswordExpiringSoon

public boolean isPasswordExpiringSoon(User user)
                               throws PortalException,
                                      SystemException
Returns true if the password policy is configured to warn the user that his password is expiring and the remaining time until expiration is equal or less than the configured warning time.

Specified by:
isPasswordExpiringSoon in interface UserLocalService
Parameters:
user - the user
Returns:
true if the user's password is expiring soon; false otherwise
Throws:
PortalException - if the password policy for the user could not be found
SystemException - if a system exception occurred

loadGetDefaultUser

public User loadGetDefaultUser(long companyId)
                        throws PortalException,
                               SystemException
Returns the default user for the company.

Specified by:
loadGetDefaultUser in interface UserLocalService
Parameters:
companyId - the primary key of the company
Returns:
the default user for the company
Throws:
PortalException - if the user could not be found
SystemException - if a system exception occurred

search

public List<User> search(long companyId,
                         String keywords,
                         int status,
                         LinkedHashMap<String,Object> params,
                         int start,
                         int end,
                         OrderByComparator obc)
                  throws SystemException
Returns an ordered range of all the users who match the keywords and status, without using the indexer. It is preferable to use the indexed version search(long, String, int, LinkedHashMap, int, int, Sort) instead of this method wherever possible for performance reasons.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Specified by:
search in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
keywords - the keywords (space separated), which may occur in the user's first name, middle name, last name, screen name, or email address
status - the workflow status
params - the finder parameters (optionally null). For more information see UserFinder.
start - the lower bound of the range of users
end - the upper bound of the range of users (not inclusive)
obc - the comparator to order the users by (optionally null)
Returns:
the matching users
Throws:
SystemException - if a system exception occurred
See Also:
UserFinder

search

public Hits search(long companyId,
                   String keywords,
                   int status,
                   LinkedHashMap<String,Object> params,
                   int start,
                   int end,
                   Sort sort)
            throws SystemException
Returns an ordered range of all the users who match the keywords and status, using the indexer. It is preferable to use this method instead of the non-indexed version whenever possible for performance reasons.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Specified by:
search in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
keywords - the keywords (space separated), which may occur in the user's first name, middle name, last name, screen name, or email address
status - the workflow status
params - the indexer parameters (optionally null). For more information see UserIndexer.
start - the lower bound of the range of users
end - the upper bound of the range of users (not inclusive)
sort - the field and direction to sort by (optionally null)
Returns:
the matching users
Throws:
SystemException - if a system exception occurred
See Also:
UserIndexer

search

public List<User> search(long companyId,
                         String firstName,
                         String middleName,
                         String lastName,
                         String screenName,
                         String emailAddress,
                         int status,
                         LinkedHashMap<String,Object> params,
                         boolean andSearch,
                         int start,
                         int end,
                         OrderByComparator obc)
                  throws SystemException
Returns an ordered range of all the users with the status, and whose first name, middle name, last name, screen name, and email address match the keywords specified for them, without using the indexer. It is preferable to use the indexed version search(long, String, String, String, String, String, int, LinkedHashMap, boolean, int, int, Sort) instead of this method wherever possible for performance reasons.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Specified by:
search in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
firstName - the first name keywords (space separated)
middleName - the middle name keywords
lastName - the last name keywords
screenName - the screen name keywords
emailAddress - the email address keywords
status - the workflow status
params - the finder parameters (optionally null). For more information see UserFinder.
andSearch - whether every field must match its keywords, or just one field. For example, "users with the first name 'bob' and last name 'smith'" vs "users with the first name 'bob' or the last name 'smith'".
start - the lower bound of the range of users
end - the upper bound of the range of users (not inclusive)
obc - the comparator to order the users by (optionally null)
Returns:
the matching users
Throws:
SystemException - if a system exception occurred
See Also:
UserFinder

search

public Hits search(long companyId,
                   String firstName,
                   String middleName,
                   String lastName,
                   String screenName,
                   String emailAddress,
                   int status,
                   LinkedHashMap<String,Object> params,
                   boolean andSearch,
                   int start,
                   int end,
                   Sort sort)
            throws SystemException
Returns an ordered range of all the users with the status, and whose first name, middle name, last name, screen name, and email address match the keywords specified for them, using the indexer. It is preferable to use this method instead of the non-indexed version whenever possible for performance reasons.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Specified by:
search in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
firstName - the first name keywords (space separated)
middleName - the middle name keywords
lastName - the last name keywords
screenName - the screen name keywords
emailAddress - the email address keywords
status - the workflow status
params - the indexer parameters (optionally null). For more information see UserIndexer.
andSearch - whether every field must match its keywords, or just one field. For example, "users with the first name 'bob' and last name 'smith'" vs "users with the first name 'bob' or the last name 'smith'".
start - the lower bound of the range of users
end - the upper bound of the range of users (not inclusive)
sort - the field and direction to sort by (optionally null)
Returns:
the matching users
Throws:
SystemException - if a system exception occurred
See Also:
UserIndexer

searchCount

public int searchCount(long companyId,
                       String keywords,
                       int status,
                       LinkedHashMap<String,Object> params)
                throws SystemException
Returns the number of users who match the keywords and status.

Specified by:
searchCount in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
keywords - the keywords (space separated), which may occur in the user's first name, middle name, last name, screen name, or email address
status - the workflow status
params - the finder parameters (optionally null). For more information see UserFinder.
Returns:
the number matching users
Throws:
SystemException - if a system exception occurred

searchCount

public int searchCount(long companyId,
                       String firstName,
                       String middleName,
                       String lastName,
                       String screenName,
                       String emailAddress,
                       int status,
                       LinkedHashMap<String,Object> params,
                       boolean andSearch)
                throws SystemException
Returns the number of users with the status, and whose first name, middle name, last name, screen name, and email address match the keywords specified for them.

Specified by:
searchCount in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
firstName - the first name keywords (space separated)
middleName - the middle name keywords
lastName - the last name keywords
screenName - the screen name keywords
emailAddress - the email address keywords
status - the workflow status
params - the finder parameters (optionally null). For more information see UserFinder.
andSearch - whether every field must match its keywords, or just one field. For example, "users with the first name 'bob' and last name 'smith'" vs "users with the first name 'bob' or the last name 'smith'".
Returns:
the number of matching users
Throws:
SystemException - if a system exception occurred

sendEmailAddressVerification

public void sendEmailAddressVerification(User user,
                                         String emailAddress,
                                         ServiceContext serviceContext)
                                  throws PortalException,
                                         SystemException
Sends an email address verification to the user.

Specified by:
sendEmailAddressVerification in interface UserLocalService
Parameters:
user - the verification email recipient
emailAddress - the recipient's email address
serviceContext - the service context to be applied. Must set the portal URL, main path, primary key of the layout, remote address, remote host, and agent for the user.
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

sendPassword

public void sendPassword(long companyId,
                         String emailAddress,
                         String fromName,
                         String fromAddress,
                         String subject,
                         String body,
                         ServiceContext serviceContext)
                  throws PortalException,
                         SystemException
Sends the password email to the user with the email address. The content of this email can be specified in portal.properties with the admin.email.password keys.

Specified by:
sendPassword in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
emailAddress - the user's email address
fromName - the name of the individual that the email should be from
fromAddress - the address of the individual that the email should be from
subject - the email subject. If null, the subject specified in portal.properties will be used.
body - the email body. If null, the body specified in portal.properties will be used.
serviceContext - the service context to be applied
Throws:
PortalException - if a user with the email address could not be found
SystemException - if a system exception occurred

unsetGroupTeamsUsers

public void unsetGroupTeamsUsers(long groupId,
                                 long[] userIds)
                          throws PortalException,
                                 SystemException
Removes the users from the teams of a group.

Specified by:
unsetGroupTeamsUsers in interface UserLocalService
Parameters:
groupId - the primary key of the group
userIds - the primary keys of the users
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

unsetGroupUsers

public void unsetGroupUsers(long groupId,
                            long[] userIds,
                            ServiceContext serviceContext)
                     throws PortalException,
                            SystemException
Removes the users from the group.

Specified by:
unsetGroupUsers in interface UserLocalService
Parameters:
groupId - the primary key of the group
userIds - the primary keys of the users
serviceContext - the service context to be applied (optionally null)
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

unsetOrganizationUsers

public void unsetOrganizationUsers(long organizationId,
                                   long[] userIds)
                            throws PortalException,
                                   SystemException
Removes the users from the organization.

Specified by:
unsetOrganizationUsers in interface UserLocalService
Parameters:
organizationId - the primary key of the organization
userIds - the primary keys of the users
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

unsetPasswordPolicyUsers

public void unsetPasswordPolicyUsers(long passwordPolicyId,
                                     long[] userIds)
                              throws SystemException
Removes the users from the password policy.

Specified by:
unsetPasswordPolicyUsers in interface UserLocalService
Parameters:
passwordPolicyId - the primary key of the password policy
userIds - the primary keys of the users
Throws:
SystemException - if a system exception occurred

unsetRoleUsers

public void unsetRoleUsers(long roleId,
                           List<User> users)
                    throws PortalException,
                           SystemException
Removes the users from the role.

Specified by:
unsetRoleUsers in interface UserLocalService
Parameters:
roleId - the primary key of the role
users - the users
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

unsetRoleUsers

public void unsetRoleUsers(long roleId,
                           long[] userIds)
                    throws PortalException,
                           SystemException
Removes the users from the role.

Specified by:
unsetRoleUsers in interface UserLocalService
Parameters:
roleId - the primary key of the role
userIds - the primary keys of the users
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

unsetTeamUsers

public void unsetTeamUsers(long teamId,
                           long[] userIds)
                    throws PortalException,
                           SystemException
Removes the users from the team.

Specified by:
unsetTeamUsers in interface UserLocalService
Parameters:
teamId - the primary key of the team
userIds - the primary keys of the users
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

unsetUserGroupUsers

public void unsetUserGroupUsers(long userGroupId,
                                long[] userIds)
                         throws PortalException,
                                SystemException
Removes the users from the user group.

Specified by:
unsetUserGroupUsers in interface UserLocalService
Parameters:
userGroupId - the primary key of the user group
userIds - the primary keys of the users
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

updateAgreedToTermsOfUse

public User updateAgreedToTermsOfUse(long userId,
                                     boolean agreedToTermsOfUse)
                              throws PortalException,
                                     SystemException
Updates whether the user has agreed to the terms of use.

Specified by:
updateAgreedToTermsOfUse in interface UserLocalService
Parameters:
userId - the primary key of the user
agreedToTermsOfUse - whether the user has agreet to the terms of use
Returns:
the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

updateAsset

public void updateAsset(long userId,
                        User user,
                        long[] assetCategoryIds,
                        String[] assetTagNames)
                 throws PortalException,
                        SystemException
Updates the user's asset with the new asset categories and tag names, removing and adding asset categories and tag names as necessary.

Specified by:
updateAsset in interface UserLocalService
Parameters:
userId - the primary key of the user
user - ID the primary key of the user
assetCategoryIds - the primary key's of the new asset categories
assetTagNames - the new asset tag names
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

updateCreateDate

public User updateCreateDate(long userId,
                             Date createDate)
                      throws PortalException,
                             SystemException
Updates the user's creation date.

Specified by:
updateCreateDate in interface UserLocalService
Parameters:
userId - the primary key of the user
createDate - the new creation date
Returns:
the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

updateEmailAddress

public User updateEmailAddress(long userId,
                               String password,
                               String emailAddress1,
                               String emailAddress2)
                        throws PortalException,
                               SystemException
Updates the user's email address.

Specified by:
updateEmailAddress in interface UserLocalService
Parameters:
userId - the primary key of the user
password - the user's password
emailAddress1 - the user's new email address
emailAddress2 - the user's new email address confirmation
Returns:
the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

updateEmailAddress

public User updateEmailAddress(long userId,
                               String password,
                               String emailAddress1,
                               String emailAddress2,
                               ServiceContext serviceContext)
                        throws PortalException,
                               SystemException
Updates the user's email address or sends verification email.

Specified by:
updateEmailAddress in interface UserLocalService
Parameters:
userId - the primary key of the user
password - the user's password
emailAddress1 - the user's new email address
emailAddress2 - the user's new email address confirmation
serviceContext - the service context to be applied. Must set the portal URL, main path, primary key of the layout, remote address, remote host, and agent for the user.
Returns:
the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

updateEmailAddressVerified

public User updateEmailAddressVerified(long userId,
                                       boolean emailAddressVerified)
                                throws PortalException,
                                       SystemException
Updates whether the user has verified email address.

Specified by:
updateEmailAddressVerified in interface UserLocalService
Parameters:
userId - the primary key of the user
emailAddressVerified - whether the user has verified email address
Returns:
the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

updateFacebookId

public User updateFacebookId(long userId,
                             long facebookId)
                      throws PortalException,
                             SystemException
Updates the user's Facebook ID.

Specified by:
updateFacebookId in interface UserLocalService
Parameters:
userId - the primary key of the user
facebookId - the user's new Facebook ID
Returns:
the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

updateGroups

public void updateGroups(long userId,
                         long[] newGroupIds,
                         ServiceContext serviceContext)
                  throws PortalException,
                         SystemException
Sets the groups the user is in, removing and adding groups as necessary.

Specified by:
updateGroups in interface UserLocalService
Parameters:
userId - the primary key of the user
newGroupIds - the primary keys of the groups
serviceContext - the service context to be applied (optionally null)
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

updateIncompleteUser

public User updateIncompleteUser(long creatorUserId,
                                 long companyId,
                                 boolean autoPassword,
                                 String password1,
                                 String password2,
                                 boolean autoScreenName,
                                 String screenName,
                                 String emailAddress,
                                 long facebookId,
                                 String openId,
                                 Locale locale,
                                 String firstName,
                                 String middleName,
                                 String lastName,
                                 int prefixId,
                                 int suffixId,
                                 boolean male,
                                 int birthdayMonth,
                                 int birthdayDay,
                                 int birthdayYear,
                                 String jobTitle,
                                 boolean updateUserInformation,
                                 boolean sendEmail,
                                 ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException
Updates a user account that was automatically created when a guest user participated in an action (e.g. posting a comment) and only provided his name and email address.

Specified by:
updateIncompleteUser in interface UserLocalService
Parameters:
creatorUserId - the primary key of the creator
companyId - the primary key of the user's company
autoPassword - whether a password should be automatically generated for the user
password1 - the user's password
password2 - the user's password confirmation
autoScreenName - whether a screen name should be automatically generated for the user
screenName - the user's screen name
emailAddress - the user's email address
facebookId - the user's facebook ID
openId - the user's OpenID
locale - the user's locale
firstName - the user's first name
middleName - the user's middle name
lastName - the user's last name
prefixId - the user's name prefix ID
suffixId - the user's name suffix ID
male - whether the user is male
birthdayMonth - the user's birthday month (0-based, meaning 0 for January)
birthdayDay - the user's birthday day
birthdayYear - the user's birthday year
jobTitle - the user's job title
updateUserInformation - whether to update the user's information
sendEmail - whether to send the user an email notification about their new account
serviceContext - the service context to be applied (optionally null). Can set expando bridge attributes for the user.
Returns:
the user
Throws:
PortalException - if the user's information was invalid
SystemException - if a system exception occurred

updateJobTitle

public User updateJobTitle(long userId,
                           String jobTitle)
                    throws PortalException,
                           SystemException
Updates the user's job title.

Specified by:
updateJobTitle in interface UserLocalService
Parameters:
userId - the primary key of the user
jobTitle - the user's job title
Returns:
the user
Throws:
PortalException - if a user with the primary key could not be found or if a contact could not be found matching the user's contact ID
SystemException - if a system exception occurred

updateLastLogin

public User updateLastLogin(long userId,
                            String loginIP)
                     throws PortalException,
                            SystemException
Updates the user's last login with the current time and the IP address.

Specified by:
updateLastLogin in interface UserLocalService
Parameters:
userId - the primary key of the user
loginIP - the IP address the user logged in from
Returns:
the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

updateLockout

public User updateLockout(User user,
                          boolean lockout)
                   throws PortalException,
                          SystemException
Updates whether the user is locked out from logging in.

Specified by:
updateLockout in interface UserLocalService
Parameters:
user - the user
lockout - whether the user is locked out
Returns:
the user
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

updateLockoutByEmailAddress

public User updateLockoutByEmailAddress(long companyId,
                                        String emailAddress,
                                        boolean lockout)
                                 throws PortalException,
                                        SystemException
Updates whether the user is locked out from logging in.

Specified by:
updateLockoutByEmailAddress in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
emailAddress - the user's email address
lockout - whether the user is locked out
Returns:
the user
Throws:
PortalException - if a user with the email address could not be found
SystemException - if a system exception occurred

updateLockoutById

public User updateLockoutById(long userId,
                              boolean lockout)
                       throws PortalException,
                              SystemException
Updates whether the user is locked out from logging in.

Specified by:
updateLockoutById in interface UserLocalService
Parameters:
userId - the primary key of the user
lockout - whether the user is locked out
Returns:
the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

updateLockoutByScreenName

public User updateLockoutByScreenName(long companyId,
                                      String screenName,
                                      boolean lockout)
                               throws PortalException,
                                      SystemException
Updates whether the user is locked out from logging in.

Specified by:
updateLockoutByScreenName in interface UserLocalService
Parameters:
companyId - the primary key of the user's company
screenName - the user's screen name
lockout - whether the user is locked out
Returns:
the user
Throws:
PortalException - if a user with the screen name could not be found
SystemException - if a system exception occurred

updateModifiedDate

public User updateModifiedDate(long userId,
                               Date modifiedDate)
                        throws PortalException,
                               SystemException
Updates the user's modified date.

Specified by:
updateModifiedDate in interface UserLocalService
Parameters:
userId - the primary key of the user
modifiedDate - the new modified date
Returns:
the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

updateOpenId

public User updateOpenId(long userId,
                         String openId)
                  throws PortalException,
                         SystemException
Updates the user's OpenID.

Specified by:
updateOpenId in interface UserLocalService
Parameters:
userId - the primary key of the user
openId - the new OpenID
Returns:
the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

updateOrganizations

public void updateOrganizations(long userId,
                                long[] newOrganizationIds,
                                ServiceContext serviceContext)
                         throws PortalException,
                                SystemException
Sets the organizations that the user is in, removing and adding organizations as necessary.

Specified by:
updateOrganizations in interface UserLocalService
Parameters:
userId - the primary key of the user
newOrganizationIds - the primary keys of the organizations
serviceContext - the service context to be applied. Must set whether user indexing is enabled.
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

updatePassword

public User updatePassword(long userId,
                           String password1,
                           String password2,
                           boolean passwordReset)
                    throws PortalException,
                           SystemException
Updates the user's password without tracking or validation of the change.

Specified by:
updatePassword in interface UserLocalService
Parameters:
userId - the primary key of the user
password1 - the user's new password
password2 - the user's new password confirmation
passwordReset - whether the user should be asked to reset their password the next time they log in
Returns:
the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

updatePassword

public User updatePassword(long userId,
                           String password1,
                           String password2,
                           boolean passwordReset,
                           boolean silentUpdate)
                    throws PortalException,
                           SystemException
Updates the user's password, optionally with tracking and validation of the change.

Specified by:
updatePassword in interface UserLocalService
Parameters:
userId - the primary key of the user
password1 - the user's new password
password2 - the user's new password confirmation
passwordReset - whether the user should be asked to reset their password the next time they login
silentUpdate - whether the password should be updated without being tracked, or validated. Primarily used for password imports.
Returns:
the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

updatePasswordManually

public User updatePasswordManually(long userId,
                                   String password,
                                   boolean passwordEncrypted,
                                   boolean passwordReset,
                                   Date passwordModifiedDate)
                            throws PortalException,
                                   SystemException
Updates the user's password with manually input information. This method should only be used when performing maintenance.

Specified by:
updatePasswordManually in interface UserLocalService
Parameters:
userId - the primary key of the user
password - the user's new password
passwordEncrypted - the user's new encrypted password
passwordReset - whether the user should be asked to reset their password the next time they login
passwordModifiedDate - the new password modified date
Returns:
the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

updatePasswordReset

public User updatePasswordReset(long userId,
                                boolean passwordReset)
                         throws PortalException,
                                SystemException
Updates whether the user should be asked to reset their password the next time they login.

Specified by:
updatePasswordReset in interface UserLocalService
Parameters:
userId - the primary key of the user
passwordReset - whether the user should be asked to reset their password the next time they login
Returns:
the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

updatePortrait

public User updatePortrait(long userId,
                           byte[] bytes)
                    throws PortalException,
                           SystemException
Updates the user's portrait image.

Specified by:
updatePortrait in interface UserLocalService
Parameters:
userId - the primary key of the user
bytes - the new portrait image data
Returns:
the user
Throws:
PortalException - if a user with the primary key could not be found or if the new portrait was invalid
SystemException - if a system exception occurred

updateReminderQuery

public User updateReminderQuery(long userId,
                                String question,
                                String answer)
                         throws PortalException,
                                SystemException
Updates the user's password reset question and answer.

Specified by:
updateReminderQuery in interface UserLocalService
Parameters:
userId - the primary key of the user
question - the user's new password reset question
answer - the user's new password reset answer
Returns:
the user
Throws:
PortalException - if a user with the primary key could not be found or if the new question or answer were invalid
SystemException - if a system exception occurred

updateScreenName

public User updateScreenName(long userId,
                             String screenName)
                      throws PortalException,
                             SystemException
Updates the user's screen name.

Specified by:
updateScreenName in interface UserLocalService
Parameters:
userId - the primary key of the user
screenName - the user's new screen name
Returns:
the user
Throws:
PortalException - if a user with the primary key could not be found or if the new screen name was invalid
SystemException - if a system exception occurred

updateStatus

public User updateStatus(long userId,
                         int status)
                  throws PortalException,
                         SystemException
Deprecated. As of 7.0.0, replaced by updateStatus(long, int, ServiceContext)

Updates the user's workflow status.

Specified by:
updateStatus in interface UserLocalService
Parameters:
userId - the primary key of the user
status - the user's new workflow status
Returns:
the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

updateStatus

public User updateStatus(long userId,
                         int status,
                         ServiceContext serviceContext)
                  throws PortalException,
                         SystemException
Updates the user's workflow status.

Specified by:
updateStatus in interface UserLocalService
Parameters:
userId - the primary key of the user
status - the user's new workflow status
serviceContext - the service context to be applied. You can specify an unencrypted custom password (used by an LDAP listener) for the user via attribute passwordUnencrypted.
Returns:
the user
Throws:
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred

updateUser

public User updateUser(long userId,
                       String oldPassword,
                       String newPassword1,
                       String newPassword2,
                       boolean passwordReset,
                       String reminderQueryQuestion,
                       String reminderQueryAnswer,
                       String screenName,
                       String emailAddress,
                       long facebookId,
                       String openId,
                       String languageId,
                       String timeZoneId,
                       String greeting,
                       String comments,
                       String firstName,
                       String middleName,
                       String lastName,
                       int prefixId,
                       int suffixId,
                       boolean male,
                       int birthdayMonth,
                       int birthdayDay,
                       int birthdayYear,
                       String smsSn,
                       String aimSn,
                       String facebookSn,
                       String icqSn,
                       String jabberSn,
                       String msnSn,
                       String mySpaceSn,
                       String skypeSn,
                       String twitterSn,
                       String ymSn,
                       String jobTitle,
                       long[] groupIds,
                       long[] organizationIds,
                       long[] roleIds,
                       List<UserGroupRole> userGroupRoles,
                       long[] userGroupIds,
                       ServiceContext serviceContext)
                throws PortalException,
                       SystemException
Updates the user.

Specified by:
updateUser in interface UserLocalService
Parameters:
userId - the primary key of the user
oldPassword - the user's old password
newPassword1 - the user's new password (optionally null)
newPassword2 - the user's new password confirmation (optionally null)
passwordReset - whether the user should be asked to reset their password the next time they login
reminderQueryQuestion - the user's new password reset question
reminderQueryAnswer - the user's new password reset answer
screenName - the user's new screen name
emailAddress - the user's new email address
facebookId - the user's new Facebook ID
openId - the user's new OpenID
languageId - the user's new language ID
timeZoneId - the user's new time zone ID
greeting - the user's new greeting
comments - the user's new comments
firstName - the user's new first name
middleName - the user's new middle name
lastName - the user's new last name
prefixId - the user's new name prefix ID
suffixId - the user's new name suffix ID
male - whether user is male
birthdayMonth - the user's new birthday month (0-based, meaning 0 for January)
birthdayDay - the user's new birthday day
birthdayYear - the user's birthday year
smsSn - the user's new SMS screen name
aimSn - the user's new AIM screen name
facebookSn - the user's new Facebook screen name
icqSn - the user's new ICQ screen name
jabberSn - the user's new Jabber screen name
msnSn - the user's new MSN screen name
mySpaceSn - the user's new MySpace screen name
skypeSn - the user's new Skype screen name
twitterSn - the user's new Twitter screen name
ymSn - the user's new Yahoo! Messenger screen name
jobTitle - the user's new job title
groupIds - the primary keys of the user's groups
organizationIds - the primary keys of the user's organizations
roleIds - the primary keys of the user's roles
userGroupRoles - the user user's group roles
userGroupIds - the primary keys of the user's user groups
serviceContext - the service context to be applied (optionally null). Can set the UUID (with the uuid attribute), asset category IDs, asset tag names, and expando bridge attributes for the user.
Returns:
the user
Throws:
PortalException - if a user with the primary key could not be found or if the new information was invalid
SystemException - if a system exception occurred

verifyEmailAddress

public void verifyEmailAddress(String ticketKey)
                        throws PortalException,
                               SystemException
Verifies the email address of the ticket.

Specified by:
verifyEmailAddress in interface UserLocalService
Parameters:
ticketKey - the ticket key
Throws:
PortalException - if a ticket matching the ticket key could not be found, if the ticket has expired, if the ticket is an email address ticket, or if the email address is invalid
SystemException - if a system exception occurred

getWrappedUserLocalService

public UserLocalService getWrappedUserLocalService()
Deprecated. As of 6.1.0, replaced by getWrappedService()


setWrappedUserLocalService

public void setWrappedUserLocalService(UserLocalService userLocalService)
Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portal.service.UserLocalService)


getWrappedService

public UserLocalService getWrappedService()
Specified by:
getWrappedService in interface ServiceWrapper<UserLocalService>

setWrappedService

public void setWrappedService(UserLocalService userLocalService)
Specified by:
setWrappedService in interface ServiceWrapper<UserLocalService>

Liferay 6.2-ce-ga5