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.PortalException,
54              com.liferay.portal.SystemException;
55  
56      public void addOrganizationUsers(long organizationId, long[] userIds)
57          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
58              com.liferay.portal.SystemException;
59  
60      public void addPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
61          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
62              com.liferay.portal.SystemException;
63  
64      public void addRoleUsers(long roleId, long[] userIds)
65          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
66              com.liferay.portal.SystemException;
67  
68      public void addUserGroupUsers(long userGroupId, long[] userIds)
69          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
70              com.liferay.portal.SystemException;
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.PortalException,
82              com.liferay.portal.SystemException;
83  
84      public void deleteRoleUser(long roleId, long userId)
85          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
86              com.liferay.portal.SystemException;
87  
88      public void deleteUser(long userId)
89          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
90              com.liferay.portal.SystemException;
91  
92      public long getDefaultUserId(long companyId)
93          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
94              com.liferay.portal.SystemException;
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  
100     public java.util.List<com.liferay.portal.model.User> getRoleUsers(
101         long roleId)
102         throws java.rmi.RemoteException, com.liferay.portal.SystemException;
103 
104     public com.liferay.portal.model.User getUserByEmailAddress(long companyId,
105         java.lang.String emailAddress)
106         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
107             com.liferay.portal.SystemException;
108 
109     public com.liferay.portal.model.User getUserById(long userId)
110         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
111             com.liferay.portal.SystemException;
112 
113     public com.liferay.portal.model.User getUserByScreenName(long companyId,
114         java.lang.String screenName)
115         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
116             com.liferay.portal.SystemException;
117 
118     public long getUserIdByEmailAddress(long companyId,
119         java.lang.String emailAddress)
120         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
121             com.liferay.portal.SystemException;
122 
123     public long getUserIdByScreenName(long companyId,
124         java.lang.String screenName)
125         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
126             com.liferay.portal.SystemException;
127 
128     public boolean hasGroupUser(long groupId, long userId)
129         throws java.rmi.RemoteException, com.liferay.portal.SystemException;
130 
131     public boolean hasRoleUser(long roleId, long userId)
132         throws java.rmi.RemoteException, com.liferay.portal.SystemException;
133 
134     public void setRoleUsers(long roleId, long[] userIds)
135         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
136             com.liferay.portal.SystemException;
137 
138     public void setUserGroupUsers(long userGroupId, long[] userIds)
139         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
140             com.liferay.portal.SystemException;
141 
142     public void unsetGroupUsers(long groupId, long[] userIds)
143         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
144             com.liferay.portal.SystemException;
145 
146     public void unsetOrganizationUsers(long organizationId, long[] userIds)
147         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
148             com.liferay.portal.SystemException;
149 
150     public void unsetPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
151         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
152             com.liferay.portal.SystemException;
153 
154     public void unsetRoleUsers(long roleId, long[] userIds)
155         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
156             com.liferay.portal.SystemException;
157 
158     public void unsetUserGroupUsers(long userGroupId, long[] userIds)
159         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
160             com.liferay.portal.SystemException;
161 
162     public com.liferay.portal.model.User updateActive(long userId,
163         boolean active)
164         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
165             com.liferay.portal.SystemException;
166 
167     public com.liferay.portal.model.User updateAgreedToTermsOfUse(long userId,
168         boolean agreedToTermsOfUse)
169         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
170             com.liferay.portal.SystemException;
171 
172     public com.liferay.portal.model.User updateLockout(long userId,
173         boolean lockout)
174         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
175             com.liferay.portal.SystemException;
176 
177     public void updateOrganizations(long userId, long[] organizationIds)
178         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
179             com.liferay.portal.SystemException;
180 
181     public com.liferay.portal.model.User updatePassword(long userId,
182         java.lang.String password1, java.lang.String password2,
183         boolean passwordReset)
184         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
185             com.liferay.portal.SystemException;
186 
187     public void updatePortrait(long userId, byte[] bytes)
188         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
189             com.liferay.portal.SystemException;
190 
191     public void updateScreenName(long userId, java.lang.String screenName)
192         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
193             com.liferay.portal.SystemException;
194 
195     public void updateOpenId(long userId, java.lang.String openId)
196         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
197             com.liferay.portal.SystemException;
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,
208         java.lang.String facebookSn, java.lang.String icqSn,
209         java.lang.String jabberSn, java.lang.String msnSn,
210         java.lang.String mySpaceSn, java.lang.String skypeSn,
211         java.lang.String twitterSn, java.lang.String ymSn,
212         java.lang.String jobTitle, long[] organizationIds)
213         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
214             com.liferay.portal.SystemException;
215 
216     public com.liferay.portal.model.User updateUser(long userId,
217         java.lang.String oldPassword, java.lang.String newPassword1,
218         java.lang.String newPassword2, boolean passwordReset,
219         java.lang.String screenName, java.lang.String emailAddress,
220         java.lang.String languageId, java.lang.String timeZoneId,
221         java.lang.String greeting, java.lang.String comments,
222         java.lang.String firstName, java.lang.String middleName,
223         java.lang.String lastName, int prefixId, int suffixId, boolean male,
224         int birthdayMonth, int birthdayDay, int birthdayYear,
225         java.lang.String smsSn, java.lang.String aimSn,
226         java.lang.String facebookSn, java.lang.String icqSn,
227         java.lang.String jabberSn, java.lang.String msnSn,
228         java.lang.String mySpaceSn, java.lang.String skypeSn,
229         java.lang.String twitterSn, java.lang.String ymSn,
230         java.lang.String jobTitle, long[] organizationIds)
231         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
232             com.liferay.portal.SystemException;
233 }