/portal-service/src/com/liferay/portal/service/UserServiceWrapper.java

https://github.com/monicali/liferay-portal · Java · 1174 lines · 372 code · 48 blank · 754 comment · 0 complexity · 6838a7795313b89e55a200e6e347469b MD5 · raw file

  1. /**
  2. * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
  3. *
  4. * This library is free software; you can redistribute it and/or modify it under
  5. * the terms of the GNU Lesser General Public License as published by the Free
  6. * Software Foundation; either version 2.1 of the License, or (at your option)
  7. * any later version.
  8. *
  9. * This library is distributed in the hope that it will be useful, but WITHOUT
  10. * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  11. * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
  12. * details.
  13. */
  14. package com.liferay.portal.service;
  15. /**
  16. * <p>
  17. * This class is a wrapper for {@link UserService}.
  18. * </p>
  19. *
  20. * @author Brian Wing Shun Chan
  21. * @see UserService
  22. * @generated
  23. */
  24. public class UserServiceWrapper implements UserService,
  25. ServiceWrapper<UserService> {
  26. public UserServiceWrapper(UserService userService) {
  27. _userService = userService;
  28. }
  29. /**
  30. * Adds the users to the group.
  31. *
  32. * @param groupId the primary key of the group
  33. * @param userIds the primary keys of the users
  34. * @throws PortalException if a group or user with the primary key could not
  35. be found, or if the user did not have permission to assign group
  36. members
  37. * @throws SystemException if a system exception occurred
  38. */
  39. public void addGroupUsers(long groupId, long[] userIds,
  40. com.liferay.portal.service.ServiceContext serviceContext)
  41. throws com.liferay.portal.kernel.exception.PortalException,
  42. com.liferay.portal.kernel.exception.SystemException {
  43. _userService.addGroupUsers(groupId, userIds, serviceContext);
  44. }
  45. /**
  46. * Adds the users to the organization.
  47. *
  48. * @param organizationId the primary key of the organization
  49. * @param userIds the primary keys of the users
  50. * @throws PortalException if an organization or user with the primary key
  51. could not be found, if the user did not have permission to assign
  52. organization members, or if current user did not have an
  53. organization in common with a given user
  54. * @throws SystemException if a system exception occurred
  55. */
  56. public void addOrganizationUsers(long organizationId, long[] userIds)
  57. throws com.liferay.portal.kernel.exception.PortalException,
  58. com.liferay.portal.kernel.exception.SystemException {
  59. _userService.addOrganizationUsers(organizationId, userIds);
  60. }
  61. /**
  62. * Assigns the password policy to the users, removing any other currently
  63. * assigned password policies.
  64. *
  65. * @param passwordPolicyId the primary key of the password policy
  66. * @param userIds the primary keys of the users
  67. * @throws PortalException if the user did not have permission to assign
  68. policy members
  69. * @throws SystemException if a system exception occurred
  70. */
  71. public void addPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
  72. throws com.liferay.portal.kernel.exception.PortalException,
  73. com.liferay.portal.kernel.exception.SystemException {
  74. _userService.addPasswordPolicyUsers(passwordPolicyId, userIds);
  75. }
  76. /**
  77. * Adds the users to the role.
  78. *
  79. * @param roleId the primary key of the role
  80. * @param userIds the primary keys of the users
  81. * @throws PortalException if a role or user with the primary key could not
  82. be found or if the user did not have permission to assign role
  83. members
  84. * @throws SystemException if a system exception occurred
  85. */
  86. public void addRoleUsers(long roleId, long[] userIds)
  87. throws com.liferay.portal.kernel.exception.PortalException,
  88. com.liferay.portal.kernel.exception.SystemException {
  89. _userService.addRoleUsers(roleId, userIds);
  90. }
  91. /**
  92. * Adds the users to the team.
  93. *
  94. * @param teamId the primary key of the team
  95. * @param userIds the primary keys of the users
  96. * @throws PortalException if a team or user with the primary key could not
  97. be found or if the user did not have permission to assign team
  98. members
  99. * @throws SystemException if a system exception occurred
  100. */
  101. public void addTeamUsers(long teamId, long[] userIds)
  102. throws com.liferay.portal.kernel.exception.PortalException,
  103. com.liferay.portal.kernel.exception.SystemException {
  104. _userService.addTeamUsers(teamId, userIds);
  105. }
  106. /**
  107. * Adds a user.
  108. *
  109. * <p>
  110. * This method handles the creation and bookkeeping of the user including
  111. * its resources, metadata, and internal data structures. It is not
  112. * necessary to make subsequent calls to any methods to setup default
  113. * groups, resources, etc.
  114. * </p>
  115. *
  116. * @param companyId the primary key of the user's company
  117. * @param autoPassword whether a password should be automatically generated
  118. for the user
  119. * @param password1 the user's password
  120. * @param password2 the user's password confirmation
  121. * @param autoScreenName whether a screen name should be automatically
  122. generated for the user
  123. * @param screenName the user's screen name
  124. * @param emailAddress the user's email address
  125. * @param facebookId the user's facebook ID
  126. * @param openId the user's OpenID
  127. * @param locale the user's locale
  128. * @param firstName the user's first name
  129. * @param middleName the user's middle name
  130. * @param lastName the user's last name
  131. * @param prefixId the user's name prefix ID
  132. * @param suffixId the user's name suffix ID
  133. * @param male whether the user is male
  134. * @param birthdayMonth the user's birthday month (0-based, meaning 0 for
  135. January)
  136. * @param birthdayDay the user's birthday day
  137. * @param birthdayYear the user's birthday year
  138. * @param jobTitle the user's job title
  139. * @param groupIds the primary keys of the user's groups
  140. * @param organizationIds the primary keys of the user's organizations
  141. * @param roleIds the primary keys of the roles this user possesses
  142. * @param userGroupIds the primary keys of the user's user groups
  143. * @param sendEmail whether to send the user an email notification about
  144. their new account
  145. * @param serviceContext the user's service context (optionally
  146. <code>null</code>). Can set the universally unique identifier
  147. (with the <code>uuid</code> attribute), asset category IDs, asset
  148. tag names, and expando bridge attributes for the user.
  149. * @return the new user
  150. * @throws PortalException if the user's information was invalid, if the
  151. creator did not have permission to add users, or if the email
  152. address was reserved
  153. * @throws SystemException if a system exception occurred
  154. */
  155. public com.liferay.portal.model.User addUser(long companyId,
  156. boolean autoPassword, java.lang.String password1,
  157. java.lang.String password2, boolean autoScreenName,
  158. java.lang.String screenName, java.lang.String emailAddress,
  159. long facebookId, java.lang.String openId, java.util.Locale locale,
  160. java.lang.String firstName, java.lang.String middleName,
  161. java.lang.String lastName, int prefixId, int suffixId, boolean male,
  162. int birthdayMonth, int birthdayDay, int birthdayYear,
  163. java.lang.String jobTitle, long[] groupIds, long[] organizationIds,
  164. long[] roleIds, long[] userGroupIds, boolean sendEmail,
  165. com.liferay.portal.service.ServiceContext serviceContext)
  166. throws com.liferay.portal.kernel.exception.PortalException,
  167. com.liferay.portal.kernel.exception.SystemException {
  168. return _userService.addUser(companyId, autoPassword, password1,
  169. password2, autoScreenName, screenName, emailAddress, facebookId,
  170. openId, locale, firstName, middleName, lastName, prefixId,
  171. suffixId, male, birthdayMonth, birthdayDay, birthdayYear, jobTitle,
  172. groupIds, organizationIds, roleIds, userGroupIds, sendEmail,
  173. serviceContext);
  174. }
  175. /**
  176. * Adds a user with additional parameters.
  177. *
  178. * <p>
  179. * This method handles the creation and bookkeeping of the user including
  180. * its resources, metadata, and internal data structures. It is not
  181. * necessary to make subsequent calls to any methods to setup default
  182. * groups, resources, etc.
  183. * </p>
  184. *
  185. * @param companyId the primary key of the user's company
  186. * @param autoPassword whether a password should be automatically generated
  187. for the user
  188. * @param password1 the user's password
  189. * @param password2 the user's password confirmation
  190. * @param autoScreenName whether a screen name should be automatically
  191. generated for the user
  192. * @param screenName the user's screen name
  193. * @param emailAddress the user's email address
  194. * @param facebookId the user's facebook ID
  195. * @param openId the user's OpenID
  196. * @param locale the user's locale
  197. * @param firstName the user's first name
  198. * @param middleName the user's middle name
  199. * @param lastName the user's last name
  200. * @param prefixId the user's name prefix ID
  201. * @param suffixId the user's name suffix ID
  202. * @param male whether the user is male
  203. * @param birthdayMonth the user's birthday month (0-based, meaning 0 for
  204. January)
  205. * @param birthdayDay the user's birthday day
  206. * @param birthdayYear the user's birthday year
  207. * @param jobTitle the user's job title
  208. * @param groupIds the primary keys of the user's groups
  209. * @param organizationIds the primary keys of the user's organizations
  210. * @param roleIds the primary keys of the roles this user possesses
  211. * @param userGroupIds the primary keys of the user's user groups
  212. * @param addresses the user's addresses
  213. * @param emailAddresses the user's email addresses
  214. * @param phones the user's phone numbers
  215. * @param websites the user's websites
  216. * @param announcementsDelivers the announcements deliveries
  217. * @param sendEmail whether to send the user an email notification about
  218. their new account
  219. * @param serviceContext the user's service context (optionally
  220. <code>null</code>). Can set the universally unique identifier
  221. (with the <code>uuid</code> attribute), asset category IDs, asset
  222. tag names, and expando bridge attributes for the user.
  223. * @return the new user
  224. * @throws PortalException if the user's information was invalid, if the
  225. creator did not have permission to add users, if the email
  226. address was reserved, or some other portal exception occurred
  227. * @throws SystemException if a system exception occurred
  228. */
  229. public com.liferay.portal.model.User addUser(long companyId,
  230. boolean autoPassword, java.lang.String password1,
  231. java.lang.String password2, boolean autoScreenName,
  232. java.lang.String screenName, java.lang.String emailAddress,
  233. long facebookId, java.lang.String openId, java.util.Locale locale,
  234. java.lang.String firstName, java.lang.String middleName,
  235. java.lang.String lastName, int prefixId, int suffixId, boolean male,
  236. int birthdayMonth, int birthdayDay, int birthdayYear,
  237. java.lang.String jobTitle, long[] groupIds, long[] organizationIds,
  238. long[] roleIds, long[] userGroupIds,
  239. java.util.List<com.liferay.portal.model.Address> addresses,
  240. java.util.List<com.liferay.portal.model.EmailAddress> emailAddresses,
  241. java.util.List<com.liferay.portal.model.Phone> phones,
  242. java.util.List<com.liferay.portal.model.Website> websites,
  243. java.util.List<com.liferay.portlet.announcements.model.AnnouncementsDelivery> announcementsDelivers,
  244. boolean sendEmail,
  245. com.liferay.portal.service.ServiceContext serviceContext)
  246. throws com.liferay.portal.kernel.exception.PortalException,
  247. com.liferay.portal.kernel.exception.SystemException {
  248. return _userService.addUser(companyId, autoPassword, password1,
  249. password2, autoScreenName, screenName, emailAddress, facebookId,
  250. openId, locale, firstName, middleName, lastName, prefixId,
  251. suffixId, male, birthdayMonth, birthdayDay, birthdayYear, jobTitle,
  252. groupIds, organizationIds, roleIds, userGroupIds, addresses,
  253. emailAddresses, phones, websites, announcementsDelivers, sendEmail,
  254. serviceContext);
  255. }
  256. /**
  257. * Adds the users to the user group.
  258. *
  259. * @param userGroupId the primary key of the user group
  260. * @param userIds the primary keys of the users
  261. * @throws PortalException if a user group or user with the primary could
  262. could not be found, or if the current user did not have
  263. permission to assign group members
  264. * @throws SystemException if a system exception occurred
  265. */
  266. public void addUserGroupUsers(long userGroupId, long[] userIds)
  267. throws com.liferay.portal.kernel.exception.PortalException,
  268. com.liferay.portal.kernel.exception.SystemException {
  269. _userService.addUserGroupUsers(userGroupId, userIds);
  270. }
  271. /**
  272. * Adds a user with workflow.
  273. *
  274. * <p>
  275. * This method handles the creation and bookkeeping of the user including
  276. * its resources, metadata, and internal data structures. It is not
  277. * necessary to make subsequent calls to any methods to setup default
  278. * groups, resources, etc.
  279. * </p>
  280. *
  281. * @param companyId the primary key of the user's company
  282. * @param autoPassword whether a password should be automatically generated
  283. for the user
  284. * @param password1 the user's password
  285. * @param password2 the user's password confirmation
  286. * @param autoScreenName whether a screen name should be automatically
  287. generated for the user
  288. * @param screenName the user's screen name
  289. * @param emailAddress the user's email address
  290. * @param facebookId the user's facebook ID
  291. * @param openId the user's OpenID
  292. * @param locale the user's locale
  293. * @param firstName the user's first name
  294. * @param middleName the user's middle name
  295. * @param lastName the user's last name
  296. * @param prefixId the user's name prefix ID
  297. * @param suffixId the user's name suffix ID
  298. * @param male whether the user is male
  299. * @param birthdayMonth the user's birthday month (0-based, meaning 0 for
  300. January)
  301. * @param birthdayDay the user's birthday day
  302. * @param birthdayYear the user's birthday year
  303. * @param jobTitle the user's job title
  304. * @param groupIds the primary keys of the user's groups
  305. * @param organizationIds the primary keys of the user's organizations
  306. * @param roleIds the primary keys of the roles this user possesses
  307. * @param userGroupIds the primary keys of the user's user groups
  308. * @param sendEmail whether to send the user an email notification about
  309. their new account
  310. * @param serviceContext the user's service context (optionally
  311. <code>null</code>). Can set the universally unique identifier
  312. (with the <code>uuid</code> attribute), asset category IDs, asset
  313. tag names, and expando bridge attributes for the user.
  314. * @return the new user
  315. * @throws PortalException if the user's information was invalid, if the
  316. creator did not have permission to add users, or if the email
  317. address was reserved
  318. * @throws SystemException if a system exception occurred
  319. */
  320. public com.liferay.portal.model.User addUserWithWorkflow(long companyId,
  321. boolean autoPassword, java.lang.String password1,
  322. java.lang.String password2, boolean autoScreenName,
  323. java.lang.String screenName, java.lang.String emailAddress,
  324. long facebookId, java.lang.String openId, java.util.Locale locale,
  325. java.lang.String firstName, java.lang.String middleName,
  326. java.lang.String lastName, int prefixId, int suffixId, boolean male,
  327. int birthdayMonth, int birthdayDay, int birthdayYear,
  328. java.lang.String jobTitle, long[] groupIds, long[] organizationIds,
  329. long[] roleIds, long[] userGroupIds, boolean sendEmail,
  330. com.liferay.portal.service.ServiceContext serviceContext)
  331. throws com.liferay.portal.kernel.exception.PortalException,
  332. com.liferay.portal.kernel.exception.SystemException {
  333. return _userService.addUserWithWorkflow(companyId, autoPassword,
  334. password1, password2, autoScreenName, screenName, emailAddress,
  335. facebookId, openId, locale, firstName, middleName, lastName,
  336. prefixId, suffixId, male, birthdayMonth, birthdayDay, birthdayYear,
  337. jobTitle, groupIds, organizationIds, roleIds, userGroupIds,
  338. sendEmail, serviceContext);
  339. }
  340. /**
  341. * Adds a user with workflow and additional parameters.
  342. *
  343. * <p>
  344. * This method handles the creation and bookkeeping of the user including
  345. * its resources, metadata, and internal data structures. It is not
  346. * necessary to make subsequent calls to any methods to setup default
  347. * groups, resources, etc.
  348. * </p>
  349. *
  350. * @param companyId the primary key of the user's company
  351. * @param autoPassword whether a password should be automatically generated
  352. for the user
  353. * @param password1 the user's password
  354. * @param password2 the user's password confirmation
  355. * @param autoScreenName whether a screen name should be automatically
  356. generated for the user
  357. * @param screenName the user's screen name
  358. * @param emailAddress the user's email address
  359. * @param facebookId the user's facebook ID
  360. * @param openId the user's OpenID
  361. * @param locale the user's locale
  362. * @param firstName the user's first name
  363. * @param middleName the user's middle name
  364. * @param lastName the user's last name
  365. * @param prefixId the user's name prefix ID
  366. * @param suffixId the user's name suffix ID
  367. * @param male whether the user is male
  368. * @param birthdayMonth the user's birthday month (0-based, meaning 0 for
  369. January)
  370. * @param birthdayDay the user's birthday day
  371. * @param birthdayYear the user's birthday year
  372. * @param jobTitle the user's job title
  373. * @param groupIds the primary keys of the user's groups
  374. * @param organizationIds the primary keys of the user's organizations
  375. * @param roleIds the primary keys of the roles this user possesses
  376. * @param userGroupIds the primary keys of the user's user groups
  377. * @param addresses the user's addresses
  378. * @param emailAddresses the user's email addresses
  379. * @param phones the user's phone numbers
  380. * @param websites the user's websites
  381. * @param announcementsDelivers the announcements deliveries
  382. * @param sendEmail whether to send the user an email notification about
  383. their new account
  384. * @param serviceContext the user's service context (optionally
  385. <code>null</code>). Can set the universally unique identifier
  386. (with the <code>uuid</code> attribute), asset category IDs, asset
  387. tag names, and expando bridge attributes for the user.
  388. * @return the new user
  389. * @throws PortalException if the user's information was invalid, if the
  390. creator did not have permission to add users, if the email
  391. address was reserved, or some other portal exception occurred
  392. * @throws SystemException if a system exception occurred
  393. */
  394. public com.liferay.portal.model.User addUserWithWorkflow(long companyId,
  395. boolean autoPassword, java.lang.String password1,
  396. java.lang.String password2, boolean autoScreenName,
  397. java.lang.String screenName, java.lang.String emailAddress,
  398. long facebookId, java.lang.String openId, java.util.Locale locale,
  399. java.lang.String firstName, java.lang.String middleName,
  400. java.lang.String lastName, int prefixId, int suffixId, boolean male,
  401. int birthdayMonth, int birthdayDay, int birthdayYear,
  402. java.lang.String jobTitle, long[] groupIds, long[] organizationIds,
  403. long[] roleIds, long[] userGroupIds,
  404. java.util.List<com.liferay.portal.model.Address> addresses,
  405. java.util.List<com.liferay.portal.model.EmailAddress> emailAddresses,
  406. java.util.List<com.liferay.portal.model.Phone> phones,
  407. java.util.List<com.liferay.portal.model.Website> websites,
  408. java.util.List<com.liferay.portlet.announcements.model.AnnouncementsDelivery> announcementsDelivers,
  409. boolean sendEmail,
  410. com.liferay.portal.service.ServiceContext serviceContext)
  411. throws com.liferay.portal.kernel.exception.PortalException,
  412. com.liferay.portal.kernel.exception.SystemException {
  413. return _userService.addUserWithWorkflow(companyId, autoPassword,
  414. password1, password2, autoScreenName, screenName, emailAddress,
  415. facebookId, openId, locale, firstName, middleName, lastName,
  416. prefixId, suffixId, male, birthdayMonth, birthdayDay, birthdayYear,
  417. jobTitle, groupIds, organizationIds, roleIds, userGroupIds,
  418. addresses, emailAddresses, phones, websites, announcementsDelivers,
  419. sendEmail, serviceContext);
  420. }
  421. /**
  422. * Deletes the user's portrait image.
  423. *
  424. * @param userId the primary key of the user
  425. * @throws PortalException if a user with the primary key could not be
  426. found, if the user's portrait could not be found, or if the
  427. current user did not have permission to update the user
  428. * @throws SystemException if a system exception occurred
  429. */
  430. public void deletePortrait(long userId)
  431. throws com.liferay.portal.kernel.exception.PortalException,
  432. com.liferay.portal.kernel.exception.SystemException {
  433. _userService.deletePortrait(userId);
  434. }
  435. /**
  436. * Removes the user from the role.
  437. *
  438. * @param roleId the primary key of the role
  439. * @param userId the primary key of the user
  440. * @throws PortalException if a role or user with the primary key could not
  441. be found, or if the current user did not have permission to
  442. assign role members
  443. * @throws SystemException if a system exception occurred
  444. */
  445. public void deleteRoleUser(long roleId, long userId)
  446. throws com.liferay.portal.kernel.exception.PortalException,
  447. com.liferay.portal.kernel.exception.SystemException {
  448. _userService.deleteRoleUser(roleId, userId);
  449. }
  450. /**
  451. * Deletes the user.
  452. *
  453. * @param userId the primary key of the user
  454. * @throws PortalException if a user with the primary key could not be found
  455. or if the current user did not have permission to delete the user
  456. * @throws SystemException if a system exception occurred
  457. */
  458. public void deleteUser(long userId)
  459. throws com.liferay.portal.kernel.exception.PortalException,
  460. com.liferay.portal.kernel.exception.SystemException {
  461. _userService.deleteUser(userId);
  462. }
  463. /**
  464. * Returns the primary key of the default user for the company.
  465. *
  466. * @param companyId the primary key of the company
  467. * @return the primary key of the default user for the company
  468. * @throws PortalException if a default user for the company could not be
  469. found
  470. * @throws SystemException if a system exception occurred
  471. */
  472. public long getDefaultUserId(long companyId)
  473. throws com.liferay.portal.kernel.exception.PortalException,
  474. com.liferay.portal.kernel.exception.SystemException {
  475. return _userService.getDefaultUserId(companyId);
  476. }
  477. /**
  478. * Returns the primary keys of all the users belonging to the group.
  479. *
  480. * @param groupId the primary key of the group
  481. * @return the primary keys of the users belonging to the group
  482. * @throws PortalException if the current user did not have permission to
  483. view group assignments
  484. * @throws SystemException if a system exception occurred
  485. */
  486. public long[] getGroupUserIds(long groupId)
  487. throws com.liferay.portal.kernel.exception.PortalException,
  488. com.liferay.portal.kernel.exception.SystemException {
  489. return _userService.getGroupUserIds(groupId);
  490. }
  491. /**
  492. * Returns the primary keys of all the users belonging to the organization.
  493. *
  494. * @param organizationId the primary key of the organization
  495. * @return the primary keys of the users belonging to the organization
  496. * @throws PortalException if the current user did not have permission to
  497. view organization assignments
  498. * @throws SystemException if a system exception occurred
  499. */
  500. public long[] getOrganizationUserIds(long organizationId)
  501. throws com.liferay.portal.kernel.exception.PortalException,
  502. com.liferay.portal.kernel.exception.SystemException {
  503. return _userService.getOrganizationUserIds(organizationId);
  504. }
  505. /**
  506. * Returns the primary keys of all the users belonging to the role.
  507. *
  508. * @param roleId the primary key of the role
  509. * @return the primary keys of the users belonging to the role
  510. * @throws PortalException if the current user did not have permission to
  511. view role members
  512. * @throws SystemException if a system exception occurred
  513. */
  514. public long[] getRoleUserIds(long roleId)
  515. throws com.liferay.portal.kernel.exception.PortalException,
  516. com.liferay.portal.kernel.exception.SystemException {
  517. return _userService.getRoleUserIds(roleId);
  518. }
  519. /**
  520. * Returns the user with the email address.
  521. *
  522. * @param companyId the primary key of the user's company
  523. * @param emailAddress the user's email address
  524. * @return the user with the email address
  525. * @throws PortalException if a user with the email address could not be
  526. found or if the current user did not have permission to view the
  527. user
  528. * @throws SystemException if a system exception occurred
  529. */
  530. public com.liferay.portal.model.User getUserByEmailAddress(long companyId,
  531. java.lang.String emailAddress)
  532. throws com.liferay.portal.kernel.exception.PortalException,
  533. com.liferay.portal.kernel.exception.SystemException {
  534. return _userService.getUserByEmailAddress(companyId, emailAddress);
  535. }
  536. /**
  537. * Returns the user with the primary key.
  538. *
  539. * @param userId the primary key of the user
  540. * @return the user with the primary key
  541. * @throws PortalException if a user with the primary key could not be found
  542. or if the current user did not have permission to view the user
  543. * @throws SystemException if a system exception occurred
  544. */
  545. public com.liferay.portal.model.User getUserById(long userId)
  546. throws com.liferay.portal.kernel.exception.PortalException,
  547. com.liferay.portal.kernel.exception.SystemException {
  548. return _userService.getUserById(userId);
  549. }
  550. /**
  551. * Returns the user with the screen name.
  552. *
  553. * @param companyId the primary key of the user's company
  554. * @param screenName the user's screen name
  555. * @return the user with the screen name
  556. * @throws PortalException if a user with the screen name could not be found
  557. or if the current user did not have permission to veiw the user
  558. * @throws SystemException if a system exception occurred
  559. */
  560. public com.liferay.portal.model.User getUserByScreenName(long companyId,
  561. java.lang.String screenName)
  562. throws com.liferay.portal.kernel.exception.PortalException,
  563. com.liferay.portal.kernel.exception.SystemException {
  564. return _userService.getUserByScreenName(companyId, screenName);
  565. }
  566. /**
  567. * Returns the primary key of the user with the email address.
  568. *
  569. * @param companyId the primary key of the user's company
  570. * @param emailAddress the user's email address
  571. * @return the primary key of the user with the email address
  572. * @throws PortalException if a user with the email address could not be
  573. found
  574. * @throws SystemException if a system exception occurred
  575. */
  576. public long getUserIdByEmailAddress(long companyId,
  577. java.lang.String emailAddress)
  578. throws com.liferay.portal.kernel.exception.PortalException,
  579. com.liferay.portal.kernel.exception.SystemException {
  580. return _userService.getUserIdByEmailAddress(companyId, emailAddress);
  581. }
  582. /**
  583. * Returns the primary key of the user with the screen name.
  584. *
  585. * @param companyId the primary key of the user's company
  586. * @param screenName the user's screen name
  587. * @return the primary key of the user with the screen name
  588. * @throws PortalException if a user with the screen name could not be found
  589. * @throws SystemException if a system exception occurred
  590. */
  591. public long getUserIdByScreenName(long companyId,
  592. java.lang.String screenName)
  593. throws com.liferay.portal.kernel.exception.PortalException,
  594. com.liferay.portal.kernel.exception.SystemException {
  595. return _userService.getUserIdByScreenName(companyId, screenName);
  596. }
  597. /**
  598. * Returns <code>true</code> if the user is a member of the group.
  599. *
  600. * @param groupId the primary key of the group
  601. * @param userId the primary key of the user
  602. * @return <code>true</code> if the user is a member of the group;
  603. <code>false</code> otherwise
  604. * @throws SystemException if a system exception occurred
  605. */
  606. public boolean hasGroupUser(long groupId, long userId)
  607. throws com.liferay.portal.kernel.exception.SystemException {
  608. return _userService.hasGroupUser(groupId, userId);
  609. }
  610. /**
  611. * Returns <code>true</code> if the user is a member of the role.
  612. *
  613. * @param roleId the primary key of the role
  614. * @param userId the primary key of the user
  615. * @return <code>true</code> if the user is a member of the role;
  616. <code>false</code> otherwise
  617. * @throws SystemException if a system exception occurred
  618. */
  619. public boolean hasRoleUser(long roleId, long userId)
  620. throws com.liferay.portal.kernel.exception.SystemException {
  621. return _userService.hasRoleUser(roleId, userId);
  622. }
  623. /**
  624. * Returns <code>true</code> if the user has the role with the name,
  625. * optionally through inheritance.
  626. *
  627. * @param companyId the primary key of the role's company
  628. * @param name the name of the role (must be a regular role, not an
  629. organization, site or provider role)
  630. * @param userId the primary key of the user
  631. * @param inherited whether to include roles inherited from organizations,
  632. sites, etc.
  633. * @return <code>true</code> if the user has the role; <code>false</code>
  634. otherwise
  635. * @throws PortalException if a role with the name could not be found
  636. * @throws SystemException if a system exception occurred
  637. */
  638. public boolean hasRoleUser(long companyId, java.lang.String name,
  639. long userId, boolean inherited)
  640. throws com.liferay.portal.kernel.exception.PortalException,
  641. com.liferay.portal.kernel.exception.SystemException {
  642. return _userService.hasRoleUser(companyId, name, userId, inherited);
  643. }
  644. /**
  645. * Sets the users in the role, removing and adding users to the role as
  646. * necessary.
  647. *
  648. * @param roleId the primary key of the role
  649. * @param userIds the primary keys of the users
  650. * @throws PortalException if the current user did not have permission to
  651. assign role members
  652. * @throws SystemException if a system exception occurred
  653. */
  654. public void setRoleUsers(long roleId, long[] userIds)
  655. throws com.liferay.portal.kernel.exception.PortalException,
  656. com.liferay.portal.kernel.exception.SystemException {
  657. _userService.setRoleUsers(roleId, userIds);
  658. }
  659. /**
  660. * Sets the users in the user group, removing and adding users to the user
  661. * group as necessary.
  662. *
  663. * @param userGroupId the primary key of the user group
  664. * @param userIds the primary keys of the users
  665. * @throws PortalException if the current user did not have permission to
  666. assign group members
  667. * @throws SystemException if a system exception occurred
  668. */
  669. public void setUserGroupUsers(long userGroupId, long[] userIds)
  670. throws com.liferay.portal.kernel.exception.PortalException,
  671. com.liferay.portal.kernel.exception.SystemException {
  672. _userService.setUserGroupUsers(userGroupId, userIds);
  673. }
  674. /**
  675. * Removes the users from the group.
  676. *
  677. * @param groupId the primary key of the group
  678. * @param userIds the primary keys of the users
  679. * @throws PortalException if the current user did not have permission to
  680. modify group assignments
  681. * @throws SystemException if a system exception occurred
  682. */
  683. public void unsetGroupUsers(long groupId, long[] userIds,
  684. com.liferay.portal.service.ServiceContext serviceContext)
  685. throws com.liferay.portal.kernel.exception.PortalException,
  686. com.liferay.portal.kernel.exception.SystemException {
  687. _userService.unsetGroupUsers(groupId, userIds, serviceContext);
  688. }
  689. /**
  690. * Removes the users from the organization.
  691. *
  692. * @param organizationId the primary key of the organization
  693. * @param userIds the primary keys of the users
  694. * @throws PortalException if the current user did not have permission to
  695. modify organization assignments
  696. * @throws SystemException if a system exception occurred
  697. */
  698. public void unsetOrganizationUsers(long organizationId, long[] userIds)
  699. throws com.liferay.portal.kernel.exception.PortalException,
  700. com.liferay.portal.kernel.exception.SystemException {
  701. _userService.unsetOrganizationUsers(organizationId, userIds);
  702. }
  703. /**
  704. * Removes the users from the password policy.
  705. *
  706. * @param passwordPolicyId the primary key of the password policy
  707. * @param userIds the primary keys of the users
  708. * @throws PortalException if the current user did not have permission to
  709. modify policy assignments
  710. * @throws SystemException if a system exception occurred
  711. */
  712. public void unsetPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
  713. throws com.liferay.portal.kernel.exception.PortalException,
  714. com.liferay.portal.kernel.exception.SystemException {
  715. _userService.unsetPasswordPolicyUsers(passwordPolicyId, userIds);
  716. }
  717. /**
  718. * Removes the users from the role.
  719. *
  720. * @param roleId the primary key of the role
  721. * @param userIds the primary keys of the users
  722. * @throws PortalException if the current user did not have permission to
  723. modify role assignments
  724. * @throws SystemException if a system exception occurred
  725. */
  726. public void unsetRoleUsers(long roleId, long[] userIds)
  727. throws com.liferay.portal.kernel.exception.PortalException,
  728. com.liferay.portal.kernel.exception.SystemException {
  729. _userService.unsetRoleUsers(roleId, userIds);
  730. }
  731. /**
  732. * Removes the users from the team.
  733. *
  734. * @param teamId the primary key of the team
  735. * @param userIds the primary keys of the users
  736. * @throws PortalException if the current user did not have permission to
  737. modify team assignments
  738. * @throws SystemException if a system exception occurred
  739. */
  740. public void unsetTeamUsers(long teamId, long[] userIds)
  741. throws com.liferay.portal.kernel.exception.PortalException,
  742. com.liferay.portal.kernel.exception.SystemException {
  743. _userService.unsetTeamUsers(teamId, userIds);
  744. }
  745. /**
  746. * Removes the users from the user group.
  747. *
  748. * @param userGroupId the primary key of the user group
  749. * @param userIds the primary keys of the users
  750. * @throws PortalException if the current user did not have permission to
  751. modify user group assignments
  752. * @throws SystemException if a system exception occurred
  753. */
  754. public void unsetUserGroupUsers(long userGroupId, long[] userIds)
  755. throws com.liferay.portal.kernel.exception.PortalException,
  756. com.liferay.portal.kernel.exception.SystemException {
  757. _userService.unsetUserGroupUsers(userGroupId, userIds);
  758. }
  759. /**
  760. * Updates the user's response to the terms of use agreement.
  761. *
  762. * @param userId the primary key of the user
  763. * @param agreedToTermsOfUse whether the user has agree to the terms of use
  764. * @return the user
  765. * @throws PortalException if the current user did not have permission to
  766. update the user's agreement to terms-of-use
  767. * @throws SystemException if a system exception occurred
  768. */
  769. public com.liferay.portal.model.User updateAgreedToTermsOfUse(long userId,
  770. boolean agreedToTermsOfUse)
  771. throws com.liferay.portal.kernel.exception.PortalException,
  772. com.liferay.portal.kernel.exception.SystemException {
  773. return _userService.updateAgreedToTermsOfUse(userId, agreedToTermsOfUse);
  774. }
  775. /**
  776. * Updates the user's email address.
  777. *
  778. * @param userId the primary key of the user
  779. * @param password the user's password
  780. * @param emailAddress1 the user's new email address
  781. * @param emailAddress2 the user's new email address confirmation
  782. * @return the user
  783. * @throws PortalException if a user with the primary key could not be found
  784. or if the current user did not have permission to update the user
  785. * @throws SystemException if a system exception occurred
  786. */
  787. public com.liferay.portal.model.User updateEmailAddress(long userId,
  788. java.lang.String password, java.lang.String emailAddress1,
  789. java.lang.String emailAddress2,
  790. com.liferay.portal.service.ServiceContext serviceContext)
  791. throws com.liferay.portal.kernel.exception.PortalException,
  792. com.liferay.portal.kernel.exception.SystemException {
  793. return _userService.updateEmailAddress(userId, password, emailAddress1,
  794. emailAddress2, serviceContext);
  795. }
  796. /**
  797. * Updates a user account that was automatically created when a guest user
  798. * participated in an action (e.g. posting a comment) and only provided his
  799. * name and email address.
  800. *
  801. * @param companyId the primary key of the user's company
  802. * @param autoPassword whether a password should be automatically generated
  803. for the user
  804. * @param password1 the user's password
  805. * @param password2 the user's password confirmation
  806. * @param autoScreenName whether a screen name should be automatically
  807. generated for the user
  808. * @param screenName the user's screen name
  809. * @param emailAddress the user's email address
  810. * @param facebookId the user's facebook ID
  811. * @param openId the user's OpenID
  812. * @param locale the user's locale
  813. * @param firstName the user's first name
  814. * @param middleName the user's middle name
  815. * @param lastName the user's last name
  816. * @param prefixId the user's name prefix ID
  817. * @param suffixId the user's name suffix ID
  818. * @param male whether the user is male
  819. * @param birthdayMonth the user's birthday month (0-based, meaning 0 for
  820. January)
  821. * @param birthdayDay the user's birthday day
  822. * @param birthdayYear the user's birthday year
  823. * @param jobTitle the user's job title
  824. * @param updateUserInformation whether to update the user's information
  825. * @param sendEmail whether to send the user an email notification about
  826. their new account
  827. * @param serviceContext the user's service context (optionally
  828. <code>null</code>). Can set the expando bridge attributes for the
  829. user.
  830. * @return the user
  831. * @throws PortalException if the user's information was invalid or if the
  832. email address was reserved
  833. * @throws SystemException if a system exception occurred
  834. */
  835. public com.liferay.portal.model.User updateIncompleteUser(long companyId,
  836. boolean autoPassword, java.lang.String password1,
  837. java.lang.String password2, boolean autoScreenName,
  838. java.lang.String screenName, java.lang.String emailAddress,
  839. long facebookId, java.lang.String openId, java.util.Locale locale,
  840. java.lang.String firstName, java.lang.String middleName,
  841. java.lang.String lastName, int prefixId, int suffixId, boolean male,
  842. int birthdayMonth, int birthdayDay, int birthdayYear,
  843. java.lang.String jobTitle, boolean updateUserInformation,
  844. boolean sendEmail,
  845. com.liferay.portal.service.ServiceContext serviceContext)
  846. throws com.liferay.portal.kernel.exception.PortalException,
  847. com.liferay.portal.kernel.exception.SystemException {
  848. return _userService.updateIncompleteUser(companyId, autoPassword,
  849. password1, password2, autoScreenName, screenName, emailAddress,
  850. facebookId, openId, locale, firstName, middleName, lastName,
  851. prefixId, suffixId, male, birthdayMonth, birthdayDay, birthdayYear,
  852. jobTitle, updateUserInformation, sendEmail, serviceContext);
  853. }
  854. /**
  855. * Updates whether the user is locked out from logging in.
  856. *
  857. * @param userId the primary key of the user
  858. * @param lockout whether the user is locked out
  859. * @return the user
  860. * @throws PortalException if the user did not have permission to lock out
  861. the user
  862. * @throws SystemException if a system exception occurred
  863. */
  864. public com.liferay.portal.model.User updateLockoutById(long userId,
  865. boolean lockout)
  866. throws com.liferay.portal.kernel.exception.PortalException,
  867. com.liferay.portal.kernel.exception.SystemException {
  868. return _userService.updateLockoutById(userId, lockout);
  869. }
  870. /**
  871. * Updates the user's OpenID.
  872. *
  873. * @param userId the primary key of the user
  874. * @param openId the new OpenID
  875. * @return the user
  876. * @throws PortalException if a user with the primary key could not be found
  877. or if the current user did not have permission to update the user
  878. * @throws SystemException if a system exception occurred
  879. */
  880. public com.liferay.portal.model.User updateOpenId(long userId,
  881. java.lang.String openId)
  882. throws com.liferay.portal.kernel.exception.PortalException,
  883. com.liferay.portal.kernel.exception.SystemException {
  884. return _userService.updateOpenId(userId, openId);
  885. }
  886. /**
  887. * Sets the organizations that the user is in, removing and adding
  888. * organizations as necessary.
  889. *
  890. * @param userId the primary key of the user
  891. * @param organizationIds the primary keys of the organizations
  892. * @throws PortalException if a user with the primary key could not be found
  893. or if the current user did not have permission to update the user
  894. * @throws SystemException if a system exception occurred
  895. */
  896. public void updateOrganizations(long userId, long[] organizationIds,
  897. com.liferay.portal.service.ServiceContext serviceContext)
  898. throws com.liferay.portal.kernel.exception.PortalException,
  899. com.liferay.portal.kernel.exception.SystemException {
  900. _userService.updateOrganizations(userId, organizationIds, serviceContext);
  901. }
  902. /**
  903. * Updates the user's password without tracking or validation of the change.
  904. *
  905. * @param userId the primary key of the user
  906. * @param password1 the user's new password
  907. * @param password2 the user's new password confirmation
  908. * @param passwordReset whether the user should be asked to reset their
  909. password the next time they log in
  910. * @return the user
  911. * @throws PortalException if a user with the primary key could not be found
  912. or if the current user did not have permission to update the user
  913. * @throws SystemException if a system exception occurred
  914. */
  915. public com.liferay.portal.model.User updatePassword(long userId,
  916. java.lang.String password1, java.lang.String password2,
  917. boolean passwordReset)
  918. throws com.liferay.portal.kernel.exception.PortalException,
  919. com.liferay.portal.kernel.exception.SystemException {
  920. return _userService.updatePassword(userId, password1, password2,
  921. passwordReset);
  922. }
  923. /**
  924. * Updates the user's portrait image.
  925. *
  926. * @param userId the primary key of the user
  927. * @param bytes the new portrait image data
  928. * @return the user
  929. * @throws PortalException if a user with the primary key could not be
  930. found, if the new portrait was invalid, or if the current user
  931. did not have permission to update the user
  932. * @throws SystemException if a system exception occurred
  933. */
  934. public com.liferay.portal.model.User updatePortrait(long userId,
  935. byte[] bytes)
  936. throws com.liferay.portal.kernel.exception.PortalException,
  937. com.liferay.portal.kernel.exception.SystemException {
  938. return _userService.updatePortrait(userId, bytes);
  939. }
  940. /**
  941. * Updates the user's password reset question and answer.
  942. *
  943. * @param userId the primary key of the user
  944. * @param question the user's new password reset question
  945. * @param answer the user's new password reset answer
  946. * @return the user
  947. * @throws PortalException if a user with the primary key could not be
  948. found, if the new question or answer were invalid, or if the
  949. current user did not have permission to update the user
  950. * @throws SystemException if a system exception occurred
  951. */
  952. public com.liferay.portal.model.User updateReminderQuery(long userId,
  953. java.lang.String question, java.lang.String answer)
  954. throws com.liferay.portal.kernel.exception.PortalException,
  955. com.liferay.portal.kernel.exception.SystemException {
  956. return _userService.updateReminderQuery(userId, question, answer);
  957. }
  958. /**
  959. * Updates the user's screen name.
  960. *
  961. * @param userId the primary key of the user
  962. * @param screenName the user's new screen name
  963. * @return the user
  964. * @throws PortalException if a user with the primary key could not be
  965. found, if the new screen name was invalid, or if the current user
  966. did not have permission to update the user
  967. * @throws SystemException if a system exception occurred
  968. */
  969. public com.liferay.portal.model.User updateScreenName(long userId,
  970. java.lang.String screenName)
  971. throws com.liferay.portal.kernel.exception.PortalException,
  972. com.liferay.portal.kernel.exception.SystemException {
  973. return _userService.updateScreenName(userId, screenName);
  974. }
  975. /**
  976. * Updates the user's workflow status.
  977. *
  978. * @param userId the primary key of the user
  979. * @param status the user's new workflow status
  980. * @return the user
  981. * @throws PortalException if a user with the primary key could not be
  982. found, if the current user was updating her own status to
  983. anything but {@link WorkflowConstants.STATUS_APPROVED}, or if the
  984. current user did not have permission to update the user's
  985. workflow status.
  986. * @throws SystemException if a system exception occurred
  987. */
  988. public com.liferay.portal.model.User updateStatus(long userId, int status)
  989. throws com.liferay.portal.kernel.exception.PortalException,
  990. com.liferay.portal.kernel.exception.SystemException {
  991. return _userService.updateStatus(userId, status);
  992. }
  993. /**
  994. * Updates the user with additional parameters.
  995. *
  996. * @param userId the primary key of the user
  997. * @param oldPassword the user's old password
  998. * @param newPassword1 the user's new password (optionally
  999. <code>null</code>)
  1000. * @param newPassword2 the user's new password confirmation (optionally
  1001. <code>null</code>)
  1002. * @param passwordReset whether the user should be asked to reset their
  1003. password the next time they login
  1004. * @param reminderQueryQuestion the user's new password reset question
  1005. * @param reminderQueryAnswer the user's new password reset answer
  1006. * @param screenName the user's new screen name
  1007. * @param emailAddress the user's new email address
  1008. * @param facebookId the user's new Facebook ID
  1009. * @param openId the user's new OpenID
  1010. * @param languageId the user's new language ID
  1011. * @param timeZoneId the user's new time zone ID
  1012. * @param greeting the user's new greeting
  1013. * @param comments the user's new comments
  1014. * @param firstName the user's new first name
  1015. * @param middleName the user's new middle name
  1016. * @param lastName the user's new last name
  1017. * @param prefixId the user's new name prefix ID
  1018. * @param suffixId the user's new name suffix ID
  1019. * @param male whether user is male
  1020. * @param birthdayMonth the user's new birthday month (0-based, meaning 0
  1021. for January)
  1022. * @param birthdayDay the user's new birthday day
  1023. * @param birthdayYear the user's birthday year
  1024. * @param smsSn the user's new SMS screen name
  1025. * @param aimSn the user's new AIM screen name
  1026. * @param facebookSn the user's new Facebook screen name
  1027. * @param icqSn the user's new ICQ screen name
  1028. * @param jabberSn the user's new Jabber screen name
  1029. * @param msnSn the user's new MSN screen name
  1030. * @param mySpaceSn the user's new MySpace screen name
  1031. * @param skypeSn the user's new Skype screen name
  1032. * @param twitterSn the user's new Twitter screen name
  1033. * @param ymSn the user's new Yahoo! Messenger screen name
  1034. * @param jobTitle the user's new job title
  1035. * @param groupIds the primary keys of the user's groups
  1036. * @param organizationIds the primary keys of the user's organizations
  1037. * @param roleIds the primary keys of the user's roles
  1038. * @param userGroupRoles the user user's group roles
  1039. * @param userGroupIds the primary keys of the user's user groups
  1040. * @param addresses the user's addresses
  1041. * @param emailAddresses the user's email addresses
  1042. * @param phones the user's phone numbers
  1043. * @param websites the user's websites
  1044. * @param announcementsDelivers the announcements deliveries
  1045. * @param serviceContext the user's service context (optionally
  1046. <code>null</code>). Can set the universally unique identifier
  1047. (with the <code>uuid</code> attribute), asset category IDs, asset
  1048. tag names, and expando bridge attributes for the user.
  1049. * @return the user
  1050. * @throws PortalException if a user with the primary key could not be
  1051. found, if the new information was invalid, or if the current user
  1052. did not have permission to update the user
  1053. * @throws SystemException if a system exception occurred
  1054. */
  1055. public com.liferay.portal.model.User updateUser(long userId,
  1056. java.lang.String oldPassword, java.lang.String newPassword1,
  1057. java.lang.String newPassword2, boolean passwordReset,
  1058. java.lang.String reminderQueryQuestion,
  1059. java.lang.String reminderQueryAnswer, java.lang.String screenName,
  1060. java.lang.String emailAddress, long facebookId,
  1061. java.lang.String openId, java.lang.String languageId,
  1062. java.lang.String timeZoneId, java.lang.String greeting,
  1063. java.lang.String comments, java.lang.String firstName,
  1064. java.lang.String middleName, java.lang.String lastName, int prefixId,
  1065. int suffixId, boolean male, int birthdayMonth, int birthdayDay,
  1066. int birthdayYear, java.lang.String smsSn, java.lang.String aimSn,
  1067. java.lang.String facebookSn, java.lang.String icqSn,
  1068. java.lang.String jabberSn, java.lang.String msnSn,
  1069. java.lang.String mySpaceSn, java.lang.String skypeSn,
  1070. java.lang.String twitterSn, java.lang.String ymSn,
  1071. java.lang.String jobTitle, long[] groupIds, long[] organizationIds,
  1072. long[] roleIds,
  1073. java.util.List<com.liferay.portal.model.UserGroupRole> userGroupRoles,
  1074. long[] userGroupIds,
  1075. java.util.List<com.liferay.portal.model.Address> addresses,
  1076. java.util.List<com.liferay.portal.model.EmailAddress> emailAddresses,
  1077. java.util.List<com.liferay.portal.model.Phone> phones,
  1078. java.util.List<com.liferay.portal.model.Website> websites,
  1079. java.util.List<com.liferay.portlet.announcements.model.AnnouncementsDelivery> announcementsDelivers,
  1080. com.liferay.portal.service.ServiceContext serviceContext)
  1081. throws com.liferay.portal.kernel.exception.PortalException,
  1082. com.liferay.portal.kernel.exception.SystemException {
  1083. return _userService.updateUser(userId, oldPassword, newPassword1,
  1084. newPassword2, passwordReset, reminderQueryQuestion,
  1085. reminderQueryAnswer, screenName, emailAddress, facebookId, openId,
  1086. languageId, timeZoneId, greeting, comments, firstName, middleName,
  1087. lastName, prefixId, suffixId, male, birthdayMonth, birthdayDay,
  1088. birthdayYear, smsSn, aimSn, facebookSn, icqSn, jabberSn, msnSn,
  1089. mySpaceSn, skypeSn, twitterSn, ymSn, jobTitle, groupIds,
  1090. organizationIds, roleIds, userGroupRoles, userGroupIds, addresses,
  1091. emailAddresses, phones, websites, announcementsDelivers,
  1092. serviceContext);
  1093. }
  1094. /**
  1095. * Updates the user.
  1096. *
  1097. * @param userId the primary key of the user
  1098. * @param oldPassword the user's old password
  1099. * @param newPassword1 the user's new password (optionally
  1100. <code>null</code>)
  1101. * @param newPassword2 the user's new password confirmation (optionally
  1102. <code>null</code>)
  1103. * @param passwordReset whether the user should be asked to reset their
  1104. password the next time they login
  1105. * @param reminderQueryQuestion the user's new password reset question
  1106. * @param reminderQueryAnswer the user's new password reset answer
  1107. * @param screenName the user's new screen name
  1108. * @param emailAddress the user's new email address
  1109. * @param facebookId the user's new Facebook ID
  1110. * @param openId the user's new OpenID
  1111. * @param languageId the user's new language ID
  1112. * @param timeZoneId the user's new time zone ID
  1113. * @param greeting the user's new greeting
  1114. * @param comments the user's new comments
  1115. * @param firstName the user's new first name
  1116. * @param middleName the user's new middle name
  1117. * @param lastName the user's new last name
  1118. * @param prefixId the user's new name prefix ID
  1119. * @param suffixId the user's new name suffix ID
  1120. * @param male whether user is male
  1121. * @param birthdayMonth the user's new birthday month (0-based, meaning 0
  1122. for January)
  1123. * @param birthdayDay the user's new birthday day
  1124. * @param birthdayYear the user's birthday year
  1125. * @param smsSn the user's new SMS screen name
  1126. * @param aimSn the user's new