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