1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    *
5    *
6    *
7    * The contents of this file are subject to the terms of the Liferay Enterprise
8    * Subscription License ("License"). You may not use this file except in
9    * compliance with the License. You can obtain a copy of the License by
10   * contacting Liferay, Inc. See the License for the specific language governing
11   * permissions and limitations under the License, including but not limited to
12   * distribution rights 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  import com.liferay.portal.PortalException;
26  import com.liferay.portal.SystemException;
27  import com.liferay.portal.kernel.annotation.Isolation;
28  import com.liferay.portal.kernel.annotation.Propagation;
29  import com.liferay.portal.kernel.annotation.Transactional;
30  
31  /**
32   * <a href="UserService.java.html"><b><i>View Source</i></b></a>
33   *
34   * <p>
35   * ServiceBuilder generated this class. Modifications in this class will be
36   * overwritten the next time is generated.
37   * </p>
38   *
39   * <p>
40   * This interface defines the service. The default implementation is
41   * {@link
42   * com.liferay.portal.service.impl.UserServiceImpl}}.
43   * Modify methods in that class and rerun ServiceBuilder to populate this class
44   * and all other generated classes.
45   * </p>
46   *
47   * <p>
48   * 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.
49   * </p>
50   *
51   * @author    Brian Wing Shun Chan
52   * @see       UserServiceUtil
53   * @generated
54   */
55  @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
56      PortalException.class, SystemException.class})
57  public interface UserService {
58      public void addGroupUsers(long groupId, long[] userIds)
59          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
60              com.liferay.portal.SystemException;
61  
62      public void addOrganizationUsers(long organizationId, long[] userIds)
63          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
64              com.liferay.portal.SystemException;
65  
66      public void addPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
67          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
68              com.liferay.portal.SystemException;
69  
70      public void addRoleUsers(long roleId, long[] userIds)
71          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
72              com.liferay.portal.SystemException;
73  
74      public void addUserGroupUsers(long userGroupId, long[] userIds)
75          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
76              com.liferay.portal.SystemException;
77  
78      public com.liferay.portal.model.User addUser(long companyId,
79          boolean autoPassword, java.lang.String password1,
80          java.lang.String password2, boolean autoScreenName,
81          java.lang.String screenName, java.lang.String emailAddress,
82          java.util.Locale locale, java.lang.String firstName,
83          java.lang.String middleName, java.lang.String lastName, int prefixId,
84          int suffixId, boolean male, int birthdayMonth, int birthdayDay,
85          int birthdayYear, java.lang.String jobTitle, long[] organizationIds,
86          boolean sendEmail)
87          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
88              com.liferay.portal.SystemException;
89  
90      public void deleteRoleUser(long roleId, long userId)
91          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
92              com.liferay.portal.SystemException;
93  
94      public void deleteUser(long userId)
95          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
96              com.liferay.portal.SystemException;
97  
98      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
99      public long getDefaultUserId(long companyId)
100         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
101             com.liferay.portal.SystemException;
102 
103     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
104     public long[] getGroupUserIds(long groupId)
105         throws java.rmi.RemoteException, com.liferay.portal.SystemException;
106 
107     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
108     public long[] getOrganizationUserIds(long organizationId)
109         throws java.rmi.RemoteException, com.liferay.portal.SystemException;
110 
111     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
112     public long[] getRoleUserIds(long roleId)
113         throws java.rmi.RemoteException, com.liferay.portal.SystemException;
114 
115     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
116     public com.liferay.portal.model.User getUserByEmailAddress(long companyId,
117         java.lang.String emailAddress)
118         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
119             com.liferay.portal.SystemException;
120 
121     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
122     public com.liferay.portal.model.User getUserById(long userId)
123         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
124             com.liferay.portal.SystemException;
125 
126     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
127     public com.liferay.portal.model.User getUserByScreenName(long companyId,
128         java.lang.String screenName)
129         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
130             com.liferay.portal.SystemException;
131 
132     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
133     public long getUserIdByEmailAddress(long companyId,
134         java.lang.String emailAddress)
135         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
136             com.liferay.portal.SystemException;
137 
138     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
139     public long getUserIdByScreenName(long companyId,
140         java.lang.String screenName)
141         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
142             com.liferay.portal.SystemException;
143 
144     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
145     public boolean hasGroupUser(long groupId, long userId)
146         throws java.rmi.RemoteException, com.liferay.portal.SystemException;
147 
148     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
149     public boolean hasRoleUser(long roleId, long userId)
150         throws java.rmi.RemoteException, com.liferay.portal.SystemException;
151 
152     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
153     public boolean hasRoleUser(long companyId, java.lang.String name,
154         long userId, boolean inherited)
155         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
156             com.liferay.portal.SystemException;
157 
158     public void setRoleUsers(long roleId, long[] userIds)
159         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
160             com.liferay.portal.SystemException;
161 
162     public void setUserGroupUsers(long userGroupId, long[] userIds)
163         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
164             com.liferay.portal.SystemException;
165 
166     public void unsetGroupUsers(long groupId, long[] userIds)
167         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
168             com.liferay.portal.SystemException;
169 
170     public void unsetOrganizationUsers(long organizationId, long[] userIds)
171         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
172             com.liferay.portal.SystemException;
173 
174     public void unsetPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
175         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
176             com.liferay.portal.SystemException;
177 
178     public void unsetRoleUsers(long roleId, long[] userIds)
179         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
180             com.liferay.portal.SystemException;
181 
182     public void unsetUserGroupUsers(long userGroupId, long[] userIds)
183         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
184             com.liferay.portal.SystemException;
185 
186     public com.liferay.portal.model.User updateActive(long userId,
187         boolean active)
188         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
189             com.liferay.portal.SystemException;
190 
191     public com.liferay.portal.model.User updateAgreedToTermsOfUse(long userId,
192         boolean agreedToTermsOfUse)
193         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
194             com.liferay.portal.SystemException;
195 
196     public com.liferay.portal.model.User updateLockout(long userId,
197         boolean lockout)
198         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
199             com.liferay.portal.SystemException;
200 
201     public void updateOpenId(long userId, java.lang.String openId)
202         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
203             com.liferay.portal.SystemException;
204 
205     public void updateOrganizations(long userId, long[] organizationIds)
206         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
207             com.liferay.portal.SystemException;
208 
209     public com.liferay.portal.model.User updatePassword(long userId,
210         java.lang.String password1, java.lang.String password2,
211         boolean passwordReset)
212         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
213             com.liferay.portal.SystemException;
214 
215     public void updatePortrait(long userId, byte[] bytes)
216         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
217             com.liferay.portal.SystemException;
218 
219     public void updateScreenName(long userId, java.lang.String screenName)
220         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
221             com.liferay.portal.SystemException;
222 
223     public com.liferay.portal.model.User updateUser(long userId,
224         java.lang.String oldPassword, boolean passwordReset,
225         java.lang.String screenName, java.lang.String emailAddress,
226         java.lang.String languageId, java.lang.String timeZoneId,
227         java.lang.String greeting, java.lang.String comments,
228         java.lang.String firstName, java.lang.String middleName,
229         java.lang.String lastName, int prefixId, int suffixId, boolean male,
230         int birthdayMonth, int birthdayDay, int birthdayYear,
231         java.lang.String smsSn, java.lang.String aimSn,
232         java.lang.String facebookSn, java.lang.String icqSn,
233         java.lang.String jabberSn, java.lang.String msnSn,
234         java.lang.String mySpaceSn, java.lang.String skypeSn,
235         java.lang.String twitterSn, java.lang.String ymSn,
236         java.lang.String jobTitle, long[] organizationIds)
237         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
238             com.liferay.portal.SystemException;
239 
240     public com.liferay.portal.model.User updateUser(long userId,
241         java.lang.String oldPassword, java.lang.String newPassword1,
242         java.lang.String newPassword2, boolean passwordReset,
243         java.lang.String screenName, java.lang.String emailAddress,
244         java.lang.String languageId, java.lang.String timeZoneId,
245         java.lang.String greeting, java.lang.String comments,
246         java.lang.String firstName, java.lang.String middleName,
247         java.lang.String lastName, int prefixId, int suffixId, boolean male,
248         int birthdayMonth, int birthdayDay, int birthdayYear,
249         java.lang.String smsSn, java.lang.String aimSn,
250         java.lang.String facebookSn, java.lang.String icqSn,
251         java.lang.String jabberSn, java.lang.String msnSn,
252         java.lang.String mySpaceSn, java.lang.String skypeSn,
253         java.lang.String twitterSn, java.lang.String ymSn,
254         java.lang.String jobTitle, long[] organizationIds)
255         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
256             com.liferay.portal.SystemException;
257 }