1   /**
2    * Copyright (c) 2000-2008 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.service;
24  
25  
26  /**
27   * <a href="UserService.java.html"><b><i>View Source</i></b></a>
28   *
29   * <p>
30   * ServiceBuilder generated this class. Modifications in this class will be
31   * overwritten the next time is generated.
32   * </p>
33   *
34   * <p>
35   * This interface defines the service. The default implementation is
36   * <code>com.liferay.portal.service.impl.UserServiceImpl</code>.
37   * Modify methods in that class and rerun ServiceBuilder to populate this class
38   * and all other generated classes.
39   * </p>
40   *
41   * <p>
42   * This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
43   * </p>
44   *
45   * @author Brian Wing Shun Chan
46   *
47   * @see com.liferay.portal.service.UserServiceUtil
48   *
49   */
50  public interface UserService {
51      public void addGroupUsers(long groupId, long[] userIds)
52          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
53              com.liferay.portal.SystemException;
54  
55      public void addOrganizationUsers(long organizationId, long[] userIds)
56          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
57              com.liferay.portal.SystemException;
58  
59      public void addPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
60          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
61              com.liferay.portal.SystemException;
62  
63      public void addRoleUsers(long roleId, long[] userIds)
64          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
65              com.liferay.portal.SystemException;
66  
67      public void addUserGroupUsers(long userGroupId, long[] userIds)
68          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
69              com.liferay.portal.SystemException;
70  
71      public com.liferay.portal.model.User addUser(long companyId,
72          boolean autoPassword, java.lang.String password1,
73          java.lang.String password2, boolean autoScreenName,
74          java.lang.String screenName, java.lang.String emailAddress,
75          java.util.Locale locale, java.lang.String firstName,
76          java.lang.String middleName, java.lang.String lastName, int prefixId,
77          int suffixId, boolean male, int birthdayMonth, int birthdayDay,
78          int birthdayYear, java.lang.String jobTitle, long[] organizationIds,
79          boolean sendEmail)
80          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
81              com.liferay.portal.SystemException;
82  
83      public void deleteRoleUser(long roleId, long userId)
84          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
85              com.liferay.portal.SystemException;
86  
87      public void deleteUser(long userId)
88          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
89              com.liferay.portal.SystemException;
90  
91      public long getDefaultUserId(long companyId)
92          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
93              com.liferay.portal.SystemException;
94  
95      public java.util.List<com.liferay.portal.model.User> getGroupUsers(
96          long groupId)
97          throws java.rmi.RemoteException, com.liferay.portal.SystemException;
98  
99      public java.util.List<com.liferay.portal.model.User> getRoleUsers(
100         long roleId)
101         throws java.rmi.RemoteException, com.liferay.portal.SystemException;
102 
103     public com.liferay.portal.model.User getUserByEmailAddress(long companyId,
104         java.lang.String emailAddress)
105         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
106             com.liferay.portal.SystemException;
107 
108     public com.liferay.portal.model.User getUserById(long userId)
109         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
110             com.liferay.portal.SystemException;
111 
112     public com.liferay.portal.model.User getUserByScreenName(long companyId,
113         java.lang.String screenName)
114         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
115             com.liferay.portal.SystemException;
116 
117     public long getUserIdByEmailAddress(long companyId,
118         java.lang.String emailAddress)
119         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
120             com.liferay.portal.SystemException;
121 
122     public long getUserIdByScreenName(long companyId,
123         java.lang.String screenName)
124         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
125             com.liferay.portal.SystemException;
126 
127     public boolean hasGroupUser(long groupId, long userId)
128         throws java.rmi.RemoteException, com.liferay.portal.SystemException;
129 
130     public boolean hasRoleUser(long roleId, long userId)
131         throws java.rmi.RemoteException, com.liferay.portal.SystemException;
132 
133     public void setRoleUsers(long roleId, long[] userIds)
134         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
135             com.liferay.portal.SystemException;
136 
137     public void setUserGroupUsers(long userGroupId, long[] userIds)
138         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
139             com.liferay.portal.SystemException;
140 
141     public void unsetGroupUsers(long groupId, long[] userIds)
142         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
143             com.liferay.portal.SystemException;
144 
145     public void unsetOrganizationUsers(long organizationId, long[] userIds)
146         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
147             com.liferay.portal.SystemException;
148 
149     public void unsetPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
150         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
151             com.liferay.portal.SystemException;
152 
153     public void unsetRoleUsers(long roleId, long[] userIds)
154         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
155             com.liferay.portal.SystemException;
156 
157     public void unsetUserGroupUsers(long userGroupId, long[] userIds)
158         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
159             com.liferay.portal.SystemException;
160 
161     public com.liferay.portal.model.User updateActive(long userId,
162         boolean active)
163         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
164             com.liferay.portal.SystemException;
165 
166     public com.liferay.portal.model.User updateAgreedToTermsOfUse(long userId,
167         boolean agreedToTermsOfUse)
168         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
169             com.liferay.portal.SystemException;
170 
171     public com.liferay.portal.model.User updateLockout(long userId,
172         boolean lockout)
173         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
174             com.liferay.portal.SystemException;
175 
176     public void updateOrganizations(long userId, long[] organizationIds)
177         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
178             com.liferay.portal.SystemException;
179 
180     public com.liferay.portal.model.User updatePassword(long userId,
181         java.lang.String password1, java.lang.String password2,
182         boolean passwordReset)
183         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
184             com.liferay.portal.SystemException;
185 
186     public void updatePortrait(long userId, byte[] bytes)
187         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
188             com.liferay.portal.SystemException;
189 
190     public void updateScreenName(long userId, java.lang.String screenName)
191         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
192             com.liferay.portal.SystemException;
193 
194     public void updateOpenId(long userId, java.lang.String openId)
195         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
196             com.liferay.portal.SystemException;
197 
198     public com.liferay.portal.model.User updateUser(long userId,
199         java.lang.String oldPassword, boolean passwordReset,
200         java.lang.String screenName, java.lang.String emailAddress,
201         java.lang.String languageId, java.lang.String timeZoneId,
202         java.lang.String greeting, java.lang.String comments,
203         java.lang.String firstName, java.lang.String middleName,
204         java.lang.String lastName, int prefixId, int suffixId, boolean male,
205         int birthdayMonth, int birthdayDay, int birthdayYear,
206         java.lang.String smsSn, java.lang.String aimSn,
207         java.lang.String facebookSn, java.lang.String icqSn,
208         java.lang.String jabberSn, java.lang.String msnSn,
209         java.lang.String mySpaceSn, java.lang.String skypeSn,
210         java.lang.String twitterSn, java.lang.String ymSn,
211         java.lang.String jobTitle, long[] organizationIds)
212         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
213             com.liferay.portal.SystemException;
214 
215     public com.liferay.portal.model.User updateUser(long userId,
216         java.lang.String oldPassword, java.lang.String newPassword1,
217         java.lang.String newPassword2, boolean passwordReset,
218         java.lang.String screenName, java.lang.String emailAddress,
219         java.lang.String languageId, java.lang.String timeZoneId,
220         java.lang.String greeting, java.lang.String comments,
221         java.lang.String firstName, java.lang.String middleName,
222         java.lang.String lastName, int prefixId, int suffixId, boolean male,
223         int birthdayMonth, int birthdayDay, int birthdayYear,
224         java.lang.String smsSn, java.lang.String aimSn,
225         java.lang.String facebookSn, java.lang.String icqSn,
226         java.lang.String jabberSn, java.lang.String msnSn,
227         java.lang.String mySpaceSn, java.lang.String skypeSn,
228         java.lang.String twitterSn, java.lang.String ymSn,
229         java.lang.String jobTitle, long[] organizationIds)
230         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
231             com.liferay.portal.SystemException;
232 }