UserLocalServiceUtil (Liferay 6.1.2-ce-ga3 Internal API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Liferay 6.1.2-ce-ga3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.liferay.portal.service
Class UserLocalServiceUtil

java.lang.Object
  com.liferay.portal.service.UserLocalServiceUtil

public class UserLocalServiceUtil
extends Object
extends Object

The utility for the user local service. This utility wraps UserLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

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

Constructor Summary
`UserLocalServiceUtil()`

Method Summary
`static User`	`addDefaultAdminUser(long companyId, String screenName, String emailAddress, Locale locale, String firstName, String middleName, String lastName)`
`static void`	`addDefaultGroups(long userId)` Adds the user to the default groups, unless the user is already in these groups.
`static void`	`addDefaultRoles(long userId)` Adds the user to the default roles, unless the user already has these roles.
`static void`	`addDefaultUserGroups(long userId)` Adds the user to the default user groups, unless the user is already in these user groups.
`static void`	`addGroupUser(long groupId, long userId)`
`static void`	`addGroupUser(long groupId, User user)`
`static void`	`addGroupUsers(long groupId, List<User> Users)`
`static void`	`addGroupUsers(long groupId, long[] userIds)`
`static void`	`addOrganizationUser(long organizationId, long userId)`
`static void`	`addOrganizationUser(long organizationId, User user)`
`static void`	`addOrganizationUsers(long organizationId, List<User> Users)`
`static void`	`addOrganizationUsers(long organizationId, long[] userIds)`
`static void`	`addPasswordPolicyUsers(long passwordPolicyId, long[] userIds)` Assigns the password policy to the users, removing any other currently assigned password policies.
`static void`	`addPermissionUser(long permissionId, long userId)`
`static void`	`addPermissionUser(long permissionId, User user)`
`static void`	`addPermissionUsers(long permissionId, List<User> Users)`
`static void`	`addPermissionUsers(long permissionId, long[] userIds)`
`static void`	`addRoleUser(long roleId, long userId)`
`static void`	`addRoleUser(long roleId, User user)`
`static void`	`addRoleUsers(long roleId, List<User> Users)`
`static void`	`addRoleUsers(long roleId, long[] userIds)`
`static void`	`addTeamUser(long teamId, long userId)`
`static void`	`addTeamUser(long teamId, User user)`
`static void`	`addTeamUsers(long teamId, List<User> Users)`
`static void`	`addTeamUsers(long teamId, long[] userIds)`
`static 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.
`static User`	`addUser(User user)` Adds the user to the database.
`static void`	`addUserGroupUser(long userGroupId, long userId)`
`static void`	`addUserGroupUser(long userGroupId, User user)`
`static void`	`addUserGroupUsers(long userGroupId, List<User> Users)`
`static void`	`addUserGroupUsers(long userGroupId, long[] userIds)`
`static 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.
`static 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.
`static 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.
`static 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.
`static long`	`authenticateForBasic(long companyId, String authType, String login, String password)` Attempts to authenticate the user using HTTP basic access authentication, without using the AuthPipeline.
`static 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.
`static boolean`	`authenticateForJAAS(long userId, String encPassword)` Attempts to authenticate the user using JAAS credentials, without using the AuthPipeline.
`static 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.
`static void`	`checkLoginFailure(User user)` Adds a failed login attempt to the user and updates the user's last failed login date.
`static 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.
`static void`	`checkLoginFailureById(long userId)` Adds a failed login attempt to the user and updates the user's last failed login date.
`static 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.
`static 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.
`static void`	`clearGroupUsers(long groupId)`
`static void`	`clearOrganizationUsers(long organizationId)`
`static void`	`clearPermissionUsers(long permissionId)`
`static void`	`clearRoleUsers(long roleId)`
`static void`	`clearTeamUsers(long teamId)`
`static void`	`clearUserGroupUsers(long userGroupId)`
`static void`	`completeUserRegistration(User user, ServiceContext serviceContext)` Completes the user's registration by generating a password and sending the confirmation email.
`static User`	`createUser(long userId)` Creates a new user with the primary key.
`static KeyValuePair`	`decryptUserId(long companyId, String name, String password)` Decrypts the user's primary key and password from their encrypted forms.
`static void`	`deleteGroupUser(long groupId, long userId)`
`static void`	`deleteGroupUser(long groupId, User user)`
`static void`	`deleteGroupUsers(long groupId, List<User> Users)`
`static void`	`deleteGroupUsers(long groupId, long[] userIds)`
`static void`	`deleteOrganizationUser(long organizationId, long userId)`
`static void`	`deleteOrganizationUser(long organizationId, User user)`
`static void`	`deleteOrganizationUsers(long organizationId, List<User> Users)`
`static void`	`deleteOrganizationUsers(long organizationId, long[] userIds)`
`static void`	`deletePermissionUser(long permissionId, long userId)`
`static void`	`deletePermissionUser(long permissionId, User user)`
`static void`	`deletePermissionUsers(long permissionId, List<User> Users)`
`static void`	`deletePermissionUsers(long permissionId, long[] userIds)`
`static void`	`deletePortrait(long userId)` Deletes the user's portrait image.
`static void`	`deleteRoleUser(long roleId, long userId)`
`static void`	`deleteRoleUser(long roleId, User user)`
`static void`	`deleteRoleUsers(long roleId, List<User> Users)`
`static void`	`deleteRoleUsers(long roleId, long[] userIds)`
`static void`	`deleteTeamUser(long teamId, long userId)`
`static void`	`deleteTeamUser(long teamId, User user)`
`static void`	`deleteTeamUsers(long teamId, List<User> Users)`
`static void`	`deleteTeamUsers(long teamId, long[] userIds)`
`static User`	`deleteUser(long userId)` Deletes the user with the primary key from the database.
`static User`	`deleteUser(User user)` Deletes the user from the database.
`static void`	`deleteUserGroupUser(long userGroupId, long userId)`
`static void`	`deleteUserGroupUser(long userGroupId, User user)`
`static void`	`deleteUserGroupUsers(long userGroupId, List<User> Users)`
`static void`	`deleteUserGroupUsers(long userGroupId, long[] userIds)`
`static DynamicQuery`	`dynamicQuery()`
`static List`	`dynamicQuery(DynamicQuery dynamicQuery)` Performs a dynamic query on the database and returns the matching rows.
`static List`	`dynamicQuery(DynamicQuery dynamicQuery, int start, int end)` Performs a dynamic query on the database and returns a range of the matching rows.
`static 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.
`static long`	`dynamicQueryCount(DynamicQuery dynamicQuery)` Returns the number of rows that match the dynamic query.
`static String`	`encryptUserId(String name)` Encrypts the primary key of the user.
`static User`	`fetchUser(long userId)`
`static User`	`fetchUserByEmailAddress(long companyId, String emailAddress)` Returns the user with the email address.
`static User`	`fetchUserById(long userId)` Returns the user with the primary key.
`static User`	`fetchUserByScreenName(long companyId, String screenName)` Returns the user with the screen name.
`static String`	`getBeanIdentifier()` Returns the Spring bean ID for this bean.
`static List<User>`	`getCompanyUsers(long companyId, int start, int end)` Returns a range of all the users belonging to the company.
`static int`	`getCompanyUsersCount(long companyId)` Returns the number of users belonging to the company.
`static User`	`getDefaultUser(long companyId)` Returns the default user for the company.
`static long`	`getDefaultUserId(long companyId)` Returns the primary key of the default user for the company.
`static long[]`	`getGroupUserIds(long groupId)` Returns the primary keys of all the users belonging to the group.
`static List<User>`	`getGroupUsers(long groupId)`
`static List<User>`	`getGroupUsers(long groupId, int start, int end)`
`static List<User>`	`getGroupUsers(long groupId, int start, int end, OrderByComparator orderByComparator)`
`static int`	`getGroupUsersCount(long groupId)`
`static int`	`getGroupUsersCount(long groupId, int status)` Returns the number of users with the status belonging to the group.
`static List<User>`	`getNoAnnouncementsDeliveries(String type)` Returns all the users who have not had any announcements of the type delivered, excluding the default user.
`static List<User>`	`getNoContacts()` Returns all the users who do not have any contacts.
`static List<User>`	`getNoGroups()` Returns all the users who do not belong to any groups, excluding the default user.
`static long[]`	`getOrganizationUserIds(long organizationId)` Returns the primary keys of all the users belonging to the organization.
`static List<User>`	`getOrganizationUsers(long organizationId)`
`static List<User>`	`getOrganizationUsers(long organizationId, int start, int end)`
`static List<User>`	`getOrganizationUsers(long organizationId, int start, int end, OrderByComparator orderByComparator)`
`static int`	`getOrganizationUsersCount(long organizationId)`
`static int`	`getOrganizationUsersCount(long organizationId, int status)` Returns the number of users with the status belonging to the organization.
`static List<User>`	`getPermissionUsers(long permissionId)`
`static List<User>`	`getPermissionUsers(long permissionId, int start, int end)`
`static List<User>`	`getPermissionUsers(long permissionId, int start, int end, OrderByComparator orderByComparator)`
`static int`	`getPermissionUsersCount(long permissionId)`
`static PersistedModel`	`getPersistedModel(Serializable primaryKeyObj)`
`static long[]`	`getRoleUserIds(long roleId)` Returns the primary keys of all the users belonging to the role.
`static List<User>`	`getRoleUsers(long roleId)`
`static List<User>`	`getRoleUsers(long roleId, int start, int end)`
`static List<User>`	`getRoleUsers(long roleId, int start, int end, OrderByComparator orderByComparator)`
`static int`	`getRoleUsersCount(long roleId)`
`static int`	`getRoleUsersCount(long roleId, int status)` Returns the number of users with the status belonging to the role.
`static UserLocalService`	`getService()`
`static 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.
`static 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.
`static 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.
`static 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.
`static int`	`getSocialUsersCount(long userId)` Returns the number of users with a social relation with the user.
`static int`	`getSocialUsersCount(long userId, int type)` Returns the number of users with a social relation of the type with the user.
`static int`	`getSocialUsersCount(long userId1, long userId2)` Returns the number of users with a mutual social relation with both of the given users.
`static 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.
`static List<User>`	`getTeamUsers(long teamId)`
`static List<User>`	`getTeamUsers(long teamId, int start, int end)`
`static List<User>`	`getTeamUsers(long teamId, int start, int end, OrderByComparator orderByComparator)`
`static int`	`getTeamUsersCount(long teamId)`
`static User`	`getUser(long userId)` Returns the user with the primary key.
`static User`	`getUserByContactId(long contactId)` Returns the user with the contact ID.
`static User`	`getUserByEmailAddress(long companyId, String emailAddress)` Returns the user with the email address.
`static User`	`getUserByFacebookId(long companyId, long facebookId)` Returns the user with the Facebook ID.
`static User`	`getUserById(long userId)` Returns the user with the primary key.
`static User`	`getUserById(long companyId, long userId)` Returns the user with the primary key from the company.
`static User`	`getUserByOpenId(long companyId, String openId)` Returns the user with the OpenID.
`static User`	`getUserByPortraitId(long portraitId)` Returns the user with the portrait ID.
`static User`	`getUserByScreenName(long companyId, String screenName)` Returns the user with the screen name.
`static User`	`getUserByUuid(String uuid)` Returns the user with the universally unique identifier.
`static List<User>`	`getUserGroupUsers(long userGroupId)`
`static List<User>`	`getUserGroupUsers(long userGroupId, int start, int end)`
`static List<User>`	`getUserGroupUsers(long userGroupId, int start, int end, OrderByComparator orderByComparator)`
`static int`	`getUserGroupUsersCount(long userGroupId)`
`static int`	`getUserGroupUsersCount(long userGroupId, int status)` Returns the number of users with the status belonging to the user group.
`static long`	`getUserIdByEmailAddress(long companyId, String emailAddress)` Returns the primary key of the user with the email address.
`static long`	`getUserIdByScreenName(long companyId, String screenName)` Returns the primary key of the user with the screen name.
`static List<User>`	`getUsers(int start, int end)` Returns a range of all the users.
`static int`	`getUsersCount()` Returns the number of users.
`static boolean`	`hasGroupUser(long groupId, long userId)`
`static boolean`	`hasGroupUsers(long groupId)`
`static boolean`	`hasOrganizationUser(long organizationId, long userId)`
`static boolean`	`hasOrganizationUsers(long organizationId)`
`static boolean`	`hasPasswordPolicyUser(long passwordPolicyId, long userId)` Returns `true` if the password policy has been assigned to the user.
`static boolean`	`hasPermissionUser(long permissionId, long userId)`
`static boolean`	`hasPermissionUsers(long permissionId)`
`static boolean`	`hasRoleUser(long roleId, long userId)`
`static boolean`	`hasRoleUser(long companyId, String name, long userId, boolean inherited)` Returns `true` if the user has the role with the name, optionally through inheritance.
`static boolean`	`hasRoleUsers(long roleId)`
`static boolean`	`hasTeamUser(long teamId, long userId)`
`static boolean`	`hasTeamUsers(long teamId)`
`static boolean`	`hasUserGroupUser(long userGroupId, long userId)`
`static boolean`	`hasUserGroupUsers(long userGroupId)`
`static boolean`	`isPasswordExpired(User user)` Returns `true` if the user's password is expired.
`static boolean`	`isPasswordExpiringSoon(User user)` Returns `true` if the user's password is expiring soon.
`static User`	`loadGetDefaultUser(long companyId)`
`static 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.
`static 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.
`static 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.
`static 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.
`static int`	`searchCount(long companyId, String keywords, int status, LinkedHashMap<String,Object> params)` Returns the number of users who match the keywords and status.
`static 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.
`static void`	`sendEmailAddressVerification(User user, String emailAddress, ServiceContext serviceContext)` Sends an email address verification to the user.
`static 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.
`static void`	`setBeanIdentifier(String beanIdentifier)` Sets the Spring bean ID for this bean.
`static void`	`setGroupUsers(long groupId, long[] userIds)`
`static void`	`setOrganizationUsers(long organizationId, long[] userIds)`
`static void`	`setPermissionUsers(long permissionId, long[] userIds)`
`static void`	`setRoleUsers(long roleId, long[] userIds)`
`void`	`setService(UserLocalService service)` Deprecated.
`static void`	`setTeamUsers(long teamId, long[] userIds)`
`static void`	`setUserGroupUsers(long userGroupId, long[] userIds)`
`static void`	`unsetGroupTeamsUsers(long groupId, long[] userIds)` Removes the users from the teams of a group.
`static void`	`unsetGroupUsers(long groupId, long[] userIds, ServiceContext serviceContext)` Removes the users from the group.
`static void`	`unsetOrganizationUsers(long organizationId, long[] userIds)` Removes the users from the organization.
`static void`	`unsetPasswordPolicyUsers(long passwordPolicyId, long[] userIds)` Removes the users from the password policy.
`static void`	`unsetRoleUsers(long roleId, List<User> users)` Removes the users from the role.
`static void`	`unsetRoleUsers(long roleId, long[] userIds)` Removes the users from the role.
`static void`	`unsetTeamUsers(long teamId, long[] userIds)` Removes the users from the team.
`static void`	`unsetUserGroupUsers(long userGroupId, long[] userIds)` Removes the users from the user group.
`static User`	`updateAgreedToTermsOfUse(long userId, boolean agreedToTermsOfUse)` Updates whether the user has agreed to the terms of use.
`static 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.
`static User`	`updateCreateDate(long userId, Date createDate)` Updates the user's creation date.
`static User`	`updateEmailAddress(long userId, String password, String emailAddress1, String emailAddress2)` Updates the user's email address.
`static User`	`updateEmailAddress(long userId, String password, String emailAddress1, String emailAddress2, ServiceContext serviceContext)` Updates the user's email address or sends verification email.
`static User`	`updateEmailAddressVerified(long userId, boolean emailAddressVerified)` Updates whether the user has verified email address.
`static User`	`updateFacebookId(long userId, long facebookId)` Updates the user's Facebook ID.
`static void`	`updateGroups(long userId, long[] newGroupIds, ServiceContext serviceContext)` Sets the groups the user is in, removing and adding groups as necessary.
`static 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.
`static User`	`updateJobTitle(long userId, String jobTitle)` Updates the user's job title.
`static User`	`updateLastLogin(long userId, String loginIP)` Updates the user's last login with the current time and the IP address.
`static User`	`updateLockout(User user, boolean lockout)` Updates whether the user is locked out from logging in.
`static User`	`updateLockoutByEmailAddress(long companyId, String emailAddress, boolean lockout)` Updates whether the user is locked out from logging in.
`static User`	`updateLockoutById(long userId, boolean lockout)` Updates whether the user is locked out from logging in.
`static User`	`updateLockoutByScreenName(long companyId, String screenName, boolean lockout)` Updates whether the user is locked out from logging in.
`static User`	`updateModifiedDate(long userId, Date modifiedDate)` Updates the user's modified date.
`static User`	`updateOpenId(long userId, String openId)` Updates the user's OpenID.
`static void`	`updateOrganizations(long userId, long[] newOrganizationIds, ServiceContext serviceContext)` Sets the organizations that the user is in, removing and adding organizations as necessary.
`static User`	`updatePassword(long userId, String password1, String password2, boolean passwordReset)` Updates the user's password without tracking or validation of the change.
`static 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.
`static User`	`updatePasswordManually(long userId, String password, boolean passwordEncrypted, boolean passwordReset, Date passwordModifiedDate)` Updates the user's password with manually input information.
`static User`	`updatePasswordReset(long userId, boolean passwordReset)` Updates whether the user should be asked to reset their password the next time they login.
`static User`	`updatePortrait(long userId, byte[] bytes)` Updates the user's portrait image.
`static User`	`updateReminderQuery(long userId, String question, String answer)` Updates the user's password reset question and answer.
`static User`	`updateScreenName(long userId, String screenName)` Updates the user's screen name.
`static User`	`updateStatus(long userId, int status)` Updates the user's workflow status.
`static 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.
`static User`	`updateUser(User user)` Updates the user in the database or adds it if it does not yet exist.
`static User`	`updateUser(User user, boolean merge)` Updates the user in the database or adds it if it does not yet exist.
`static 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

UserLocalServiceUtil

public UserLocalServiceUtil()

Method Detail

addUser

public static User addUser(User user)
                    throws SystemException

Adds the user to the database. Also notifies the appropriate model listeners.

Parameters:: user - the user
Returns:: the user that was added
Throws:: SystemException - if a system exception occurred

createUser

public static User createUser(long userId)

Creates a new user with the primary key. Does not add the user to the database.

Parameters:: userId - the primary key for the new user
Returns:: the new user

deleteUser

public static User deleteUser(long userId)
                       throws PortalException,
                              SystemException

Deletes the user with the primary key from the database. Also notifies the appropriate model listeners.

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 static User deleteUser(User user)
                       throws PortalException,
                              SystemException

Deletes the user from the database. Also notifies the appropriate model listeners.

Parameters:: user - the user
Returns:: the user that was removed
Throws:: PortalException; SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:: dynamicQuery - the dynamic query
Returns:: the matching rows
Throws:: SystemException - if a system exception occurred

dynamicQuery

public static 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.

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 static 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.

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 static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:: dynamicQuery - the dynamic query
Returns:: the number of rows that match the dynamic query
Throws:: SystemException - if a system exception occurred

fetchUser

public static User fetchUser(long userId)
                      throws SystemException

Throws:: SystemException

getUser

public static User getUser(long userId)
                    throws PortalException,
                           SystemException

Returns the user with the primary key.

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 static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:: PortalException; SystemException

getUsers

public static List<User> getUsers(int start,
                                  int end)
                           throws SystemException

Returns a range of all the users.

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 static int getUsersCount()
                         throws SystemException

Returns the number of users.

Returns:: the number of users
Throws:: SystemException - if a system exception occurred

updateUser

public static 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.

Parameters:: user - the user
Returns:: the user that was updated
Throws:: SystemException - if a system exception occurred

updateUser

public static User updateUser(User user,
                              boolean merge)
                       throws SystemException

Updates the user in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:: user - the user; merge - whether to merge the user with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:: the user that was updated
Throws:: SystemException - if a system exception occurred

addGroupUser

public static void addGroupUser(long groupId,
                                long userId)
                         throws SystemException

Throws:: SystemException - if a system exception occurred

addGroupUser

public static void addGroupUser(long groupId,
                                User user)
                         throws SystemException

Throws:: SystemException - if a system exception occurred

addGroupUsers

public static void addGroupUsers(long groupId,
                                 long[] userIds)
                          throws PortalException,
                                 SystemException

Throws:: PortalException; SystemException - if a system exception occurred

addGroupUsers

public static void addGroupUsers(long groupId,
                                 List<User> Users)
                          throws PortalException,
                                 SystemException

Throws:: PortalException; SystemException - if a system exception occurred

clearGroupUsers

public static void clearGroupUsers(long groupId)
                            throws SystemException

Throws:: SystemException - if a system exception occurred

deleteGroupUser

public static void deleteGroupUser(long groupId,
                                   long userId)
                            throws SystemException

Throws:: SystemException - if a system exception occurred

deleteGroupUser

public static void deleteGroupUser(long groupId,
                                   User user)
                            throws SystemException

Throws:: SystemException - if a system exception occurred

deleteGroupUsers

public static void deleteGroupUsers(long groupId,
                                    long[] userIds)
                             throws SystemException

Throws:: SystemException - if a system exception occurred

deleteGroupUsers

public static void deleteGroupUsers(long groupId,
                                    List<User> Users)
                             throws SystemException

Throws:: SystemException - if a system exception occurred

getGroupUsers

public static List<User> getGroupUsers(long groupId)
                                throws SystemException

Throws:: SystemException - if a system exception occurred

getGroupUsers

public static List<User> getGroupUsers(long groupId,
                                       int start,
                                       int end)
                                throws SystemException

Throws:: SystemException - if a system exception occurred

getGroupUsers

public static List<User> getGroupUsers(long groupId,
                                       int start,
                                       int end,
                                       OrderByComparator orderByComparator)
                                throws SystemException

Throws:: SystemException - if a system exception occurred

getGroupUsersCount

public static int getGroupUsersCount(long groupId)
                              throws SystemException

Throws:: SystemException - if a system exception occurred

hasGroupUser

public static boolean hasGroupUser(long groupId,
                                   long userId)
                            throws SystemException

Throws:: SystemException - if a system exception occurred

hasGroupUsers

public static boolean hasGroupUsers(long groupId)
                             throws SystemException

Throws:: SystemException - if a system exception occurred

setGroupUsers

public static void setGroupUsers(long groupId,
                                 long[] userIds)
                          throws SystemException

Throws:: SystemException - if a system exception occurred

addOrganizationUser

public static void addOrganizationUser(long organizationId,
                                       long userId)
                                throws SystemException

Throws:: SystemException - if a system exception occurred

addOrganizationUser

public static void addOrganizationUser(long organizationId,
                                       User user)
                                throws SystemException

Throws:: SystemException - if a system exception occurred

addOrganizationUsers

public static void addOrganizationUsers(long organizationId,
                                        long[] userIds)
                                 throws PortalException,
                                        SystemException

Throws:: PortalException; SystemException - if a system exception occurred

addOrganizationUsers

public static void addOrganizationUsers(long organizationId,
                                        List<User> Users)
                                 throws PortalException,
                                        SystemException

Throws:: PortalException; SystemException - if a system exception occurred

clearOrganizationUsers

public static void clearOrganizationUsers(long organizationId)
                                   throws SystemException

Throws:: SystemException - if a system exception occurred

deleteOrganizationUser

public static void deleteOrganizationUser(long organizationId,
                                          long userId)
                                   throws SystemException

Throws:: SystemException - if a system exception occurred

deleteOrganizationUser

public static void deleteOrganizationUser(long organizationId,
                                          User user)
                                   throws SystemException

Throws:: SystemException - if a system exception occurred

deleteOrganizationUsers

public static void deleteOrganizationUsers(long organizationId,
                                           long[] userIds)
                                    throws SystemException

Throws:: SystemException - if a system exception occurred

deleteOrganizationUsers

public static void deleteOrganizationUsers(long organizationId,
                                           List<User> Users)
                                    throws SystemException

Throws:: SystemException - if a system exception occurred

getOrganizationUsers

public static List<User> getOrganizationUsers(long organizationId)
                                       throws SystemException

Throws:: SystemException - if a system exception occurred

getOrganizationUsers

public static List<User> getOrganizationUsers(long organizationId,
                                              int start,
                                              int end)
                                       throws SystemException

Throws:: SystemException - if a system exception occurred

getOrganizationUsers

public static List<User> getOrganizationUsers(long organizationId,
                                              int start,
                                              int end,
                                              OrderByComparator orderByComparator)
                                       throws SystemException

Throws:: SystemException - if a system exception occurred

getOrganizationUsersCount

public static int getOrganizationUsersCount(long organizationId)
                                     throws SystemException

Throws:: SystemException - if a system exception occurred

hasOrganizationUser

public static boolean hasOrganizationUser(long organizationId,
                                          long userId)
                                   throws SystemException

Throws:: SystemException - if a system exception occurred

hasOrganizationUsers

public static boolean hasOrganizationUsers(long organizationId)
                                    throws SystemException

Throws:: SystemException - if a system exception occurred

setOrganizationUsers

public static void setOrganizationUsers(long organizationId,
                                        long[] userIds)
                                 throws SystemException

Throws:: SystemException - if a system exception occurred

addPermissionUser

public static void addPermissionUser(long permissionId,
                                     long userId)
                              throws SystemException

Throws:: SystemException - if a system exception occurred

addPermissionUser

public static void addPermissionUser(long permissionId,
                                     User user)
                              throws SystemException

Throws:: SystemException - if a system exception occurred

addPermissionUsers

public static void addPermissionUsers(long permissionId,
                                      long[] userIds)
                               throws SystemException

Throws:: SystemException - if a system exception occurred

addPermissionUsers

public static void addPermissionUsers(long permissionId,
                                      List<User> Users)
                               throws SystemException

Throws:: SystemException - if a system exception occurred

clearPermissionUsers

public static void clearPermissionUsers(long permissionId)
                                 throws SystemException

Throws:: SystemException - if a system exception occurred

deletePermissionUser

public static void deletePermissionUser(long permissionId,
                                        long userId)
                                 throws SystemException

Throws:: SystemException - if a system exception occurred

deletePermissionUser

public static void deletePermissionUser(long permissionId,
                                        User user)
                                 throws SystemException

Throws:: SystemException - if a system exception occurred

deletePermissionUsers

public static void deletePermissionUsers(long permissionId,
                                         long[] userIds)
                                  throws SystemException

Throws:: SystemException - if a system exception occurred

deletePermissionUsers

public static void deletePermissionUsers(long permissionId,
                                         List<User> Users)
                                  throws SystemException

Throws:: SystemException - if a system exception occurred

getPermissionUsers

public static List<User> getPermissionUsers(long permissionId)
                                     throws SystemException

Throws:: SystemException - if a system exception occurred

getPermissionUsers

public static List<User> getPermissionUsers(long permissionId,
                                            int start,
                                            int end)
                                     throws SystemException

Throws:: SystemException - if a system exception occurred

getPermissionUsers

public static List<User> getPermissionUsers(long permissionId,
                                            int start,
                                            int end,
                                            OrderByComparator orderByComparator)
                                     throws SystemException

Throws:: SystemException - if a system exception occurred

getPermissionUsersCount

public static int getPermissionUsersCount(long permissionId)
                                   throws SystemException

Throws:: SystemException - if a system exception occurred

hasPermissionUser

public static boolean hasPermissionUser(long permissionId,
                                        long userId)
                                 throws SystemException

Throws:: SystemException - if a system exception occurred

hasPermissionUsers

public static boolean hasPermissionUsers(long permissionId)
                                  throws SystemException

Throws:: SystemException - if a system exception occurred

setPermissionUsers

public static void setPermissionUsers(long permissionId,
                                      long[] userIds)
                               throws SystemException

Throws:: SystemException - if a system exception occurred

addRoleUser

public static void addRoleUser(long roleId,
                               long userId)
                        throws SystemException

Throws:: SystemException - if a system exception occurred

addRoleUser

public static void addRoleUser(long roleId,
                               User user)
                        throws SystemException

Throws:: SystemException - if a system exception occurred

addRoleUsers

public static void addRoleUsers(long roleId,
                                long[] userIds)
                         throws PortalException,
                                SystemException

Throws:: PortalException; SystemException - if a system exception occurred

addRoleUsers

public static void addRoleUsers(long roleId,
                                List<User> Users)
                         throws PortalException,
                                SystemException

Throws:: PortalException; SystemException - if a system exception occurred

clearRoleUsers

public static void clearRoleUsers(long roleId)
                           throws SystemException

Throws:: SystemException - if a system exception occurred

deleteRoleUser

public static void deleteRoleUser(long roleId,
                                  long userId)
                           throws PortalException,
                                  SystemException

Throws:: PortalException; SystemException - if a system exception occurred

deleteRoleUser

public static void deleteRoleUser(long roleId,
                                  User user)
                           throws PortalException,
                                  SystemException

Throws:: PortalException; SystemException - if a system exception occurred

deleteRoleUsers

public static void deleteRoleUsers(long roleId,
                                   long[] userIds)
                            throws SystemException

Throws:: SystemException - if a system exception occurred

deleteRoleUsers

public static void deleteRoleUsers(long roleId,
                                   List<User> Users)
                            throws SystemException

Throws:: SystemException - if a system exception occurred

getRoleUsers

public static List<User> getRoleUsers(long roleId)
                               throws SystemException

Throws:: SystemException - if a system exception occurred

getRoleUsers

public static List<User> getRoleUsers(long roleId,
                                      int start,
                                      int end)
                               throws SystemException

Throws:: SystemException - if a system exception occurred

getRoleUsers

public static List<User> getRoleUsers(long roleId,
                                      int start,
                                      int end,
                                      OrderByComparator orderByComparator)
                               throws SystemException

Throws:: SystemException - if a system exception occurred

getRoleUsersCount

public static int getRoleUsersCount(long roleId)
                             throws SystemException

Throws:: SystemException - if a system exception occurred

hasRoleUser

public static boolean hasRoleUser(long roleId,
                                  long userId)
                           throws SystemException

Throws:: SystemException - if a system exception occurred

hasRoleUsers

public static boolean hasRoleUsers(long roleId)
                            throws SystemException

Throws:: SystemException - if a system exception occurred

setRoleUsers

public static void setRoleUsers(long roleId,
                                long[] userIds)
                         throws PortalException,
                                SystemException

Throws:: PortalException; SystemException - if a system exception occurred

addTeamUser

public static void addTeamUser(long teamId,
                               long userId)
                        throws SystemException

Throws:: SystemException - if a system exception occurred

addTeamUser

public static void addTeamUser(long teamId,
                               User user)
                        throws SystemException

Throws:: SystemException - if a system exception occurred

addTeamUsers

public static void addTeamUsers(long teamId,
                                long[] userIds)
                         throws PortalException,
                                SystemException

Throws:: PortalException; SystemException - if a system exception occurred

addTeamUsers

public static void addTeamUsers(long teamId,
                                List<User> Users)
                         throws PortalException,
                                SystemException

Throws:: PortalException; SystemException - if a system exception occurred

clearTeamUsers

public static void clearTeamUsers(long teamId)
                           throws SystemException

Throws:: SystemException - if a system exception occurred

deleteTeamUser

public static void deleteTeamUser(long teamId,
                                  long userId)
                           throws SystemException

Throws:: SystemException - if a system exception occurred

deleteTeamUser

public static void deleteTeamUser(long teamId,
                                  User user)
                           throws SystemException

Throws:: SystemException - if a system exception occurred

deleteTeamUsers

public static void deleteTeamUsers(long teamId,
                                   long[] userIds)
                            throws SystemException

Throws:: SystemException - if a system exception occurred

deleteTeamUsers

public static void deleteTeamUsers(long teamId,
                                   List<User> Users)
                            throws SystemException

Throws:: SystemException - if a system exception occurred

getTeamUsers

public static List<User> getTeamUsers(long teamId)
                               throws SystemException

Throws:: SystemException - if a system exception occurred

getTeamUsers

public static List<User> getTeamUsers(long teamId,
                                      int start,
                                      int end)
                               throws SystemException

Throws:: SystemException - if a system exception occurred

getTeamUsers

public static List<User> getTeamUsers(long teamId,
                                      int start,
                                      int end,
                                      OrderByComparator orderByComparator)
                               throws SystemException

Throws:: SystemException - if a system exception occurred

getTeamUsersCount

public static int getTeamUsersCount(long teamId)
                             throws SystemException

Throws:: SystemException - if a system exception occurred

hasTeamUser

public static boolean hasTeamUser(long teamId,
                                  long userId)
                           throws SystemException

Throws:: SystemException - if a system exception occurred

hasTeamUsers

public static boolean hasTeamUsers(long teamId)
                            throws SystemException

Throws:: SystemException - if a system exception occurred

setTeamUsers

public static void setTeamUsers(long teamId,
                                long[] userIds)
                         throws SystemException

Throws:: SystemException - if a system exception occurred

addUserGroupUser

public static void addUserGroupUser(long userGroupId,
                                    long userId)
                             throws SystemException

Throws:: SystemException - if a system exception occurred

addUserGroupUser

public static void addUserGroupUser(long userGroupId,
                                    User user)
                             throws SystemException

Throws:: SystemException - if a system exception occurred

addUserGroupUsers

public static void addUserGroupUsers(long userGroupId,
                                     long[] userIds)
                              throws PortalException,
                                     SystemException

Throws:: PortalException; SystemException - if a system exception occurred

addUserGroupUsers

public static void addUserGroupUsers(long userGroupId,
                                     List<User> Users)
                              throws PortalException,
                                     SystemException

Throws:: PortalException; SystemException - if a system exception occurred

clearUserGroupUsers

public static void clearUserGroupUsers(long userGroupId)
                                throws SystemException

Throws:: SystemException - if a system exception occurred

deleteUserGroupUser

public static void deleteUserGroupUser(long userGroupId,
                                       long userId)
                                throws PortalException,
                                       SystemException

Throws:: PortalException; SystemException - if a system exception occurred

deleteUserGroupUser

public static void deleteUserGroupUser(long userGroupId,
                                       User user)
                                throws PortalException,
                                       SystemException

Throws:: PortalException; SystemException - if a system exception occurred

deleteUserGroupUsers

public static void deleteUserGroupUsers(long userGroupId,
                                        long[] userIds)
                                 throws SystemException

Throws:: SystemException - if a system exception occurred

deleteUserGroupUsers

public static void deleteUserGroupUsers(long userGroupId,
                                        List<User> Users)
                                 throws SystemException

Throws:: SystemException - if a system exception occurred

getUserGroupUsers

public static List<User> getUserGroupUsers(long userGroupId)
                                    throws SystemException

Throws:: SystemException - if a system exception occurred

getUserGroupUsers

public static List<User> getUserGroupUsers(long userGroupId,
                                           int start,
                                           int end)
                                    throws SystemException

Throws:: SystemException - if a system exception occurred

getUserGroupUsers

public static List<User> getUserGroupUsers(long userGroupId,
                                           int start,
                                           int end,
                                           OrderByComparator orderByComparator)
                                    throws SystemException

Throws:: SystemException - if a system exception occurred

getUserGroupUsersCount

public static int getUserGroupUsersCount(long userGroupId)
                                  throws SystemException

Throws:: SystemException - if a system exception occurred

hasUserGroupUser

public static boolean hasUserGroupUser(long userGroupId,
                                       long userId)
                                throws SystemException

Throws:: SystemException - if a system exception occurred

hasUserGroupUsers

public static boolean hasUserGroupUsers(long userGroupId)
                                 throws SystemException

Throws:: SystemException - if a system exception occurred

setUserGroupUsers

public static void setUserGroupUsers(long userGroupId,
                                     long[] userIds)
                              throws PortalException,
                                     SystemException

Throws:: PortalException; SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:: the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:: beanIdentifier - the Spring bean ID for this bean

addDefaultAdminUser

public static User addDefaultAdminUser(long companyId,
                                       String screenName,
                                       String emailAddress,
                                       Locale locale,
                                       String firstName,
                                       String middleName,
                                       String lastName)
                                throws PortalException,
                                       SystemException

Throws:: PortalException; SystemException

addDefaultGroups

public static 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.

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 static 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.

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 static 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.

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 static void addPasswordPolicyUsers(long passwordPolicyId,
                                          long[] userIds)
                                   throws SystemException

Assigns the password policy to the users, removing any other currently assigned password policies.

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 static 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.

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 user's service context (optionally null). Can set the universally unique identifier (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 static 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.

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 user's service context (optionally null). Can set the universally unique identifier (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 static 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.

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 static 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.

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 static 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.

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 static 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:

CompanyConstants.AUTH_TYPE_EA - login is the user's email address
CompanyConstants.AUTH_TYPE_SN - login is the user's screen name
CompanyConstants.AUTH_TYPE_ID - login is the user's primary key

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 static 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.

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 static boolean authenticateForJAAS(long userId,
                                          String encPassword)

Attempts to authenticate the user using JAAS credentials, without using the AuthPipeline.

Parameters:: userId - the primary key of the user; encPassword - the encrypted password
Returns:: true if authentication is successful; false otherwise

checkLockout

public static 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.

Parameters:: user - the user
Throws:: PortalException - if the user was determined to still be locked out; SystemException - if a system exception occurred

checkLoginFailure

public static void checkLoginFailure(User user)
                              throws SystemException

Adds a failed login attempt to the user and updates the user's last failed login date.

Parameters:: user - the user
Throws:: SystemException - if a system exception occurred

checkLoginFailureByEmailAddress

public static 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.

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 static void checkLoginFailureById(long userId)
                                  throws PortalException,
                                         SystemException

Adds a failed login attempt to the user and updates the user's last failed login date.

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 static 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.

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 static 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.

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 static void completeUserRegistration(User user,
                                            ServiceContext serviceContext)
                                     throws PortalException,
                                            SystemException

Completes the user's registration by generating a password and sending the confirmation email.

Parameters:: user - the user; serviceContext - the user's service context. Can set whether a password should be generated (with the autoPassword attribute) and whether the confirmation email should be sent (with the sendEmail attribute) for the user.
Throws:: PortalException - if a portal exception occurred; SystemException - if a system exception occurred

decryptUserId

public static 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.

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 static void deletePortrait(long userId)
                           throws PortalException,
                                  SystemException

Deletes the user's portrait image.

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 static 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.

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 static User fetchUserByEmailAddress(long companyId,
                                           String emailAddress)
                                    throws SystemException

Returns the user with the email address.

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

fetchUserById

public static User fetchUserById(long userId)
                          throws SystemException

Returns the user with the primary key.

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

fetchUserByScreenName

public static User fetchUserByScreenName(long companyId,
                                         String screenName)
                                  throws SystemException

Returns the user with the screen name.

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 static List<User> getCompanyUsers(long companyId,
                                         int start,
                                         int end)
                                  throws SystemException

Returns a range of all the users belonging to the company.

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 static int getCompanyUsersCount(long companyId)
                                throws SystemException

Returns the number of users belonging to the company.

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 static User getDefaultUser(long companyId)
                           throws PortalException,
                                  SystemException

Returns the default user for the company.

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 static long getDefaultUserId(long companyId)
                             throws PortalException,
                                    SystemException

Returns the primary key of the default user for the company.

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 static long[] getGroupUserIds(long groupId)
                              throws SystemException

Returns the primary keys of all the users belonging to the group.

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 static int getGroupUsersCount(long groupId,
                                     int status)
                              throws PortalException,
                                     SystemException

Returns the number of users with the status belonging to the group.

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

getNoAnnouncementsDeliveries

public static 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.

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 static List<User> getNoContacts()
                                throws SystemException

Returns all the users who do not have any contacts.

Returns:: the users who do not have any contacts
Throws:: SystemException - if a system exception occurred

getNoGroups

public static List<User> getNoGroups()
                              throws SystemException

Returns all the users who do not belong to any groups, excluding the default user.

Returns:: the users who do not belong to any groups
Throws:: SystemException - if a system exception occurred

getOrganizationUserIds

public static long[] getOrganizationUserIds(long organizationId)
                                     throws SystemException

Returns the primary keys of all the users belonging to the organization.

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 static int getOrganizationUsersCount(long organizationId,
                                            int status)
                                     throws PortalException,
                                            SystemException

Returns the number of users with the status belonging to the organization.

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 static long[] getRoleUserIds(long roleId)
                             throws SystemException

Returns the primary keys of all the users belonging to the role.

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 static int getRoleUsersCount(long roleId,
                                    int status)
                             throws PortalException,
                                    SystemException

Returns the number of users with the status belonging to the role.

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 static 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.

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 static 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.

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 static 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.

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 static 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.

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 static int getSocialUsersCount(long userId)
                               throws PortalException,
                                      SystemException

Returns the number of users with a social relation with the user.

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 static int getSocialUsersCount(long userId,
                                      int type)
                               throws PortalException,
                                      SystemException

Returns the number of users with a social relation of the type with the user.

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 static 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.

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 static 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.

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 static User getUserByContactId(long contactId)
                               throws PortalException,
                                      SystemException

Returns the user with the contact ID.

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 static User getUserByEmailAddress(long companyId,
                                         String emailAddress)
                                  throws PortalException,
                                         SystemException

Returns the user with the email address.

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 static User getUserByFacebookId(long companyId,
                                       long facebookId)
                                throws PortalException,
                                       SystemException

Returns the user with the Facebook ID.

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 static User getUserById(long userId)
                        throws PortalException,
                               SystemException

Returns the user with the primary key.

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 static User getUserById(long companyId,
                               long userId)
                        throws PortalException,
                               SystemException

Returns the user with the primary key from the company.

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 static User getUserByOpenId(long companyId,
                                   String openId)
                            throws PortalException,
                                   SystemException

Returns the user with the OpenID.

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 static User getUserByPortraitId(long portraitId)
                                throws PortalException,
                                       SystemException

Returns the user with the portrait ID.

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 static User getUserByScreenName(long companyId,
                                       String screenName)
                                throws PortalException,
                                       SystemException

Returns the user with the screen name.

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 static User getUserByUuid(String uuid)
                          throws PortalException,
                                 SystemException

Returns the user with the universally unique identifier.

Parameters:: uuid - the user's universally unique identifier
Returns:: the user with the universally unique identifier
Throws:: PortalException - if a user with the universally unique identifier could not be found; SystemException - if a system exception occurred

getUserGroupUsersCount

public static int getUserGroupUsersCount(long userGroupId,
                                         int status)
                                  throws PortalException,
                                         SystemException

Returns the number of users with the status belonging to the user group.

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 static long getUserIdByEmailAddress(long companyId,
                                           String emailAddress)
                                    throws PortalException,
                                           SystemException

Returns the primary key of the user with the email address.

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 static long getUserIdByScreenName(long companyId,
                                         String screenName)
                                  throws PortalException,
                                         SystemException

Returns the primary key of the user with the screen name.

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 static boolean hasPasswordPolicyUser(long passwordPolicyId,
                                            long userId)
                                     throws SystemException

Returns true if the password policy has been assigned to the user.

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 static 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.

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 static boolean isPasswordExpired(User user)
                                 throws PortalException,
                                        SystemException

Returns true if the user's password is expired.

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 static boolean isPasswordExpiringSoon(User user)
                                      throws PortalException,
                                             SystemException

Returns true if the user's password is expiring soon.

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 static User loadGetDefaultUser(long companyId)
                               throws PortalException,
                                      SystemException

Throws:: PortalException; SystemException

search

public static 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.

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 static 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.

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 static 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.

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 static 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.

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 static 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.

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 static 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.

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 static void sendEmailAddressVerification(User user,
                                                String emailAddress,
                                                ServiceContext serviceContext)
                                         throws PortalException,
                                                SystemException

Sends an email address verification to the user.

Parameters:: user - the verification email recipient; emailAddress - the recipient's email address; serviceContext - the service context. 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 static 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.

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 user's service context
Throws:: PortalException - if a user with the email address could not be found; SystemException - if a system exception occurred

unsetGroupTeamsUsers

public static void unsetGroupTeamsUsers(long groupId,
                                        long[] userIds)
                                 throws PortalException,
                                        SystemException

Removes the users from the teams of a group.

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 static void unsetGroupUsers(long groupId,
                                   long[] userIds,
                                   ServiceContext serviceContext)
                            throws PortalException,
                                   SystemException

Removes the users from the group.

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 static void unsetOrganizationUsers(long organizationId,
                                          long[] userIds)
                                   throws PortalException,
                                          SystemException

Removes the users from the organization.

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 static void unsetPasswordPolicyUsers(long passwordPolicyId,
                                            long[] userIds)
                                     throws SystemException

Removes the users from the password policy.

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 static void unsetRoleUsers(long roleId,
                                  List<User> users)
                           throws PortalException,
                                  SystemException

Removes the users from the role.

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 static void unsetRoleUsers(long roleId,
                                  long[] userIds)
                           throws PortalException,
                                  SystemException

Removes the users from the role.

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 static void unsetTeamUsers(long teamId,
                                  long[] userIds)
                           throws PortalException,
                                  SystemException

Removes the users from the team.

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 static void unsetUserGroupUsers(long userGroupId,
                                       long[] userIds)
                                throws PortalException,
                                       SystemException

Removes the users from the user group.

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 static User updateAgreedToTermsOfUse(long userId,
                                            boolean agreedToTermsOfUse)
                                     throws PortalException,
                                            SystemException

Updates whether the user has agreed to the terms of use.

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 static 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.

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 static User updateCreateDate(long userId,
                                    Date createDate)
                             throws PortalException,
                                    SystemException

Updates the user's creation date.

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 static User updateEmailAddress(long userId,
                                      String password,
                                      String emailAddress1,
                                      String emailAddress2)
                               throws PortalException,
                                      SystemException

Updates the user's email address.

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 static 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.

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 static User updateEmailAddressVerified(long userId,
                                              boolean emailAddressVerified)
                                       throws PortalException,
                                              SystemException

Updates whether the user has verified email address.

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 static User updateFacebookId(long userId,
                                    long facebookId)
                             throws PortalException,
                                    SystemException

Updates the user's Facebook ID.

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 static void updateGroups(long userId,
                                long[] newGroupIds,
                                ServiceContext serviceContext)
                         throws PortalException,
                                SystemException

Sets the groups the user is in, removing and adding groups as necessary.

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 static 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.

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 user's service context (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 static User updateJobTitle(long userId,
                                  String jobTitle)
                           throws PortalException,
                                  SystemException

Updates the user's job title.

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 static User updateLastLogin(long userId,
                                   String loginIP)
                            throws PortalException,
                                   SystemException

Updates the user's last login with the current time and the IP address.

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 static User updateLockout(User user,
                                 boolean lockout)
                          throws PortalException,
                                 SystemException

Updates whether the user is locked out from logging in.

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 static User updateLockoutByEmailAddress(long companyId,
                                               String emailAddress,
                                               boolean lockout)
                                        throws PortalException,
                                               SystemException

Updates whether the user is locked out from logging in.

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 static User updateLockoutById(long userId,
                                     boolean lockout)
                              throws PortalException,
                                     SystemException

Updates whether the user is locked out from logging in.

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 static User updateLockoutByScreenName(long companyId,
                                             String screenName,
                                             boolean lockout)
                                      throws PortalException,
                                             SystemException

Updates whether the user is locked out from logging in.

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 static User updateModifiedDate(long userId,
                                      Date modifiedDate)
                               throws PortalException,
                                      SystemException

Updates the user's modified date.

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 static User updateOpenId(long userId,
                                String openId)
                         throws PortalException,
                                SystemException

Updates the user's OpenID.

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 static 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.

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 static 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.

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 static 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.

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 static 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.

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 static 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.

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 static User updatePortrait(long userId,
                                  byte[] bytes)
                           throws PortalException,
                                  SystemException

Updates the user's portrait image.

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 static User updateReminderQuery(long userId,
                                       String question,
                                       String answer)
                                throws PortalException,
                                       SystemException

Updates the user's password reset question and answer.

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 static User updateScreenName(long userId,
                                    String screenName)
                             throws PortalException,
                                    SystemException

Updates the user's screen name.

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 static User updateStatus(long userId,
                                int status)
                         throws PortalException,
                                SystemException

Updates the user's workflow status.

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

updateUser

public static 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.

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 user's service context (optionally null). Can set the universally unique identifier (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 static void verifyEmailAddress(String ticketKey)
                               throws PortalException,
                                      SystemException

Verifies the email address of the ticket.

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

getService

public static UserLocalService getService()

setService

public void setService(UserLocalService service)

Deprecated.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Liferay 6.1.2-ce-ga3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.liferay.portal.service Class UserLocalServiceUtil

UserLocalServiceUtil

addUser

createUser

deleteUser

deleteUser

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQueryCount

fetchUser

getUser

getPersistedModel

getUsers

getUsersCount

updateUser

updateUser

addGroupUser

addGroupUser

addGroupUsers

addGroupUsers

clearGroupUsers

deleteGroupUser

deleteGroupUser

deleteGroupUsers

deleteGroupUsers

getGroupUsers

getGroupUsers

getGroupUsers

getGroupUsersCount

hasGroupUser

hasGroupUsers

setGroupUsers

addOrganizationUser

addOrganizationUser

addOrganizationUsers

addOrganizationUsers

clearOrganizationUsers

deleteOrganizationUser

deleteOrganizationUser

deleteOrganizationUsers

deleteOrganizationUsers

getOrganizationUsers

getOrganizationUsers

getOrganizationUsers

getOrganizationUsersCount

hasOrganizationUser

hasOrganizationUsers

setOrganizationUsers

addPermissionUser

addPermissionUser

addPermissionUsers

addPermissionUsers

clearPermissionUsers

deletePermissionUser

deletePermissionUser

deletePermissionUsers

deletePermissionUsers

getPermissionUsers

getPermissionUsers

getPermissionUsers

getPermissionUsersCount

hasPermissionUser

hasPermissionUsers

setPermissionUsers

addRoleUser

addRoleUser

addRoleUsers

addRoleUsers

clearRoleUsers

deleteRoleUser

deleteRoleUser

deleteRoleUsers

deleteRoleUsers

getRoleUsers

getRoleUsers

getRoleUsers

getRoleUsersCount

hasRoleUser

com.liferay.portal.service
Class UserLocalServiceUtil