1   /**
2    * Copyright (c) 2000-2007 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   * <a href="UserService.java.html"><b><i>View Source</i></b></a>
27   *
28   * <p>
29   * ServiceBuilder generated this class. Modifications in this class will be overwritten
30   * the next time is generated.
31   * </p>
32   *
33   * <p>
34   * This interface defines the service. The default implementation is <code>com.liferay.portal.service.impl.UserServiceImpl</code>.
35   * Modify methods in that class and rerun ServiceBuilder to populate this class
36   * and all other generated classes.
37   * </p>
38   *
39   * <p>
40   * This is a remote service. Methods of this service are expected to have security
41   * checks based on the propagated JAAS credentials because this service can be accessed
42   * 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 com.liferay.portal.SystemException, 
54              com.liferay.portal.PortalException, java.rmi.RemoteException;
55  
56      public void addPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
57          throws com.liferay.portal.SystemException, 
58              com.liferay.portal.PortalException, java.rmi.RemoteException;
59  
60      public void addRoleUsers(long roleId, long[] userIds)
61          throws com.liferay.portal.SystemException, 
62              com.liferay.portal.PortalException, java.rmi.RemoteException;
63  
64      public void addUserGroupUsers(long userGroupId, long[] userIds)
65          throws com.liferay.portal.SystemException, 
66              com.liferay.portal.PortalException, java.rmi.RemoteException;
67  
68      public com.liferay.portal.model.User addUser(long companyId,
69          boolean autoPassword, java.lang.String password1,
70          java.lang.String password2, boolean autoScreenName,
71          java.lang.String screenName, java.lang.String emailAddress,
72          java.util.Locale locale, java.lang.String firstName,
73          java.lang.String middleName, java.lang.String lastName, int prefixId,
74          int suffixId, boolean male, int birthdayMonth, int birthdayDay,
75          int birthdayYear, java.lang.String jobTitle, long organizationId,
76          long locationId, boolean sendEmail)
77          throws com.liferay.portal.SystemException, 
78              com.liferay.portal.PortalException, java.rmi.RemoteException;
79  
80      public void deleteRoleUser(long roleId, long userId)
81          throws com.liferay.portal.SystemException, 
82              com.liferay.portal.PortalException, java.rmi.RemoteException;
83  
84      public void deleteUser(long userId)
85          throws com.liferay.portal.SystemException, 
86              com.liferay.portal.PortalException, java.rmi.RemoteException;
87  
88      public long getDefaultUserId(long companyId)
89          throws com.liferay.portal.SystemException, 
90              com.liferay.portal.PortalException, java.rmi.RemoteException;
91  
92      public java.util.List getGroupUsers(long groupId)
93          throws com.liferay.portal.SystemException, 
94              com.liferay.portal.PortalException, java.rmi.RemoteException;
95  
96      public java.util.List getRoleUsers(long roleId)
97          throws com.liferay.portal.SystemException, 
98              com.liferay.portal.PortalException, java.rmi.RemoteException;
99  
100     public com.liferay.portal.model.User getUserByEmailAddress(long companyId,
101         java.lang.String emailAddress)
102         throws com.liferay.portal.SystemException, 
103             com.liferay.portal.PortalException, java.rmi.RemoteException;
104 
105     public com.liferay.portal.model.User getUserById(long userId)
106         throws com.liferay.portal.SystemException, 
107             com.liferay.portal.PortalException, java.rmi.RemoteException;
108 
109     public com.liferay.portal.model.User getUserByScreenName(long companyId,
110         java.lang.String screenName)
111         throws com.liferay.portal.SystemException, 
112             com.liferay.portal.PortalException, java.rmi.RemoteException;
113 
114     public boolean hasGroupUser(long groupId, long userId)
115         throws com.liferay.portal.SystemException, 
116             com.liferay.portal.PortalException, java.rmi.RemoteException;
117 
118     public boolean hasRoleUser(long roleId, long userId)
119         throws com.liferay.portal.SystemException, 
120             com.liferay.portal.PortalException, java.rmi.RemoteException;
121 
122     public void setGroupUsers(long groupId, long[] userIds)
123         throws com.liferay.portal.SystemException, 
124             com.liferay.portal.PortalException, java.rmi.RemoteException;
125 
126     public void setRoleUsers(long roleId, long[] userIds)
127         throws com.liferay.portal.SystemException, 
128             com.liferay.portal.PortalException, java.rmi.RemoteException;
129 
130     public void setUserGroupUsers(long userGroupId, long[] userIds)
131         throws com.liferay.portal.SystemException, 
132             com.liferay.portal.PortalException, java.rmi.RemoteException;
133 
134     public void unsetGroupUsers(long groupId, long[] userIds)
135         throws com.liferay.portal.SystemException, 
136             com.liferay.portal.PortalException, java.rmi.RemoteException;
137 
138     public void unsetPasswordPolicyUsers(long passwordPolicyId, long[] userIds)
139         throws com.liferay.portal.SystemException, 
140             com.liferay.portal.PortalException, java.rmi.RemoteException;
141 
142     public void unsetRoleUsers(long roleId, long[] userIds)
143         throws com.liferay.portal.SystemException, 
144             com.liferay.portal.PortalException, java.rmi.RemoteException;
145 
146     public void unsetUserGroupUsers(long userGroupId, long[] userIds)
147         throws com.liferay.portal.SystemException, 
148             com.liferay.portal.PortalException, java.rmi.RemoteException;
149 
150     public com.liferay.portal.model.User updateActive(long userId,
151         boolean active)
152         throws com.liferay.portal.SystemException, 
153             com.liferay.portal.PortalException, java.rmi.RemoteException;
154 
155     public com.liferay.portal.model.User updateAgreedToTermsOfUse(long userId,
156         boolean agreedToTermsOfUse)
157         throws com.liferay.portal.SystemException, 
158             com.liferay.portal.PortalException, java.rmi.RemoteException;
159 
160     public com.liferay.portal.model.User updateLockout(long userId,
161         boolean lockout)
162         throws com.liferay.portal.SystemException, 
163             com.liferay.portal.PortalException, java.rmi.RemoteException;
164 
165     public void updateOrganizations(long userId, long organizationId,
166         long locationId)
167         throws com.liferay.portal.SystemException, 
168             com.liferay.portal.PortalException, java.rmi.RemoteException;
169 
170     public com.liferay.portal.model.User updatePassword(long userId,
171         java.lang.String password1, java.lang.String password2,
172         boolean passwordReset)
173         throws com.liferay.portal.SystemException, 
174             com.liferay.portal.PortalException, java.rmi.RemoteException;
175 
176     public void updatePortrait(long userId, byte[] bytes)
177         throws com.liferay.portal.SystemException, 
178             com.liferay.portal.PortalException, java.rmi.RemoteException;
179 
180     public com.liferay.portal.model.User updateUser(long userId,
181         java.lang.String password, java.lang.String screenName,
182         java.lang.String emailAddress, java.lang.String languageId,
183         java.lang.String timeZoneId, java.lang.String greeting,
184         java.lang.String comments, java.lang.String firstName,
185         java.lang.String middleName, java.lang.String lastName, int prefixId,
186         int suffixId, boolean male, int birthdayMonth, int birthdayDay,
187         int birthdayYear, java.lang.String smsSn, java.lang.String aimSn,
188         java.lang.String icqSn, java.lang.String jabberSn,
189         java.lang.String msnSn, java.lang.String skypeSn,
190         java.lang.String ymSn, java.lang.String jobTitle, long organizationId,
191         long locationId)
192         throws com.liferay.portal.SystemException, 
193             com.liferay.portal.PortalException, java.rmi.RemoteException;
194 }