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<com.liferay.portal.model.User> getGroupUsers(
97          long groupId)
98          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
99              com.liferay.portal.PortalException;
100 
101     public java.util.List<com.liferay.portal.model.User> getRoleUsers(
102         long roleId)
103         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
104             com.liferay.portal.PortalException;
105 
106     public com.liferay.portal.model.User getUserByEmailAddress(long companyId,
107         java.lang.String emailAddress)
108         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
109             com.liferay.portal.PortalException;
110 
111     public com.liferay.portal.model.User getUserById(long userId)
112         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
113             com.liferay.portal.PortalException;
114 
115     public com.liferay.portal.model.User getUserByScreenName(long companyId,
116         java.lang.String screenName)
117         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
118             com.liferay.portal.PortalException;
119 
120     public long getUserIdByEmailAddress(long companyId,
121         java.lang.String emailAddress)
122         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
123             com.liferay.portal.PortalException;
124 
125     public long getUserIdByScreenName(long companyId,
126         java.lang.String screenName)
127         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
128             com.liferay.portal.PortalException;
129 
130     public boolean hasGroupUser(long groupId, long userId)
131         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
132             com.liferay.portal.PortalException;
133 
134     public boolean hasRoleUser(long roleId, long userId)
135         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
136             com.liferay.portal.PortalException;
137 
138     public void setRoleUsers(long roleId, long[] userIds)
139         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
140             com.liferay.portal.PortalException;
141 
142     public void setUserGroupUsers(long userGroupId, long[] userIds)
143         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
144             com.liferay.portal.PortalException;
145 
146     public void unsetGroupUsers(long groupId, long[] userIds)
147         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
148             com.liferay.portal.PortalException;
149 
150     public void unsetOrganizationUsers(long organizationId, long[] userIds)
151         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
152             com.liferay.portal.PortalException;
153 
154     public void unsetPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
155         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
156             com.liferay.portal.PortalException;
157 
158     public void unsetRoleUsers(long roleId, long[] userIds)
159         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
160             com.liferay.portal.PortalException;
161 
162     public void unsetUserGroupUsers(long userGroupId, long[] userIds)
163         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
164             com.liferay.portal.PortalException;
165 
166     public com.liferay.portal.model.User updateActive(long userId,
167         boolean active)
168         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
169             com.liferay.portal.PortalException;
170 
171     public com.liferay.portal.model.User updateAgreedToTermsOfUse(long userId,
172         boolean agreedToTermsOfUse)
173         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
174             com.liferay.portal.PortalException;
175 
176     public com.liferay.portal.model.User updateLockout(long userId,
177         boolean lockout)
178         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
179             com.liferay.portal.PortalException;
180 
181     public void updateOrganizations(long userId, long[] organizationIds)
182         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
183             com.liferay.portal.PortalException;
184 
185     public com.liferay.portal.model.User updatePassword(long userId,
186         java.lang.String password1, java.lang.String password2,
187         boolean passwordReset)
188         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
189             com.liferay.portal.PortalException;
190 
191     public void updatePortrait(long userId, byte[] bytes)
192         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
193             com.liferay.portal.PortalException;
194 
195     public void updateScreenName(long userId, java.lang.String screenName)
196         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
197             com.liferay.portal.PortalException;
198 
199     public com.liferay.portal.model.User updateUser(long userId,
200         java.lang.String oldPassword, boolean passwordReset,
201         java.lang.String screenName, java.lang.String emailAddress,
202         java.lang.String languageId, java.lang.String timeZoneId,
203         java.lang.String greeting, java.lang.String comments,
204         java.lang.String firstName, java.lang.String middleName,
205         java.lang.String lastName, int prefixId, int suffixId, boolean male,
206         int birthdayMonth, int birthdayDay, int birthdayYear,
207         java.lang.String smsSn, java.lang.String aimSn, java.lang.String icqSn,
208         java.lang.String jabberSn, java.lang.String msnSn,
209         java.lang.String skypeSn, java.lang.String ymSn,
210         java.lang.String jobTitle, long[] organizationIds)
211         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
212             com.liferay.portal.PortalException;
213 
214     public com.liferay.portal.model.User updateUser(long userId,
215         java.lang.String oldPassword, java.lang.String newPassword1,
216         java.lang.String newPassword2, boolean passwordReset,
217         java.lang.String screenName, java.lang.String emailAddress,
218         java.lang.String languageId, java.lang.String timeZoneId,
219         java.lang.String greeting, java.lang.String comments,
220         java.lang.String firstName, java.lang.String middleName,
221         java.lang.String lastName, int prefixId, int suffixId, boolean male,
222         int birthdayMonth, int birthdayDay, int birthdayYear,
223         java.lang.String smsSn, java.lang.String aimSn, java.lang.String icqSn,
224         java.lang.String jabberSn, java.lang.String msnSn,
225         java.lang.String skypeSn, java.lang.String ymSn,
226         java.lang.String jobTitle, long[] organizationIds)
227         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
228             com.liferay.portal.PortalException;
229 }