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.UserServiceFactory
48   * @see com.liferay.portal.service.UserServiceUtil
49   *
50   */
51  public interface UserService {
52      public void addGroupUsers(long groupId, long[] userIds)
53          throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
54              com.liferay.portal.PortalException;
55  
56      public void addOrganizationUsers(long organizationId, long[] userIds)
57          throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
58              com.liferay.portal.PortalException;
59  
60      public void addPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
61          throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
62              com.liferay.portal.PortalException;
63  
64      public void addRoleUsers(long roleId, long[] userIds)
65          throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
66              com.liferay.portal.PortalException;
67  
68      public void addUserGroupUsers(long userGroupId, long[] userIds)
69          throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
70              com.liferay.portal.PortalException;
71  
72      public com.liferay.portal.model.User addUser(long companyId,
73          boolean autoPassword, java.lang.String password1,
74          java.lang.String password2, boolean autoScreenName,
75          java.lang.String screenName, java.lang.String emailAddress,
76          java.util.Locale locale, java.lang.String firstName,
77          java.lang.String middleName, java.lang.String lastName, int prefixId,
78          int suffixId, boolean male, int birthdayMonth, int birthdayDay,
79          int birthdayYear, java.lang.String jobTitle, long[] organizationIds,
80          boolean sendEmail)
81          throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
82              com.liferay.portal.PortalException;
83  
84      public void deleteRoleUser(long roleId, long userId)
85          throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
86              com.liferay.portal.PortalException;
87  
88      public void deleteUser(long userId)
89          throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
90              com.liferay.portal.PortalException;
91  
92      public long getDefaultUserId(long companyId)
93          throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
94              com.liferay.portal.PortalException;
95  
96      public java.util.List getGroupUsers(long groupId)
97          throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
98              com.liferay.portal.PortalException;
99  
100     public java.util.List getRoleUsers(long roleId)
101         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
102             com.liferay.portal.PortalException;
103 
104     public com.liferay.portal.model.User getUserByEmailAddress(long companyId,
105         java.lang.String emailAddress)
106         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
107             com.liferay.portal.PortalException;
108 
109     public com.liferay.portal.model.User getUserById(long userId)
110         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
111             com.liferay.portal.PortalException;
112 
113     public com.liferay.portal.model.User getUserByScreenName(long companyId,
114         java.lang.String screenName)
115         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
116             com.liferay.portal.PortalException;
117 
118     public long getUserIdByEmailAddress(long companyId,
119         java.lang.String emailAddress)
120         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
121             com.liferay.portal.PortalException;
122 
123     public long getUserIdByScreenName(long companyId,
124         java.lang.String screenName)
125         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
126             com.liferay.portal.PortalException;
127 
128     public boolean hasGroupUser(long groupId, long userId)
129         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
130             com.liferay.portal.PortalException;
131 
132     public boolean hasRoleUser(long roleId, long userId)
133         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
134             com.liferay.portal.PortalException;
135 
136     public void setRoleUsers(long roleId, long[] userIds)
137         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
138             com.liferay.portal.PortalException;
139 
140     public void setUserGroupUsers(long userGroupId, long[] userIds)
141         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
142             com.liferay.portal.PortalException;
143 
144     public void unsetGroupUsers(long groupId, long[] userIds)
145         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
146             com.liferay.portal.PortalException;
147 
148     public void unsetOrganizationUsers(long organizationId, long[] userIds)
149         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
150             com.liferay.portal.PortalException;
151 
152     public void unsetPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
153         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
154             com.liferay.portal.PortalException;
155 
156     public void unsetRoleUsers(long roleId, long[] userIds)
157         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
158             com.liferay.portal.PortalException;
159 
160     public void unsetUserGroupUsers(long userGroupId, long[] userIds)
161         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
162             com.liferay.portal.PortalException;
163 
164     public com.liferay.portal.model.User updateActive(long userId,
165         boolean active)
166         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
167             com.liferay.portal.PortalException;
168 
169     public com.liferay.portal.model.User updateAgreedToTermsOfUse(long userId,
170         boolean agreedToTermsOfUse)
171         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
172             com.liferay.portal.PortalException;
173 
174     public com.liferay.portal.model.User updateLockout(long userId,
175         boolean lockout)
176         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
177             com.liferay.portal.PortalException;
178 
179     public void updateOrganizations(long userId, long[] organizationIds)
180         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
181             com.liferay.portal.PortalException;
182 
183     public com.liferay.portal.model.User updatePassword(long userId,
184         java.lang.String password1, java.lang.String password2,
185         boolean passwordReset)
186         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
187             com.liferay.portal.PortalException;
188 
189     public void updatePortrait(long userId, byte[] bytes)
190         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
191             com.liferay.portal.PortalException;
192 
193     public com.liferay.portal.model.User updateUser(long userId,
194         java.lang.String oldPassword, boolean passwordReset,
195         java.lang.String screenName, java.lang.String emailAddress,
196         java.lang.String languageId, java.lang.String timeZoneId,
197         java.lang.String greeting, java.lang.String comments,
198         java.lang.String firstName, java.lang.String middleName,
199         java.lang.String lastName, int prefixId, int suffixId, boolean male,
200         int birthdayMonth, int birthdayDay, int birthdayYear,
201         java.lang.String smsSn, java.lang.String aimSn, java.lang.String icqSn,
202         java.lang.String jabberSn, java.lang.String msnSn,
203         java.lang.String skypeSn, java.lang.String ymSn,
204         java.lang.String jobTitle, long[] organizationIds)
205         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
206             com.liferay.portal.PortalException;
207 
208     public com.liferay.portal.model.User updateUser(long userId,
209         java.lang.String oldPassword, java.lang.String newPassword1,
210         java.lang.String newPassword2, boolean passwordReset,
211         java.lang.String screenName, java.lang.String emailAddress,
212         java.lang.String languageId, java.lang.String timeZoneId,
213         java.lang.String greeting, java.lang.String comments,
214         java.lang.String firstName, java.lang.String middleName,
215         java.lang.String lastName, int prefixId, int suffixId, boolean male,
216         int birthdayMonth, int birthdayDay, int birthdayYear,
217         java.lang.String smsSn, java.lang.String aimSn, java.lang.String icqSn,
218         java.lang.String jabberSn, java.lang.String msnSn,
219         java.lang.String skypeSn, java.lang.String ymSn,
220         java.lang.String jobTitle, long[] organizationIds)
221         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
222             com.liferay.portal.PortalException;
223 }