1   /**
2    * Copyright (c) 2000-2009 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   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
17   * SOFTWARE.
18   */
19  
20  package com.liferay.portal.service.persistence;
21  
22  import com.liferay.portal.PortalException;
23  import com.liferay.portal.SystemException;
24  import com.liferay.portal.kernel.annotation.Propagation;
25  import com.liferay.portal.kernel.annotation.Transactional;
26  
27  /**
28   * <a href="GroupPersistence.java.html"><b><i>View Source</i></b></a>
29   *
30   * @author Brian Wing Shun Chan
31   *
32   */
33  @Transactional(rollbackFor =  {
34      PortalException.class, SystemException.class})
35  public interface GroupPersistence extends BasePersistence {
36      public com.liferay.portal.model.Group create(long groupId);
37  
38      public com.liferay.portal.model.Group remove(long groupId)
39          throws com.liferay.portal.NoSuchGroupException,
40              com.liferay.portal.SystemException;
41  
42      public com.liferay.portal.model.Group remove(
43          com.liferay.portal.model.Group group)
44          throws com.liferay.portal.SystemException;
45  
46      /**
47       * @deprecated Use <code>update(Group group, boolean merge)</code>.
48       */
49      public com.liferay.portal.model.Group update(
50          com.liferay.portal.model.Group group)
51          throws com.liferay.portal.SystemException;
52  
53      /**
54       * Add, update, or merge, the entity. This method also calls the model
55       * listeners to trigger the proper events associated with adding, deleting,
56       * or updating an entity.
57       *
58       * @param        group the entity to add, update, or merge
59       * @param        merge boolean value for whether to merge the entity. The
60       *                default value is false. Setting merge to true is more
61       *                expensive and should only be true when group is
62       *                transient. See LEP-5473 for a detailed discussion of this
63       *                method.
64       * @return        true if the portlet can be displayed via Ajax
65       */
66      public com.liferay.portal.model.Group update(
67          com.liferay.portal.model.Group group, boolean merge)
68          throws com.liferay.portal.SystemException;
69  
70      public com.liferay.portal.model.Group updateImpl(
71          com.liferay.portal.model.Group group, boolean merge)
72          throws com.liferay.portal.SystemException;
73  
74      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
75      public com.liferay.portal.model.Group findByPrimaryKey(long groupId)
76          throws com.liferay.portal.NoSuchGroupException,
77              com.liferay.portal.SystemException;
78  
79      public com.liferay.portal.model.Group fetchByPrimaryKey(long groupId)
80          throws com.liferay.portal.SystemException;
81  
82      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
83      public com.liferay.portal.model.Group findByLiveGroupId(long liveGroupId)
84          throws com.liferay.portal.NoSuchGroupException,
85              com.liferay.portal.SystemException;
86  
87      public com.liferay.portal.model.Group fetchByLiveGroupId(long liveGroupId)
88          throws com.liferay.portal.SystemException;
89  
90      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
91      public com.liferay.portal.model.Group findByC_N(long companyId,
92          java.lang.String name)
93          throws com.liferay.portal.NoSuchGroupException,
94              com.liferay.portal.SystemException;
95  
96      public com.liferay.portal.model.Group fetchByC_N(long companyId,
97          java.lang.String name) throws com.liferay.portal.SystemException;
98  
99      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
100     public com.liferay.portal.model.Group findByC_F(long companyId,
101         java.lang.String friendlyURL)
102         throws com.liferay.portal.NoSuchGroupException,
103             com.liferay.portal.SystemException;
104 
105     public com.liferay.portal.model.Group fetchByC_F(long companyId,
106         java.lang.String friendlyURL) throws com.liferay.portal.SystemException;
107 
108     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
109     public com.liferay.portal.model.Group findByC_C_C(long companyId,
110         long classNameId, long classPK)
111         throws com.liferay.portal.NoSuchGroupException,
112             com.liferay.portal.SystemException;
113 
114     public com.liferay.portal.model.Group fetchByC_C_C(long companyId,
115         long classNameId, long classPK)
116         throws com.liferay.portal.SystemException;
117 
118     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
119     public java.util.List<Object> findWithDynamicQuery(
120         com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
121         throws com.liferay.portal.SystemException;
122 
123     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
124     public java.util.List<Object> findWithDynamicQuery(
125         com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
126         int end) throws com.liferay.portal.SystemException;
127 
128     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
129     public java.util.List<com.liferay.portal.model.Group> findAll()
130         throws com.liferay.portal.SystemException;
131 
132     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
133     public java.util.List<com.liferay.portal.model.Group> findAll(int start,
134         int end) throws com.liferay.portal.SystemException;
135 
136     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
137     public java.util.List<com.liferay.portal.model.Group> findAll(int start,
138         int end, com.liferay.portal.kernel.util.OrderByComparator obc)
139         throws com.liferay.portal.SystemException;
140 
141     public void removeByLiveGroupId(long liveGroupId)
142         throws com.liferay.portal.NoSuchGroupException,
143             com.liferay.portal.SystemException;
144 
145     public void removeByC_N(long companyId, java.lang.String name)
146         throws com.liferay.portal.NoSuchGroupException,
147             com.liferay.portal.SystemException;
148 
149     public void removeByC_F(long companyId, java.lang.String friendlyURL)
150         throws com.liferay.portal.NoSuchGroupException,
151             com.liferay.portal.SystemException;
152 
153     public void removeByC_C_C(long companyId, long classNameId, long classPK)
154         throws com.liferay.portal.NoSuchGroupException,
155             com.liferay.portal.SystemException;
156 
157     public void removeAll() throws com.liferay.portal.SystemException;
158 
159     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
160     public int countByLiveGroupId(long liveGroupId)
161         throws com.liferay.portal.SystemException;
162 
163     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
164     public int countByC_N(long companyId, java.lang.String name)
165         throws com.liferay.portal.SystemException;
166 
167     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
168     public int countByC_F(long companyId, java.lang.String friendlyURL)
169         throws com.liferay.portal.SystemException;
170 
171     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
172     public int countByC_C_C(long companyId, long classNameId, long classPK)
173         throws com.liferay.portal.SystemException;
174 
175     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
176     public int countAll() throws com.liferay.portal.SystemException;
177 
178     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
179     public java.util.List<com.liferay.portal.model.Organization> getOrganizations(
180         long pk) throws com.liferay.portal.SystemException;
181 
182     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
183     public java.util.List<com.liferay.portal.model.Organization> getOrganizations(
184         long pk, int start, int end) throws com.liferay.portal.SystemException;
185 
186     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
187     public java.util.List<com.liferay.portal.model.Organization> getOrganizations(
188         long pk, int start, int end,
189         com.liferay.portal.kernel.util.OrderByComparator obc)
190         throws com.liferay.portal.SystemException;
191 
192     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
193     public int getOrganizationsSize(long pk)
194         throws com.liferay.portal.SystemException;
195 
196     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
197     public boolean containsOrganization(long pk, long organizationPK)
198         throws com.liferay.portal.SystemException;
199 
200     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
201     public boolean containsOrganizations(long pk)
202         throws com.liferay.portal.SystemException;
203 
204     public void addOrganization(long pk, long organizationPK)
205         throws com.liferay.portal.SystemException;
206 
207     public void addOrganization(long pk,
208         com.liferay.portal.model.Organization organization)
209         throws com.liferay.portal.SystemException;
210 
211     public void addOrganizations(long pk, long[] organizationPKs)
212         throws com.liferay.portal.SystemException;
213 
214     public void addOrganizations(long pk,
215         java.util.List<com.liferay.portal.model.Organization> organizations)
216         throws com.liferay.portal.SystemException;
217 
218     public void clearOrganizations(long pk)
219         throws com.liferay.portal.SystemException;
220 
221     public void removeOrganization(long pk, long organizationPK)
222         throws com.liferay.portal.SystemException;
223 
224     public void removeOrganization(long pk,
225         com.liferay.portal.model.Organization organization)
226         throws com.liferay.portal.SystemException;
227 
228     public void removeOrganizations(long pk, long[] organizationPKs)
229         throws com.liferay.portal.SystemException;
230 
231     public void removeOrganizations(long pk,
232         java.util.List<com.liferay.portal.model.Organization> organizations)
233         throws com.liferay.portal.SystemException;
234 
235     public void setOrganizations(long pk, long[] organizationPKs)
236         throws com.liferay.portal.SystemException;
237 
238     public void setOrganizations(long pk,
239         java.util.List<com.liferay.portal.model.Organization> organizations)
240         throws com.liferay.portal.SystemException;
241 
242     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
243     public java.util.List<com.liferay.portal.model.Permission> getPermissions(
244         long pk) throws com.liferay.portal.SystemException;
245 
246     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
247     public java.util.List<com.liferay.portal.model.Permission> getPermissions(
248         long pk, int start, int end) throws com.liferay.portal.SystemException;
249 
250     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
251     public java.util.List<com.liferay.portal.model.Permission> getPermissions(
252         long pk, int start, int end,
253         com.liferay.portal.kernel.util.OrderByComparator obc)
254         throws com.liferay.portal.SystemException;
255 
256     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
257     public int getPermissionsSize(long pk)
258         throws com.liferay.portal.SystemException;
259 
260     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
261     public boolean containsPermission(long pk, long permissionPK)
262         throws com.liferay.portal.SystemException;
263 
264     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
265     public boolean containsPermissions(long pk)
266         throws com.liferay.portal.SystemException;
267 
268     public void addPermission(long pk, long permissionPK)
269         throws com.liferay.portal.SystemException;
270 
271     public void addPermission(long pk,
272         com.liferay.portal.model.Permission permission)
273         throws com.liferay.portal.SystemException;
274 
275     public void addPermissions(long pk, long[] permissionPKs)
276         throws com.liferay.portal.SystemException;
277 
278     public void addPermissions(long pk,
279         java.util.List<com.liferay.portal.model.Permission> permissions)
280         throws com.liferay.portal.SystemException;
281 
282     public void clearPermissions(long pk)
283         throws com.liferay.portal.SystemException;
284 
285     public void removePermission(long pk, long permissionPK)
286         throws com.liferay.portal.SystemException;
287 
288     public void removePermission(long pk,
289         com.liferay.portal.model.Permission permission)
290         throws com.liferay.portal.SystemException;
291 
292     public void removePermissions(long pk, long[] permissionPKs)
293         throws com.liferay.portal.SystemException;
294 
295     public void removePermissions(long pk,
296         java.util.List<com.liferay.portal.model.Permission> permissions)
297         throws com.liferay.portal.SystemException;
298 
299     public void setPermissions(long pk, long[] permissionPKs)
300         throws com.liferay.portal.SystemException;
301 
302     public void setPermissions(long pk,
303         java.util.List<com.liferay.portal.model.Permission> permissions)
304         throws com.liferay.portal.SystemException;
305 
306     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
307     public java.util.List<com.liferay.portal.model.Role> getRoles(long pk)
308         throws com.liferay.portal.SystemException;
309 
310     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
311     public java.util.List<com.liferay.portal.model.Role> getRoles(long pk,
312         int start, int end) throws com.liferay.portal.SystemException;
313 
314     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
315     public java.util.List<com.liferay.portal.model.Role> getRoles(long pk,
316         int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
317         throws com.liferay.portal.SystemException;
318 
319     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
320     public int getRolesSize(long pk) throws com.liferay.portal.SystemException;
321 
322     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
323     public boolean containsRole(long pk, long rolePK)
324         throws com.liferay.portal.SystemException;
325 
326     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
327     public boolean containsRoles(long pk)
328         throws com.liferay.portal.SystemException;
329 
330     public void addRole(long pk, long rolePK)
331         throws com.liferay.portal.SystemException;
332 
333     public void addRole(long pk, com.liferay.portal.model.Role role)
334         throws com.liferay.portal.SystemException;
335 
336     public void addRoles(long pk, long[] rolePKs)
337         throws com.liferay.portal.SystemException;
338 
339     public void addRoles(long pk,
340         java.util.List<com.liferay.portal.model.Role> roles)
341         throws com.liferay.portal.SystemException;
342 
343     public void clearRoles(long pk) throws com.liferay.portal.SystemException;
344 
345     public void removeRole(long pk, long rolePK)
346         throws com.liferay.portal.SystemException;
347 
348     public void removeRole(long pk, com.liferay.portal.model.Role role)
349         throws com.liferay.portal.SystemException;
350 
351     public void removeRoles(long pk, long[] rolePKs)
352         throws com.liferay.portal.SystemException;
353 
354     public void removeRoles(long pk,
355         java.util.List<com.liferay.portal.model.Role> roles)
356         throws com.liferay.portal.SystemException;
357 
358     public void setRoles(long pk, long[] rolePKs)
359         throws com.liferay.portal.SystemException;
360 
361     public void setRoles(long pk,
362         java.util.List<com.liferay.portal.model.Role> roles)
363         throws com.liferay.portal.SystemException;
364 
365     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
366     public java.util.List<com.liferay.portal.model.UserGroup> getUserGroups(
367         long pk) throws com.liferay.portal.SystemException;
368 
369     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
370     public java.util.List<com.liferay.portal.model.UserGroup> getUserGroups(
371         long pk, int start, int end) throws com.liferay.portal.SystemException;
372 
373     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
374     public java.util.List<com.liferay.portal.model.UserGroup> getUserGroups(
375         long pk, int start, int end,
376         com.liferay.portal.kernel.util.OrderByComparator obc)
377         throws com.liferay.portal.SystemException;
378 
379     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
380     public int getUserGroupsSize(long pk)
381         throws com.liferay.portal.SystemException;
382 
383     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
384     public boolean containsUserGroup(long pk, long userGroupPK)
385         throws com.liferay.portal.SystemException;
386 
387     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
388     public boolean containsUserGroups(long pk)
389         throws com.liferay.portal.SystemException;
390 
391     public void addUserGroup(long pk, long userGroupPK)
392         throws com.liferay.portal.SystemException;
393 
394     public void addUserGroup(long pk,
395         com.liferay.portal.model.UserGroup userGroup)
396         throws com.liferay.portal.SystemException;
397 
398     public void addUserGroups(long pk, long[] userGroupPKs)
399         throws com.liferay.portal.SystemException;
400 
401     public void addUserGroups(long pk,
402         java.util.List<com.liferay.portal.model.UserGroup> userGroups)
403         throws com.liferay.portal.SystemException;
404 
405     public void clearUserGroups(long pk)
406         throws com.liferay.portal.SystemException;
407 
408     public void removeUserGroup(long pk, long userGroupPK)
409         throws com.liferay.portal.SystemException;
410 
411     public void removeUserGroup(long pk,
412         com.liferay.portal.model.UserGroup userGroup)
413         throws com.liferay.portal.SystemException;
414 
415     public void removeUserGroups(long pk, long[] userGroupPKs)
416         throws com.liferay.portal.SystemException;
417 
418     public void removeUserGroups(long pk,
419         java.util.List<com.liferay.portal.model.UserGroup> userGroups)
420         throws com.liferay.portal.SystemException;
421 
422     public void setUserGroups(long pk, long[] userGroupPKs)
423         throws com.liferay.portal.SystemException;
424 
425     public void setUserGroups(long pk,
426         java.util.List<com.liferay.portal.model.UserGroup> userGroups)
427         throws com.liferay.portal.SystemException;
428 
429     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
430     public java.util.List<com.liferay.portal.model.User> getUsers(long pk)
431         throws com.liferay.portal.SystemException;
432 
433     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
434     public java.util.List<com.liferay.portal.model.User> getUsers(long pk,
435         int start, int end) throws com.liferay.portal.SystemException;
436 
437     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
438     public java.util.List<com.liferay.portal.model.User> getUsers(long pk,
439         int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
440         throws com.liferay.portal.SystemException;
441 
442     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
443     public int getUsersSize(long pk) throws com.liferay.portal.SystemException;
444 
445     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
446     public boolean containsUser(long pk, long userPK)
447         throws com.liferay.portal.SystemException;
448 
449     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
450     public boolean containsUsers(long pk)
451         throws com.liferay.portal.SystemException;
452 
453     public void addUser(long pk, long userPK)
454         throws com.liferay.portal.SystemException;
455 
456     public void addUser(long pk, com.liferay.portal.model.User user)
457         throws com.liferay.portal.SystemException;
458 
459     public void addUsers(long pk, long[] userPKs)
460         throws com.liferay.portal.SystemException;
461 
462     public void addUsers(long pk,
463         java.util.List<com.liferay.portal.model.User> users)
464         throws com.liferay.portal.SystemException;
465 
466     public void clearUsers(long pk) throws com.liferay.portal.SystemException;
467 
468     public void removeUser(long pk, long userPK)
469         throws com.liferay.portal.SystemException;
470 
471     public void removeUser(long pk, com.liferay.portal.model.User user)
472         throws com.liferay.portal.SystemException;
473 
474     public void removeUsers(long pk, long[] userPKs)
475         throws com.liferay.portal.SystemException;
476 
477     public void removeUsers(long pk,
478         java.util.List<com.liferay.portal.model.User> users)
479         throws com.liferay.portal.SystemException;
480 
481     public void setUsers(long pk, long[] userPKs)
482         throws com.liferay.portal.SystemException;
483 
484     public void setUsers(long pk,
485         java.util.List<com.liferay.portal.model.User> users)
486         throws com.liferay.portal.SystemException;
487 }