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.persistence;
24  
25  import com.liferay.portal.model.User;
26  
27  /**
28   * <a href="UserPersistence.java.html"><b><i>View Source</i></b></a>
29   *
30   * <p>
31   * ServiceBuilder generated this class. Modifications in this class will be
32   * overwritten the next time is generated.
33   * </p>
34   *
35   * @author    Brian Wing Shun Chan
36   * @see       UserPersistenceImpl
37   * @see       UserUtil
38   * @generated
39   */
40  public interface UserPersistence extends BasePersistence<User> {
41      public void cacheResult(com.liferay.portal.model.User user);
42  
43      public void cacheResult(java.util.List<com.liferay.portal.model.User> users);
44  
45      public com.liferay.portal.model.User create(long userId);
46  
47      public com.liferay.portal.model.User remove(long userId)
48          throws com.liferay.portal.NoSuchUserException,
49              com.liferay.portal.SystemException;
50  
51      /**
52       * @deprecated Use {@link BasePersistence#update(com.liferay.portal.model.BaseModel, boolean)}.
53       */
54      public com.liferay.portal.model.User update(
55          com.liferay.portal.model.User user)
56          throws com.liferay.portal.SystemException;
57  
58      public com.liferay.portal.model.User updateImpl(
59          com.liferay.portal.model.User user, boolean merge)
60          throws com.liferay.portal.SystemException;
61  
62      public com.liferay.portal.model.User findByPrimaryKey(long userId)
63          throws com.liferay.portal.NoSuchUserException,
64              com.liferay.portal.SystemException;
65  
66      public com.liferay.portal.model.User fetchByPrimaryKey(long userId)
67          throws com.liferay.portal.SystemException;
68  
69      public java.util.List<com.liferay.portal.model.User> findByUuid(
70          java.lang.String uuid) throws com.liferay.portal.SystemException;
71  
72      public java.util.List<com.liferay.portal.model.User> findByUuid(
73          java.lang.String uuid, int start, int end)
74          throws com.liferay.portal.SystemException;
75  
76      public java.util.List<com.liferay.portal.model.User> findByUuid(
77          java.lang.String uuid, int start, int end,
78          com.liferay.portal.kernel.util.OrderByComparator obc)
79          throws com.liferay.portal.SystemException;
80  
81      public com.liferay.portal.model.User findByUuid_First(
82          java.lang.String uuid,
83          com.liferay.portal.kernel.util.OrderByComparator obc)
84          throws com.liferay.portal.NoSuchUserException,
85              com.liferay.portal.SystemException;
86  
87      public com.liferay.portal.model.User findByUuid_Last(
88          java.lang.String uuid,
89          com.liferay.portal.kernel.util.OrderByComparator obc)
90          throws com.liferay.portal.NoSuchUserException,
91              com.liferay.portal.SystemException;
92  
93      public com.liferay.portal.model.User[] findByUuid_PrevAndNext(long userId,
94          java.lang.String uuid,
95          com.liferay.portal.kernel.util.OrderByComparator obc)
96          throws com.liferay.portal.NoSuchUserException,
97              com.liferay.portal.SystemException;
98  
99      public java.util.List<com.liferay.portal.model.User> findByCompanyId(
100         long companyId) throws com.liferay.portal.SystemException;
101 
102     public java.util.List<com.liferay.portal.model.User> findByCompanyId(
103         long companyId, int start, int end)
104         throws com.liferay.portal.SystemException;
105 
106     public java.util.List<com.liferay.portal.model.User> findByCompanyId(
107         long companyId, int start, int end,
108         com.liferay.portal.kernel.util.OrderByComparator obc)
109         throws com.liferay.portal.SystemException;
110 
111     public com.liferay.portal.model.User findByCompanyId_First(long companyId,
112         com.liferay.portal.kernel.util.OrderByComparator obc)
113         throws com.liferay.portal.NoSuchUserException,
114             com.liferay.portal.SystemException;
115 
116     public com.liferay.portal.model.User findByCompanyId_Last(long companyId,
117         com.liferay.portal.kernel.util.OrderByComparator obc)
118         throws com.liferay.portal.NoSuchUserException,
119             com.liferay.portal.SystemException;
120 
121     public com.liferay.portal.model.User[] findByCompanyId_PrevAndNext(
122         long userId, long companyId,
123         com.liferay.portal.kernel.util.OrderByComparator obc)
124         throws com.liferay.portal.NoSuchUserException,
125             com.liferay.portal.SystemException;
126 
127     public com.liferay.portal.model.User findByContactId(long contactId)
128         throws com.liferay.portal.NoSuchUserException,
129             com.liferay.portal.SystemException;
130 
131     public com.liferay.portal.model.User fetchByContactId(long contactId)
132         throws com.liferay.portal.SystemException;
133 
134     public com.liferay.portal.model.User fetchByContactId(long contactId,
135         boolean retrieveFromCache) throws com.liferay.portal.SystemException;
136 
137     public java.util.List<com.liferay.portal.model.User> findByEmailAddress(
138         java.lang.String emailAddress)
139         throws com.liferay.portal.SystemException;
140 
141     public java.util.List<com.liferay.portal.model.User> findByEmailAddress(
142         java.lang.String emailAddress, int start, int end)
143         throws com.liferay.portal.SystemException;
144 
145     public java.util.List<com.liferay.portal.model.User> findByEmailAddress(
146         java.lang.String emailAddress, int start, int end,
147         com.liferay.portal.kernel.util.OrderByComparator obc)
148         throws com.liferay.portal.SystemException;
149 
150     public com.liferay.portal.model.User findByEmailAddress_First(
151         java.lang.String emailAddress,
152         com.liferay.portal.kernel.util.OrderByComparator obc)
153         throws com.liferay.portal.NoSuchUserException,
154             com.liferay.portal.SystemException;
155 
156     public com.liferay.portal.model.User findByEmailAddress_Last(
157         java.lang.String emailAddress,
158         com.liferay.portal.kernel.util.OrderByComparator obc)
159         throws com.liferay.portal.NoSuchUserException,
160             com.liferay.portal.SystemException;
161 
162     public com.liferay.portal.model.User[] findByEmailAddress_PrevAndNext(
163         long userId, java.lang.String emailAddress,
164         com.liferay.portal.kernel.util.OrderByComparator obc)
165         throws com.liferay.portal.NoSuchUserException,
166             com.liferay.portal.SystemException;
167 
168     public com.liferay.portal.model.User findByOpenId(java.lang.String openId)
169         throws com.liferay.portal.NoSuchUserException,
170             com.liferay.portal.SystemException;
171 
172     public com.liferay.portal.model.User fetchByOpenId(java.lang.String openId)
173         throws com.liferay.portal.SystemException;
174 
175     public com.liferay.portal.model.User fetchByOpenId(
176         java.lang.String openId, boolean retrieveFromCache)
177         throws com.liferay.portal.SystemException;
178 
179     public com.liferay.portal.model.User findByPortraitId(long portraitId)
180         throws com.liferay.portal.NoSuchUserException,
181             com.liferay.portal.SystemException;
182 
183     public com.liferay.portal.model.User fetchByPortraitId(long portraitId)
184         throws com.liferay.portal.SystemException;
185 
186     public com.liferay.portal.model.User fetchByPortraitId(long portraitId,
187         boolean retrieveFromCache) throws com.liferay.portal.SystemException;
188 
189     public com.liferay.portal.model.User findByC_U(long companyId, long userId)
190         throws com.liferay.portal.NoSuchUserException,
191             com.liferay.portal.SystemException;
192 
193     public com.liferay.portal.model.User fetchByC_U(long companyId, long userId)
194         throws com.liferay.portal.SystemException;
195 
196     public com.liferay.portal.model.User fetchByC_U(long companyId,
197         long userId, boolean retrieveFromCache)
198         throws com.liferay.portal.SystemException;
199 
200     public com.liferay.portal.model.User findByC_DU(long companyId,
201         boolean defaultUser)
202         throws com.liferay.portal.NoSuchUserException,
203             com.liferay.portal.SystemException;
204 
205     public com.liferay.portal.model.User fetchByC_DU(long companyId,
206         boolean defaultUser) throws com.liferay.portal.SystemException;
207 
208     public com.liferay.portal.model.User fetchByC_DU(long companyId,
209         boolean defaultUser, boolean retrieveFromCache)
210         throws com.liferay.portal.SystemException;
211 
212     public com.liferay.portal.model.User findByC_SN(long companyId,
213         java.lang.String screenName)
214         throws com.liferay.portal.NoSuchUserException,
215             com.liferay.portal.SystemException;
216 
217     public com.liferay.portal.model.User fetchByC_SN(long companyId,
218         java.lang.String screenName) throws com.liferay.portal.SystemException;
219 
220     public com.liferay.portal.model.User fetchByC_SN(long companyId,
221         java.lang.String screenName, boolean retrieveFromCache)
222         throws com.liferay.portal.SystemException;
223 
224     public com.liferay.portal.model.User findByC_EA(long companyId,
225         java.lang.String emailAddress)
226         throws com.liferay.portal.NoSuchUserException,
227             com.liferay.portal.SystemException;
228 
229     public com.liferay.portal.model.User fetchByC_EA(long companyId,
230         java.lang.String emailAddress)
231         throws com.liferay.portal.SystemException;
232 
233     public com.liferay.portal.model.User fetchByC_EA(long companyId,
234         java.lang.String emailAddress, boolean retrieveFromCache)
235         throws com.liferay.portal.SystemException;
236 
237     public java.util.List<com.liferay.portal.model.User> findAll()
238         throws com.liferay.portal.SystemException;
239 
240     public java.util.List<com.liferay.portal.model.User> findAll(int start,
241         int end) throws com.liferay.portal.SystemException;
242 
243     public java.util.List<com.liferay.portal.model.User> findAll(int start,
244         int end, com.liferay.portal.kernel.util.OrderByComparator obc)
245         throws com.liferay.portal.SystemException;
246 
247     public void removeByUuid(java.lang.String uuid)
248         throws com.liferay.portal.SystemException;
249 
250     public void removeByCompanyId(long companyId)
251         throws com.liferay.portal.SystemException;
252 
253     public void removeByContactId(long contactId)
254         throws com.liferay.portal.NoSuchUserException,
255             com.liferay.portal.SystemException;
256 
257     public void removeByEmailAddress(java.lang.String emailAddress)
258         throws com.liferay.portal.SystemException;
259 
260     public void removeByOpenId(java.lang.String openId)
261         throws com.liferay.portal.NoSuchUserException,
262             com.liferay.portal.SystemException;
263 
264     public void removeByPortraitId(long portraitId)
265         throws com.liferay.portal.NoSuchUserException,
266             com.liferay.portal.SystemException;
267 
268     public void removeByC_U(long companyId, long userId)
269         throws com.liferay.portal.NoSuchUserException,
270             com.liferay.portal.SystemException;
271 
272     public void removeByC_DU(long companyId, boolean defaultUser)
273         throws com.liferay.portal.NoSuchUserException,
274             com.liferay.portal.SystemException;
275 
276     public void removeByC_SN(long companyId, java.lang.String screenName)
277         throws com.liferay.portal.NoSuchUserException,
278             com.liferay.portal.SystemException;
279 
280     public void removeByC_EA(long companyId, java.lang.String emailAddress)
281         throws com.liferay.portal.NoSuchUserException,
282             com.liferay.portal.SystemException;
283 
284     public void removeAll() throws com.liferay.portal.SystemException;
285 
286     public int countByUuid(java.lang.String uuid)
287         throws com.liferay.portal.SystemException;
288 
289     public int countByCompanyId(long companyId)
290         throws com.liferay.portal.SystemException;
291 
292     public int countByContactId(long contactId)
293         throws com.liferay.portal.SystemException;
294 
295     public int countByEmailAddress(java.lang.String emailAddress)
296         throws com.liferay.portal.SystemException;
297 
298     public int countByOpenId(java.lang.String openId)
299         throws com.liferay.portal.SystemException;
300 
301     public int countByPortraitId(long portraitId)
302         throws com.liferay.portal.SystemException;
303 
304     public int countByC_U(long companyId, long userId)
305         throws com.liferay.portal.SystemException;
306 
307     public int countByC_DU(long companyId, boolean defaultUser)
308         throws com.liferay.portal.SystemException;
309 
310     public int countByC_SN(long companyId, java.lang.String screenName)
311         throws com.liferay.portal.SystemException;
312 
313     public int countByC_EA(long companyId, java.lang.String emailAddress)
314         throws com.liferay.portal.SystemException;
315 
316     public int countAll() throws com.liferay.portal.SystemException;
317 
318     public java.util.List<com.liferay.portal.model.Group> getGroups(long pk)
319         throws com.liferay.portal.SystemException;
320 
321     public java.util.List<com.liferay.portal.model.Group> getGroups(long pk,
322         int start, int end) throws com.liferay.portal.SystemException;
323 
324     public java.util.List<com.liferay.portal.model.Group> getGroups(long pk,
325         int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
326         throws com.liferay.portal.SystemException;
327 
328     public int getGroupsSize(long pk) throws com.liferay.portal.SystemException;
329 
330     public boolean containsGroup(long pk, long groupPK)
331         throws com.liferay.portal.SystemException;
332 
333     public boolean containsGroups(long pk)
334         throws com.liferay.portal.SystemException;
335 
336     public void addGroup(long pk, long groupPK)
337         throws com.liferay.portal.SystemException;
338 
339     public void addGroup(long pk, com.liferay.portal.model.Group group)
340         throws com.liferay.portal.SystemException;
341 
342     public void addGroups(long pk, long[] groupPKs)
343         throws com.liferay.portal.SystemException;
344 
345     public void addGroups(long pk,
346         java.util.List<com.liferay.portal.model.Group> groups)
347         throws com.liferay.portal.SystemException;
348 
349     public void clearGroups(long pk) throws com.liferay.portal.SystemException;
350 
351     public void removeGroup(long pk, long groupPK)
352         throws com.liferay.portal.SystemException;
353 
354     public void removeGroup(long pk, com.liferay.portal.model.Group group)
355         throws com.liferay.portal.SystemException;
356 
357     public void removeGroups(long pk, long[] groupPKs)
358         throws com.liferay.portal.SystemException;
359 
360     public void removeGroups(long pk,
361         java.util.List<com.liferay.portal.model.Group> groups)
362         throws com.liferay.portal.SystemException;
363 
364     public void setGroups(long pk, long[] groupPKs)
365         throws com.liferay.portal.SystemException;
366 
367     public void setGroups(long pk,
368         java.util.List<com.liferay.portal.model.Group> groups)
369         throws com.liferay.portal.SystemException;
370 
371     public java.util.List<com.liferay.portal.model.Organization> getOrganizations(
372         long pk) throws com.liferay.portal.SystemException;
373 
374     public java.util.List<com.liferay.portal.model.Organization> getOrganizations(
375         long pk, int start, int end) throws com.liferay.portal.SystemException;
376 
377     public java.util.List<com.liferay.portal.model.Organization> getOrganizations(
378         long pk, int start, int end,
379         com.liferay.portal.kernel.util.OrderByComparator obc)
380         throws com.liferay.portal.SystemException;
381 
382     public int getOrganizationsSize(long pk)
383         throws com.liferay.portal.SystemException;
384 
385     public boolean containsOrganization(long pk, long organizationPK)
386         throws com.liferay.portal.SystemException;
387 
388     public boolean containsOrganizations(long pk)
389         throws com.liferay.portal.SystemException;
390 
391     public void addOrganization(long pk, long organizationPK)
392         throws com.liferay.portal.SystemException;
393 
394     public void addOrganization(long pk,
395         com.liferay.portal.model.Organization organization)
396         throws com.liferay.portal.SystemException;
397 
398     public void addOrganizations(long pk, long[] organizationPKs)
399         throws com.liferay.portal.SystemException;
400 
401     public void addOrganizations(long pk,
402         java.util.List<com.liferay.portal.model.Organization> organizations)
403         throws com.liferay.portal.SystemException;
404 
405     public void clearOrganizations(long pk)
406         throws com.liferay.portal.SystemException;
407 
408     public void removeOrganization(long pk, long organizationPK)
409         throws com.liferay.portal.SystemException;
410 
411     public void removeOrganization(long pk,
412         com.liferay.portal.model.Organization organization)
413         throws com.liferay.portal.SystemException;
414 
415     public void removeOrganizations(long pk, long[] organizationPKs)
416         throws com.liferay.portal.SystemException;
417 
418     public void removeOrganizations(long pk,
419         java.util.List<com.liferay.portal.model.Organization> organizations)
420         throws com.liferay.portal.SystemException;
421 
422     public void setOrganizations(long pk, long[] organizationPKs)
423         throws com.liferay.portal.SystemException;
424 
425     public void setOrganizations(long pk,
426         java.util.List<com.liferay.portal.model.Organization> organizations)
427         throws com.liferay.portal.SystemException;
428 
429     public java.util.List<com.liferay.portal.model.Permission> getPermissions(
430         long pk) throws com.liferay.portal.SystemException;
431 
432     public java.util.List<com.liferay.portal.model.Permission> getPermissions(
433         long pk, int start, int end) throws com.liferay.portal.SystemException;
434 
435     public java.util.List<com.liferay.portal.model.Permission> getPermissions(
436         long pk, int start, int end,
437         com.liferay.portal.kernel.util.OrderByComparator obc)
438         throws com.liferay.portal.SystemException;
439 
440     public int getPermissionsSize(long pk)
441         throws com.liferay.portal.SystemException;
442 
443     public boolean containsPermission(long pk, long permissionPK)
444         throws com.liferay.portal.SystemException;
445 
446     public boolean containsPermissions(long pk)
447         throws com.liferay.portal.SystemException;
448 
449     public void addPermission(long pk, long permissionPK)
450         throws com.liferay.portal.SystemException;
451 
452     public void addPermission(long pk,
453         com.liferay.portal.model.Permission permission)
454         throws com.liferay.portal.SystemException;
455 
456     public void addPermissions(long pk, long[] permissionPKs)
457         throws com.liferay.portal.SystemException;
458 
459     public void addPermissions(long pk,
460         java.util.List<com.liferay.portal.model.Permission> permissions)
461         throws com.liferay.portal.SystemException;
462 
463     public void clearPermissions(long pk)
464         throws com.liferay.portal.SystemException;
465 
466     public void removePermission(long pk, long permissionPK)
467         throws com.liferay.portal.SystemException;
468 
469     public void removePermission(long pk,
470         com.liferay.portal.model.Permission permission)
471         throws com.liferay.portal.SystemException;
472 
473     public void removePermissions(long pk, long[] permissionPKs)
474         throws com.liferay.portal.SystemException;
475 
476     public void removePermissions(long pk,
477         java.util.List<com.liferay.portal.model.Permission> permissions)
478         throws com.liferay.portal.SystemException;
479 
480     public void setPermissions(long pk, long[] permissionPKs)
481         throws com.liferay.portal.SystemException;
482 
483     public void setPermissions(long pk,
484         java.util.List<com.liferay.portal.model.Permission> permissions)
485         throws com.liferay.portal.SystemException;
486 
487     public java.util.List<com.liferay.portal.model.Role> getRoles(long pk)
488         throws com.liferay.portal.SystemException;
489 
490     public java.util.List<com.liferay.portal.model.Role> getRoles(long pk,
491         int start, int end) throws com.liferay.portal.SystemException;
492 
493     public java.util.List<com.liferay.portal.model.Role> getRoles(long pk,
494         int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
495         throws com.liferay.portal.SystemException;
496 
497     public int getRolesSize(long pk) throws com.liferay.portal.SystemException;
498 
499     public boolean containsRole(long pk, long rolePK)
500         throws com.liferay.portal.SystemException;
501 
502     public boolean containsRoles(long pk)
503         throws com.liferay.portal.SystemException;
504 
505     public void addRole(long pk, long rolePK)
506         throws com.liferay.portal.SystemException;
507 
508     public void addRole(long pk, com.liferay.portal.model.Role role)
509         throws com.liferay.portal.SystemException;
510 
511     public void addRoles(long pk, long[] rolePKs)
512         throws com.liferay.portal.SystemException;
513 
514     public void addRoles(long pk,
515         java.util.List<com.liferay.portal.model.Role> roles)
516         throws com.liferay.portal.SystemException;
517 
518     public void clearRoles(long pk) throws com.liferay.portal.SystemException;
519 
520     public void removeRole(long pk, long rolePK)
521         throws com.liferay.portal.SystemException;
522 
523     public void removeRole(long pk, com.liferay.portal.model.Role role)
524         throws com.liferay.portal.SystemException;
525 
526     public void removeRoles(long pk, long[] rolePKs)
527         throws com.liferay.portal.SystemException;
528 
529     public void removeRoles(long pk,
530         java.util.List<com.liferay.portal.model.Role> roles)
531         throws com.liferay.portal.SystemException;
532 
533     public void setRoles(long pk, long[] rolePKs)
534         throws com.liferay.portal.SystemException;
535 
536     public void setRoles(long pk,
537         java.util.List<com.liferay.portal.model.Role> roles)
538         throws com.liferay.portal.SystemException;
539 
540     public java.util.List<com.liferay.portal.model.UserGroup> getUserGroups(
541         long pk) throws com.liferay.portal.SystemException;
542 
543     public java.util.List<com.liferay.portal.model.UserGroup> getUserGroups(
544         long pk, int start, int end) throws com.liferay.portal.SystemException;
545 
546     public java.util.List<com.liferay.portal.model.UserGroup> getUserGroups(
547         long pk, int start, int end,
548         com.liferay.portal.kernel.util.OrderByComparator obc)
549         throws com.liferay.portal.SystemException;
550 
551     public int getUserGroupsSize(long pk)
552         throws com.liferay.portal.SystemException;
553 
554     public boolean containsUserGroup(long pk, long userGroupPK)
555         throws com.liferay.portal.SystemException;
556 
557     public boolean containsUserGroups(long pk)
558         throws com.liferay.portal.SystemException;
559 
560     public void addUserGroup(long pk, long userGroupPK)
561         throws com.liferay.portal.SystemException;
562 
563     public void addUserGroup(long pk,
564         com.liferay.portal.model.UserGroup userGroup)
565         throws com.liferay.portal.SystemException;
566 
567     public void addUserGroups(long pk, long[] userGroupPKs)
568         throws com.liferay.portal.SystemException;
569 
570     public void addUserGroups(long pk,
571         java.util.List<com.liferay.portal.model.UserGroup> userGroups)
572         throws com.liferay.portal.SystemException;
573 
574     public void clearUserGroups(long pk)
575         throws com.liferay.portal.SystemException;
576 
577     public void removeUserGroup(long pk, long userGroupPK)
578         throws com.liferay.portal.SystemException;
579 
580     public void removeUserGroup(long pk,
581         com.liferay.portal.model.UserGroup userGroup)
582         throws com.liferay.portal.SystemException;
583 
584     public void removeUserGroups(long pk, long[] userGroupPKs)
585         throws com.liferay.portal.SystemException;
586 
587     public void removeUserGroups(long pk,
588         java.util.List<com.liferay.portal.model.UserGroup> userGroups)
589         throws com.liferay.portal.SystemException;
590 
591     public void setUserGroups(long pk, long[] userGroupPKs)
592         throws com.liferay.portal.SystemException;
593 
594     public void setUserGroups(long pk,
595         java.util.List<com.liferay.portal.model.UserGroup> userGroups)
596         throws com.liferay.portal.SystemException;
597 }