001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.service.persistence;
016    
017    import com.liferay.portal.model.UserGroup;
018    
019    /**
020     * The persistence interface for the user group service.
021     *
022     * <p>
023     * Caching information and settings can be found in <code>portal.properties</code>
024     * </p>
025     *
026     * @author Brian Wing Shun Chan
027     * @see UserGroupPersistenceImpl
028     * @see UserGroupUtil
029     * @generated
030     */
031    public interface UserGroupPersistence extends BasePersistence<UserGroup> {
032            /*
033             * NOTE FOR DEVELOPERS:
034             *
035             * Never modify or reference this interface directly. Always use {@link UserGroupUtil} to access the user group persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface.
036             */
037    
038            /**
039            * Caches the user group in the entity cache if it is enabled.
040            *
041            * @param userGroup the user group
042            */
043            public void cacheResult(com.liferay.portal.model.UserGroup userGroup);
044    
045            /**
046            * Caches the user groups in the entity cache if it is enabled.
047            *
048            * @param userGroups the user groups
049            */
050            public void cacheResult(
051                    java.util.List<com.liferay.portal.model.UserGroup> userGroups);
052    
053            /**
054            * Creates a new user group with the primary key. Does not add the user group to the database.
055            *
056            * @param userGroupId the primary key for the new user group
057            * @return the new user group
058            */
059            public com.liferay.portal.model.UserGroup create(long userGroupId);
060    
061            /**
062            * Removes the user group with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param userGroupId the primary key of the user group
065            * @return the user group that was removed
066            * @throws com.liferay.portal.NoSuchUserGroupException if a user group with the primary key could not be found
067            * @throws SystemException if a system exception occurred
068            */
069            public com.liferay.portal.model.UserGroup remove(long userGroupId)
070                    throws com.liferay.portal.NoSuchUserGroupException,
071                            com.liferay.portal.kernel.exception.SystemException;
072    
073            public com.liferay.portal.model.UserGroup updateImpl(
074                    com.liferay.portal.model.UserGroup userGroup, boolean merge)
075                    throws com.liferay.portal.kernel.exception.SystemException;
076    
077            /**
078            * Returns the user group with the primary key or throws a {@link com.liferay.portal.NoSuchUserGroupException} if it could not be found.
079            *
080            * @param userGroupId the primary key of the user group
081            * @return the user group
082            * @throws com.liferay.portal.NoSuchUserGroupException if a user group with the primary key could not be found
083            * @throws SystemException if a system exception occurred
084            */
085            public com.liferay.portal.model.UserGroup findByPrimaryKey(long userGroupId)
086                    throws com.liferay.portal.NoSuchUserGroupException,
087                            com.liferay.portal.kernel.exception.SystemException;
088    
089            /**
090            * Returns the user group with the primary key or returns <code>null</code> if it could not be found.
091            *
092            * @param userGroupId the primary key of the user group
093            * @return the user group, or <code>null</code> if a user group with the primary key could not be found
094            * @throws SystemException if a system exception occurred
095            */
096            public com.liferay.portal.model.UserGroup fetchByPrimaryKey(
097                    long userGroupId)
098                    throws com.liferay.portal.kernel.exception.SystemException;
099    
100            /**
101            * Returns all the user groups where companyId = &#63;.
102            *
103            * @param companyId the company ID
104            * @return the matching user groups
105            * @throws SystemException if a system exception occurred
106            */
107            public java.util.List<com.liferay.portal.model.UserGroup> findByCompanyId(
108                    long companyId)
109                    throws com.liferay.portal.kernel.exception.SystemException;
110    
111            /**
112            * Returns a range of all the user groups where companyId = &#63;.
113            *
114            * <p>
115            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
116            * </p>
117            *
118            * @param companyId the company ID
119            * @param start the lower bound of the range of user groups
120            * @param end the upper bound of the range of user groups (not inclusive)
121            * @return the range of matching user groups
122            * @throws SystemException if a system exception occurred
123            */
124            public java.util.List<com.liferay.portal.model.UserGroup> findByCompanyId(
125                    long companyId, int start, int end)
126                    throws com.liferay.portal.kernel.exception.SystemException;
127    
128            /**
129            * Returns an ordered range of all the user groups where companyId = &#63;.
130            *
131            * <p>
132            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
133            * </p>
134            *
135            * @param companyId the company ID
136            * @param start the lower bound of the range of user groups
137            * @param end the upper bound of the range of user groups (not inclusive)
138            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
139            * @return the ordered range of matching user groups
140            * @throws SystemException if a system exception occurred
141            */
142            public java.util.List<com.liferay.portal.model.UserGroup> findByCompanyId(
143                    long companyId, int start, int end,
144                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
145                    throws com.liferay.portal.kernel.exception.SystemException;
146    
147            /**
148            * Returns the first user group in the ordered set where companyId = &#63;.
149            *
150            * @param companyId the company ID
151            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
152            * @return the first matching user group
153            * @throws com.liferay.portal.NoSuchUserGroupException if a matching user group could not be found
154            * @throws SystemException if a system exception occurred
155            */
156            public com.liferay.portal.model.UserGroup findByCompanyId_First(
157                    long companyId,
158                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
159                    throws com.liferay.portal.NoSuchUserGroupException,
160                            com.liferay.portal.kernel.exception.SystemException;
161    
162            /**
163            * Returns the first user group in the ordered set where companyId = &#63;.
164            *
165            * @param companyId the company ID
166            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
167            * @return the first matching user group, or <code>null</code> if a matching user group could not be found
168            * @throws SystemException if a system exception occurred
169            */
170            public com.liferay.portal.model.UserGroup fetchByCompanyId_First(
171                    long companyId,
172                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
173                    throws com.liferay.portal.kernel.exception.SystemException;
174    
175            /**
176            * Returns the last user group in the ordered set where companyId = &#63;.
177            *
178            * @param companyId the company ID
179            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
180            * @return the last matching user group
181            * @throws com.liferay.portal.NoSuchUserGroupException if a matching user group could not be found
182            * @throws SystemException if a system exception occurred
183            */
184            public com.liferay.portal.model.UserGroup findByCompanyId_Last(
185                    long companyId,
186                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
187                    throws com.liferay.portal.NoSuchUserGroupException,
188                            com.liferay.portal.kernel.exception.SystemException;
189    
190            /**
191            * Returns the last user group in the ordered set where companyId = &#63;.
192            *
193            * @param companyId the company ID
194            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
195            * @return the last matching user group, or <code>null</code> if a matching user group could not be found
196            * @throws SystemException if a system exception occurred
197            */
198            public com.liferay.portal.model.UserGroup fetchByCompanyId_Last(
199                    long companyId,
200                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
201                    throws com.liferay.portal.kernel.exception.SystemException;
202    
203            /**
204            * Returns the user groups before and after the current user group in the ordered set where companyId = &#63;.
205            *
206            * @param userGroupId the primary key of the current user group
207            * @param companyId the company ID
208            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
209            * @return the previous, current, and next user group
210            * @throws com.liferay.portal.NoSuchUserGroupException if a user group with the primary key could not be found
211            * @throws SystemException if a system exception occurred
212            */
213            public com.liferay.portal.model.UserGroup[] findByCompanyId_PrevAndNext(
214                    long userGroupId, long companyId,
215                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
216                    throws com.liferay.portal.NoSuchUserGroupException,
217                            com.liferay.portal.kernel.exception.SystemException;
218    
219            /**
220            * Returns all the user groups that the user has permission to view where companyId = &#63;.
221            *
222            * @param companyId the company ID
223            * @return the matching user groups that the user has permission to view
224            * @throws SystemException if a system exception occurred
225            */
226            public java.util.List<com.liferay.portal.model.UserGroup> filterFindByCompanyId(
227                    long companyId)
228                    throws com.liferay.portal.kernel.exception.SystemException;
229    
230            /**
231            * Returns a range of all the user groups that the user has permission to view where companyId = &#63;.
232            *
233            * <p>
234            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
235            * </p>
236            *
237            * @param companyId the company ID
238            * @param start the lower bound of the range of user groups
239            * @param end the upper bound of the range of user groups (not inclusive)
240            * @return the range of matching user groups that the user has permission to view
241            * @throws SystemException if a system exception occurred
242            */
243            public java.util.List<com.liferay.portal.model.UserGroup> filterFindByCompanyId(
244                    long companyId, int start, int end)
245                    throws com.liferay.portal.kernel.exception.SystemException;
246    
247            /**
248            * Returns an ordered range of all the user groups that the user has permissions to view where companyId = &#63;.
249            *
250            * <p>
251            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
252            * </p>
253            *
254            * @param companyId the company ID
255            * @param start the lower bound of the range of user groups
256            * @param end the upper bound of the range of user groups (not inclusive)
257            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
258            * @return the ordered range of matching user groups that the user has permission to view
259            * @throws SystemException if a system exception occurred
260            */
261            public java.util.List<com.liferay.portal.model.UserGroup> filterFindByCompanyId(
262                    long companyId, int start, int end,
263                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
264                    throws com.liferay.portal.kernel.exception.SystemException;
265    
266            /**
267            * Returns the user groups before and after the current user group in the ordered set of user groups that the user has permission to view where companyId = &#63;.
268            *
269            * @param userGroupId the primary key of the current user group
270            * @param companyId the company ID
271            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
272            * @return the previous, current, and next user group
273            * @throws com.liferay.portal.NoSuchUserGroupException if a user group with the primary key could not be found
274            * @throws SystemException if a system exception occurred
275            */
276            public com.liferay.portal.model.UserGroup[] filterFindByCompanyId_PrevAndNext(
277                    long userGroupId, long companyId,
278                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
279                    throws com.liferay.portal.NoSuchUserGroupException,
280                            com.liferay.portal.kernel.exception.SystemException;
281    
282            /**
283            * Returns all the user groups where companyId = &#63; and parentUserGroupId = &#63;.
284            *
285            * @param companyId the company ID
286            * @param parentUserGroupId the parent user group ID
287            * @return the matching user groups
288            * @throws SystemException if a system exception occurred
289            */
290            public java.util.List<com.liferay.portal.model.UserGroup> findByC_P(
291                    long companyId, long parentUserGroupId)
292                    throws com.liferay.portal.kernel.exception.SystemException;
293    
294            /**
295            * Returns a range of all the user groups where companyId = &#63; and parentUserGroupId = &#63;.
296            *
297            * <p>
298            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
299            * </p>
300            *
301            * @param companyId the company ID
302            * @param parentUserGroupId the parent user group ID
303            * @param start the lower bound of the range of user groups
304            * @param end the upper bound of the range of user groups (not inclusive)
305            * @return the range of matching user groups
306            * @throws SystemException if a system exception occurred
307            */
308            public java.util.List<com.liferay.portal.model.UserGroup> findByC_P(
309                    long companyId, long parentUserGroupId, int start, int end)
310                    throws com.liferay.portal.kernel.exception.SystemException;
311    
312            /**
313            * Returns an ordered range of all the user groups where companyId = &#63; and parentUserGroupId = &#63;.
314            *
315            * <p>
316            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
317            * </p>
318            *
319            * @param companyId the company ID
320            * @param parentUserGroupId the parent user group ID
321            * @param start the lower bound of the range of user groups
322            * @param end the upper bound of the range of user groups (not inclusive)
323            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
324            * @return the ordered range of matching user groups
325            * @throws SystemException if a system exception occurred
326            */
327            public java.util.List<com.liferay.portal.model.UserGroup> findByC_P(
328                    long companyId, long parentUserGroupId, int start, int end,
329                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
330                    throws com.liferay.portal.kernel.exception.SystemException;
331    
332            /**
333            * Returns the first user group in the ordered set where companyId = &#63; and parentUserGroupId = &#63;.
334            *
335            * @param companyId the company ID
336            * @param parentUserGroupId the parent user group ID
337            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
338            * @return the first matching user group
339            * @throws com.liferay.portal.NoSuchUserGroupException if a matching user group could not be found
340            * @throws SystemException if a system exception occurred
341            */
342            public com.liferay.portal.model.UserGroup findByC_P_First(long companyId,
343                    long parentUserGroupId,
344                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
345                    throws com.liferay.portal.NoSuchUserGroupException,
346                            com.liferay.portal.kernel.exception.SystemException;
347    
348            /**
349            * Returns the first user group in the ordered set where companyId = &#63; and parentUserGroupId = &#63;.
350            *
351            * @param companyId the company ID
352            * @param parentUserGroupId the parent user group ID
353            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
354            * @return the first matching user group, or <code>null</code> if a matching user group could not be found
355            * @throws SystemException if a system exception occurred
356            */
357            public com.liferay.portal.model.UserGroup fetchByC_P_First(long companyId,
358                    long parentUserGroupId,
359                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
360                    throws com.liferay.portal.kernel.exception.SystemException;
361    
362            /**
363            * Returns the last user group in the ordered set where companyId = &#63; and parentUserGroupId = &#63;.
364            *
365            * @param companyId the company ID
366            * @param parentUserGroupId the parent user group ID
367            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
368            * @return the last matching user group
369            * @throws com.liferay.portal.NoSuchUserGroupException if a matching user group could not be found
370            * @throws SystemException if a system exception occurred
371            */
372            public com.liferay.portal.model.UserGroup findByC_P_Last(long companyId,
373                    long parentUserGroupId,
374                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
375                    throws com.liferay.portal.NoSuchUserGroupException,
376                            com.liferay.portal.kernel.exception.SystemException;
377    
378            /**
379            * Returns the last user group in the ordered set where companyId = &#63; and parentUserGroupId = &#63;.
380            *
381            * @param companyId the company ID
382            * @param parentUserGroupId the parent user group ID
383            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
384            * @return the last matching user group, or <code>null</code> if a matching user group could not be found
385            * @throws SystemException if a system exception occurred
386            */
387            public com.liferay.portal.model.UserGroup fetchByC_P_Last(long companyId,
388                    long parentUserGroupId,
389                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
390                    throws com.liferay.portal.kernel.exception.SystemException;
391    
392            /**
393            * Returns the user groups before and after the current user group in the ordered set where companyId = &#63; and parentUserGroupId = &#63;.
394            *
395            * @param userGroupId the primary key of the current user group
396            * @param companyId the company ID
397            * @param parentUserGroupId the parent user group ID
398            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
399            * @return the previous, current, and next user group
400            * @throws com.liferay.portal.NoSuchUserGroupException if a user group with the primary key could not be found
401            * @throws SystemException if a system exception occurred
402            */
403            public com.liferay.portal.model.UserGroup[] findByC_P_PrevAndNext(
404                    long userGroupId, long companyId, long parentUserGroupId,
405                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
406                    throws com.liferay.portal.NoSuchUserGroupException,
407                            com.liferay.portal.kernel.exception.SystemException;
408    
409            /**
410            * Returns all the user groups that the user has permission to view where companyId = &#63; and parentUserGroupId = &#63;.
411            *
412            * @param companyId the company ID
413            * @param parentUserGroupId the parent user group ID
414            * @return the matching user groups that the user has permission to view
415            * @throws SystemException if a system exception occurred
416            */
417            public java.util.List<com.liferay.portal.model.UserGroup> filterFindByC_P(
418                    long companyId, long parentUserGroupId)
419                    throws com.liferay.portal.kernel.exception.SystemException;
420    
421            /**
422            * Returns a range of all the user groups that the user has permission to view where companyId = &#63; and parentUserGroupId = &#63;.
423            *
424            * <p>
425            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
426            * </p>
427            *
428            * @param companyId the company ID
429            * @param parentUserGroupId the parent user group ID
430            * @param start the lower bound of the range of user groups
431            * @param end the upper bound of the range of user groups (not inclusive)
432            * @return the range of matching user groups that the user has permission to view
433            * @throws SystemException if a system exception occurred
434            */
435            public java.util.List<com.liferay.portal.model.UserGroup> filterFindByC_P(
436                    long companyId, long parentUserGroupId, int start, int end)
437                    throws com.liferay.portal.kernel.exception.SystemException;
438    
439            /**
440            * Returns an ordered range of all the user groups that the user has permissions to view where companyId = &#63; and parentUserGroupId = &#63;.
441            *
442            * <p>
443            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
444            * </p>
445            *
446            * @param companyId the company ID
447            * @param parentUserGroupId the parent user group ID
448            * @param start the lower bound of the range of user groups
449            * @param end the upper bound of the range of user groups (not inclusive)
450            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
451            * @return the ordered range of matching user groups that the user has permission to view
452            * @throws SystemException if a system exception occurred
453            */
454            public java.util.List<com.liferay.portal.model.UserGroup> filterFindByC_P(
455                    long companyId, long parentUserGroupId, int start, int end,
456                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
457                    throws com.liferay.portal.kernel.exception.SystemException;
458    
459            /**
460            * Returns the user groups before and after the current user group in the ordered set of user groups that the user has permission to view where companyId = &#63; and parentUserGroupId = &#63;.
461            *
462            * @param userGroupId the primary key of the current user group
463            * @param companyId the company ID
464            * @param parentUserGroupId the parent user group ID
465            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
466            * @return the previous, current, and next user group
467            * @throws com.liferay.portal.NoSuchUserGroupException if a user group with the primary key could not be found
468            * @throws SystemException if a system exception occurred
469            */
470            public com.liferay.portal.model.UserGroup[] filterFindByC_P_PrevAndNext(
471                    long userGroupId, long companyId, long parentUserGroupId,
472                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
473                    throws com.liferay.portal.NoSuchUserGroupException,
474                            com.liferay.portal.kernel.exception.SystemException;
475    
476            /**
477            * Returns the user group where companyId = &#63; and name = &#63; or throws a {@link com.liferay.portal.NoSuchUserGroupException} if it could not be found.
478            *
479            * @param companyId the company ID
480            * @param name the name
481            * @return the matching user group
482            * @throws com.liferay.portal.NoSuchUserGroupException if a matching user group could not be found
483            * @throws SystemException if a system exception occurred
484            */
485            public com.liferay.portal.model.UserGroup findByC_N(long companyId,
486                    java.lang.String name)
487                    throws com.liferay.portal.NoSuchUserGroupException,
488                            com.liferay.portal.kernel.exception.SystemException;
489    
490            /**
491            * Returns the user group where companyId = &#63; and name = &#63; or returns <code>null</code> if it could not be found. Uses the finder cache.
492            *
493            * @param companyId the company ID
494            * @param name the name
495            * @return the matching user group, or <code>null</code> if a matching user group could not be found
496            * @throws SystemException if a system exception occurred
497            */
498            public com.liferay.portal.model.UserGroup fetchByC_N(long companyId,
499                    java.lang.String name)
500                    throws com.liferay.portal.kernel.exception.SystemException;
501    
502            /**
503            * Returns the user group where companyId = &#63; and name = &#63; or returns <code>null</code> if it could not be found, optionally using the finder cache.
504            *
505            * @param companyId the company ID
506            * @param name the name
507            * @param retrieveFromCache whether to use the finder cache
508            * @return the matching user group, or <code>null</code> if a matching user group could not be found
509            * @throws SystemException if a system exception occurred
510            */
511            public com.liferay.portal.model.UserGroup fetchByC_N(long companyId,
512                    java.lang.String name, boolean retrieveFromCache)
513                    throws com.liferay.portal.kernel.exception.SystemException;
514    
515            /**
516            * Returns all the user groups.
517            *
518            * @return the user groups
519            * @throws SystemException if a system exception occurred
520            */
521            public java.util.List<com.liferay.portal.model.UserGroup> findAll()
522                    throws com.liferay.portal.kernel.exception.SystemException;
523    
524            /**
525            * Returns a range of all the user groups.
526            *
527            * <p>
528            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
529            * </p>
530            *
531            * @param start the lower bound of the range of user groups
532            * @param end the upper bound of the range of user groups (not inclusive)
533            * @return the range of user groups
534            * @throws SystemException if a system exception occurred
535            */
536            public java.util.List<com.liferay.portal.model.UserGroup> findAll(
537                    int start, int end)
538                    throws com.liferay.portal.kernel.exception.SystemException;
539    
540            /**
541            * Returns an ordered range of all the user groups.
542            *
543            * <p>
544            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
545            * </p>
546            *
547            * @param start the lower bound of the range of user groups
548            * @param end the upper bound of the range of user groups (not inclusive)
549            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
550            * @return the ordered range of user groups
551            * @throws SystemException if a system exception occurred
552            */
553            public java.util.List<com.liferay.portal.model.UserGroup> findAll(
554                    int start, int end,
555                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
556                    throws com.liferay.portal.kernel.exception.SystemException;
557    
558            /**
559            * Removes all the user groups where companyId = &#63; from the database.
560            *
561            * @param companyId the company ID
562            * @throws SystemException if a system exception occurred
563            */
564            public void removeByCompanyId(long companyId)
565                    throws com.liferay.portal.kernel.exception.SystemException;
566    
567            /**
568            * Removes all the user groups where companyId = &#63; and parentUserGroupId = &#63; from the database.
569            *
570            * @param companyId the company ID
571            * @param parentUserGroupId the parent user group ID
572            * @throws SystemException if a system exception occurred
573            */
574            public void removeByC_P(long companyId, long parentUserGroupId)
575                    throws com.liferay.portal.kernel.exception.SystemException;
576    
577            /**
578            * Removes the user group where companyId = &#63; and name = &#63; from the database.
579            *
580            * @param companyId the company ID
581            * @param name the name
582            * @return the user group that was removed
583            * @throws SystemException if a system exception occurred
584            */
585            public com.liferay.portal.model.UserGroup removeByC_N(long companyId,
586                    java.lang.String name)
587                    throws com.liferay.portal.NoSuchUserGroupException,
588                            com.liferay.portal.kernel.exception.SystemException;
589    
590            /**
591            * Removes all the user groups from the database.
592            *
593            * @throws SystemException if a system exception occurred
594            */
595            public void removeAll()
596                    throws com.liferay.portal.kernel.exception.SystemException;
597    
598            /**
599            * Returns the number of user groups where companyId = &#63;.
600            *
601            * @param companyId the company ID
602            * @return the number of matching user groups
603            * @throws SystemException if a system exception occurred
604            */
605            public int countByCompanyId(long companyId)
606                    throws com.liferay.portal.kernel.exception.SystemException;
607    
608            /**
609            * Returns the number of user groups that the user has permission to view where companyId = &#63;.
610            *
611            * @param companyId the company ID
612            * @return the number of matching user groups that the user has permission to view
613            * @throws SystemException if a system exception occurred
614            */
615            public int filterCountByCompanyId(long companyId)
616                    throws com.liferay.portal.kernel.exception.SystemException;
617    
618            /**
619            * Returns the number of user groups where companyId = &#63; and parentUserGroupId = &#63;.
620            *
621            * @param companyId the company ID
622            * @param parentUserGroupId the parent user group ID
623            * @return the number of matching user groups
624            * @throws SystemException if a system exception occurred
625            */
626            public int countByC_P(long companyId, long parentUserGroupId)
627                    throws com.liferay.portal.kernel.exception.SystemException;
628    
629            /**
630            * Returns the number of user groups that the user has permission to view where companyId = &#63; and parentUserGroupId = &#63;.
631            *
632            * @param companyId the company ID
633            * @param parentUserGroupId the parent user group ID
634            * @return the number of matching user groups that the user has permission to view
635            * @throws SystemException if a system exception occurred
636            */
637            public int filterCountByC_P(long companyId, long parentUserGroupId)
638                    throws com.liferay.portal.kernel.exception.SystemException;
639    
640            /**
641            * Returns the number of user groups where companyId = &#63; and name = &#63;.
642            *
643            * @param companyId the company ID
644            * @param name the name
645            * @return the number of matching user groups
646            * @throws SystemException if a system exception occurred
647            */
648            public int countByC_N(long companyId, java.lang.String name)
649                    throws com.liferay.portal.kernel.exception.SystemException;
650    
651            /**
652            * Returns the number of user groups.
653            *
654            * @return the number of user groups
655            * @throws SystemException if a system exception occurred
656            */
657            public int countAll()
658                    throws com.liferay.portal.kernel.exception.SystemException;
659    
660            /**
661            * Returns all the groups associated with the user group.
662            *
663            * @param pk the primary key of the user group
664            * @return the groups associated with the user group
665            * @throws SystemException if a system exception occurred
666            */
667            public java.util.List<com.liferay.portal.model.Group> getGroups(long pk)
668                    throws com.liferay.portal.kernel.exception.SystemException;
669    
670            /**
671            * Returns a range of all the groups associated with the user group.
672            *
673            * <p>
674            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
675            * </p>
676            *
677            * @param pk the primary key of the user group
678            * @param start the lower bound of the range of user groups
679            * @param end the upper bound of the range of user groups (not inclusive)
680            * @return the range of groups associated with the user group
681            * @throws SystemException if a system exception occurred
682            */
683            public java.util.List<com.liferay.portal.model.Group> getGroups(long pk,
684                    int start, int end)
685                    throws com.liferay.portal.kernel.exception.SystemException;
686    
687            /**
688            * Returns an ordered range of all the groups associated with the user group.
689            *
690            * <p>
691            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
692            * </p>
693            *
694            * @param pk the primary key of the user group
695            * @param start the lower bound of the range of user groups
696            * @param end the upper bound of the range of user groups (not inclusive)
697            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
698            * @return the ordered range of groups associated with the user group
699            * @throws SystemException if a system exception occurred
700            */
701            public java.util.List<com.liferay.portal.model.Group> getGroups(long pk,
702                    int start, int end,
703                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
704                    throws com.liferay.portal.kernel.exception.SystemException;
705    
706            /**
707            * Returns the number of groups associated with the user group.
708            *
709            * @param pk the primary key of the user group
710            * @return the number of groups associated with the user group
711            * @throws SystemException if a system exception occurred
712            */
713            public int getGroupsSize(long pk)
714                    throws com.liferay.portal.kernel.exception.SystemException;
715    
716            /**
717            * Returns <code>true</code> if the group is associated with the user group.
718            *
719            * @param pk the primary key of the user group
720            * @param groupPK the primary key of the group
721            * @return <code>true</code> if the group is associated with the user group; <code>false</code> otherwise
722            * @throws SystemException if a system exception occurred
723            */
724            public boolean containsGroup(long pk, long groupPK)
725                    throws com.liferay.portal.kernel.exception.SystemException;
726    
727            /**
728            * Returns <code>true</code> if the user group has any groups associated with it.
729            *
730            * @param pk the primary key of the user group to check for associations with groups
731            * @return <code>true</code> if the user group has any groups associated with it; <code>false</code> otherwise
732            * @throws SystemException if a system exception occurred
733            */
734            public boolean containsGroups(long pk)
735                    throws com.liferay.portal.kernel.exception.SystemException;
736    
737            /**
738            * Adds an association between the user group and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache.
739            *
740            * @param pk the primary key of the user group
741            * @param groupPK the primary key of the group
742            * @throws SystemException if a system exception occurred
743            */
744            public void addGroup(long pk, long groupPK)
745                    throws com.liferay.portal.kernel.exception.SystemException;
746    
747            /**
748            * Adds an association between the user group and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache.
749            *
750            * @param pk the primary key of the user group
751            * @param group the group
752            * @throws SystemException if a system exception occurred
753            */
754            public void addGroup(long pk, com.liferay.portal.model.Group group)
755                    throws com.liferay.portal.kernel.exception.SystemException;
756    
757            /**
758            * Adds an association between the user group and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.
759            *
760            * @param pk the primary key of the user group
761            * @param groupPKs the primary keys of the groups
762            * @throws SystemException if a system exception occurred
763            */
764            public void addGroups(long pk, long[] groupPKs)
765                    throws com.liferay.portal.kernel.exception.SystemException;
766    
767            /**
768            * Adds an association between the user group and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.
769            *
770            * @param pk the primary key of the user group
771            * @param groups the groups
772            * @throws SystemException if a system exception occurred
773            */
774            public void addGroups(long pk,
775                    java.util.List<com.liferay.portal.model.Group> groups)
776                    throws com.liferay.portal.kernel.exception.SystemException;
777    
778            /**
779            * Clears all associations between the user group and its groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.
780            *
781            * @param pk the primary key of the user group to clear the associated groups from
782            * @throws SystemException if a system exception occurred
783            */
784            public void clearGroups(long pk)
785                    throws com.liferay.portal.kernel.exception.SystemException;
786    
787            /**
788            * Removes the association between the user group and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache.
789            *
790            * @param pk the primary key of the user group
791            * @param groupPK the primary key of the group
792            * @throws SystemException if a system exception occurred
793            */
794            public void removeGroup(long pk, long groupPK)
795                    throws com.liferay.portal.kernel.exception.SystemException;
796    
797            /**
798            * Removes the association between the user group and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache.
799            *
800            * @param pk the primary key of the user group
801            * @param group the group
802            * @throws SystemException if a system exception occurred
803            */
804            public void removeGroup(long pk, com.liferay.portal.model.Group group)
805                    throws com.liferay.portal.kernel.exception.SystemException;
806    
807            /**
808            * Removes the association between the user group and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.
809            *
810            * @param pk the primary key of the user group
811            * @param groupPKs the primary keys of the groups
812            * @throws SystemException if a system exception occurred
813            */
814            public void removeGroups(long pk, long[] groupPKs)
815                    throws com.liferay.portal.kernel.exception.SystemException;
816    
817            /**
818            * Removes the association between the user group and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.
819            *
820            * @param pk the primary key of the user group
821            * @param groups the groups
822            * @throws SystemException if a system exception occurred
823            */
824            public void removeGroups(long pk,
825                    java.util.List<com.liferay.portal.model.Group> groups)
826                    throws com.liferay.portal.kernel.exception.SystemException;
827    
828            /**
829            * Sets the groups associated with the user group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.
830            *
831            * @param pk the primary key of the user group
832            * @param groupPKs the primary keys of the groups to be associated with the user group
833            * @throws SystemException if a system exception occurred
834            */
835            public void setGroups(long pk, long[] groupPKs)
836                    throws com.liferay.portal.kernel.exception.SystemException;
837    
838            /**
839            * Sets the groups associated with the user group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.
840            *
841            * @param pk the primary key of the user group
842            * @param groups the groups to be associated with the user group
843            * @throws SystemException if a system exception occurred
844            */
845            public void setGroups(long pk,
846                    java.util.List<com.liferay.portal.model.Group> groups)
847                    throws com.liferay.portal.kernel.exception.SystemException;
848    
849            /**
850            * Returns all the teams associated with the user group.
851            *
852            * @param pk the primary key of the user group
853            * @return the teams associated with the user group
854            * @throws SystemException if a system exception occurred
855            */
856            public java.util.List<com.liferay.portal.model.Team> getTeams(long pk)
857                    throws com.liferay.portal.kernel.exception.SystemException;
858    
859            /**
860            * Returns a range of all the teams associated with the user group.
861            *
862            * <p>
863            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
864            * </p>
865            *
866            * @param pk the primary key of the user group
867            * @param start the lower bound of the range of user groups
868            * @param end the upper bound of the range of user groups (not inclusive)
869            * @return the range of teams associated with the user group
870            * @throws SystemException if a system exception occurred
871            */
872            public java.util.List<com.liferay.portal.model.Team> getTeams(long pk,
873                    int start, int end)
874                    throws com.liferay.portal.kernel.exception.SystemException;
875    
876            /**
877            * Returns an ordered range of all the teams associated with the user group.
878            *
879            * <p>
880            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
881            * </p>
882            *
883            * @param pk the primary key of the user group
884            * @param start the lower bound of the range of user groups
885            * @param end the upper bound of the range of user groups (not inclusive)
886            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
887            * @return the ordered range of teams associated with the user group
888            * @throws SystemException if a system exception occurred
889            */
890            public java.util.List<com.liferay.portal.model.Team> getTeams(long pk,
891                    int start, int end,
892                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
893                    throws com.liferay.portal.kernel.exception.SystemException;
894    
895            /**
896            * Returns the number of teams associated with the user group.
897            *
898            * @param pk the primary key of the user group
899            * @return the number of teams associated with the user group
900            * @throws SystemException if a system exception occurred
901            */
902            public int getTeamsSize(long pk)
903                    throws com.liferay.portal.kernel.exception.SystemException;
904    
905            /**
906            * Returns <code>true</code> if the team is associated with the user group.
907            *
908            * @param pk the primary key of the user group
909            * @param teamPK the primary key of the team
910            * @return <code>true</code> if the team is associated with the user group; <code>false</code> otherwise
911            * @throws SystemException if a system exception occurred
912            */
913            public boolean containsTeam(long pk, long teamPK)
914                    throws com.liferay.portal.kernel.exception.SystemException;
915    
916            /**
917            * Returns <code>true</code> if the user group has any teams associated with it.
918            *
919            * @param pk the primary key of the user group to check for associations with teams
920            * @return <code>true</code> if the user group has any teams associated with it; <code>false</code> otherwise
921            * @throws SystemException if a system exception occurred
922            */
923            public boolean containsTeams(long pk)
924                    throws com.liferay.portal.kernel.exception.SystemException;
925    
926            /**
927            * Adds an association between the user group and the team. Also notifies the appropriate model listeners and clears the mapping table finder cache.
928            *
929            * @param pk the primary key of the user group
930            * @param teamPK the primary key of the team
931            * @throws SystemException if a system exception occurred
932            */
933            public void addTeam(long pk, long teamPK)
934                    throws com.liferay.portal.kernel.exception.SystemException;
935    
936            /**
937            * Adds an association between the user group and the team. Also notifies the appropriate model listeners and clears the mapping table finder cache.
938            *
939            * @param pk the primary key of the user group
940            * @param team the team
941            * @throws SystemException if a system exception occurred
942            */
943            public void addTeam(long pk, com.liferay.portal.model.Team team)
944                    throws com.liferay.portal.kernel.exception.SystemException;
945    
946            /**
947            * Adds an association between the user group and the teams. Also notifies the appropriate model listeners and clears the mapping table finder cache.
948            *
949            * @param pk the primary key of the user group
950            * @param teamPKs the primary keys of the teams
951            * @throws SystemException if a system exception occurred
952            */
953            public void addTeams(long pk, long[] teamPKs)
954                    throws com.liferay.portal.kernel.exception.SystemException;
955    
956            /**
957            * Adds an association between the user group and the teams. Also notifies the appropriate model listeners and clears the mapping table finder cache.
958            *
959            * @param pk the primary key of the user group
960            * @param teams the teams
961            * @throws SystemException if a system exception occurred
962            */
963            public void addTeams(long pk,
964                    java.util.List<com.liferay.portal.model.Team> teams)
965                    throws com.liferay.portal.kernel.exception.SystemException;
966    
967            /**
968            * Clears all associations between the user group and its teams. Also notifies the appropriate model listeners and clears the mapping table finder cache.
969            *
970            * @param pk the primary key of the user group to clear the associated teams from
971            * @throws SystemException if a system exception occurred
972            */
973            public void clearTeams(long pk)
974                    throws com.liferay.portal.kernel.exception.SystemException;
975    
976            /**
977            * Removes the association between the user group and the team. Also notifies the appropriate model listeners and clears the mapping table finder cache.
978            *
979            * @param pk the primary key of the user group
980            * @param teamPK the primary key of the team
981            * @throws SystemException if a system exception occurred
982            */
983            public void removeTeam(long pk, long teamPK)
984                    throws com.liferay.portal.kernel.exception.SystemException;
985    
986            /**
987            * Removes the association between the user group and the team. Also notifies the appropriate model listeners and clears the mapping table finder cache.
988            *
989            * @param pk the primary key of the user group
990            * @param team the team
991            * @throws SystemException if a system exception occurred
992            */
993            public void removeTeam(long pk, com.liferay.portal.model.Team team)
994                    throws com.liferay.portal.kernel.exception.SystemException;
995    
996            /**
997            * Removes the association between the user group and the teams. Also notifies the appropriate model listeners and clears the mapping table finder cache.
998            *
999            * @param pk the primary key of the user group
1000            * @param teamPKs the primary keys of the teams
1001            * @throws SystemException if a system exception occurred
1002            */
1003            public void removeTeams(long pk, long[] teamPKs)
1004                    throws com.liferay.portal.kernel.exception.SystemException;
1005    
1006            /**
1007            * Removes the association between the user group and the teams. Also notifies the appropriate model listeners and clears the mapping table finder cache.
1008            *
1009            * @param pk the primary key of the user group
1010            * @param teams the teams
1011            * @throws SystemException if a system exception occurred
1012            */
1013            public void removeTeams(long pk,
1014                    java.util.List<com.liferay.portal.model.Team> teams)
1015                    throws com.liferay.portal.kernel.exception.SystemException;
1016    
1017            /**
1018            * Sets the teams associated with the user group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.
1019            *
1020            * @param pk the primary key of the user group
1021            * @param teamPKs the primary keys of the teams to be associated with the user group
1022            * @throws SystemException if a system exception occurred
1023            */
1024            public void setTeams(long pk, long[] teamPKs)
1025                    throws com.liferay.portal.kernel.exception.SystemException;
1026    
1027            /**
1028            * Sets the teams associated with the user group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.
1029            *
1030            * @param pk the primary key of the user group
1031            * @param teams the teams to be associated with the user group
1032            * @throws SystemException if a system exception occurred
1033            */
1034            public void setTeams(long pk,
1035                    java.util.List<com.liferay.portal.model.Team> teams)
1036                    throws com.liferay.portal.kernel.exception.SystemException;
1037    
1038            /**
1039            * Returns all the users associated with the user group.
1040            *
1041            * @param pk the primary key of the user group
1042            * @return the users associated with the user group
1043            * @throws SystemException if a system exception occurred
1044            */
1045            public java.util.List<com.liferay.portal.model.User> getUsers(long pk)
1046                    throws com.liferay.portal.kernel.exception.SystemException;
1047    
1048            /**
1049            * Returns a range of all the users associated with the user group.
1050            *
1051            * <p>
1052            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
1053            * </p>
1054            *
1055            * @param pk the primary key of the user group
1056            * @param start the lower bound of the range of user groups
1057            * @param end the upper bound of the range of user groups (not inclusive)
1058            * @return the range of users associated with the user group
1059            * @throws SystemException if a system exception occurred
1060            */
1061            public java.util.List<com.liferay.portal.model.User> getUsers(long pk,
1062                    int start, int end)
1063                    throws com.liferay.portal.kernel.exception.SystemException;
1064    
1065            /**
1066            * Returns an ordered range of all the users associated with the user group.
1067            *
1068            * <p>
1069            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
1070            * </p>
1071            *
1072            * @param pk the primary key of the user group
1073            * @param start the lower bound of the range of user groups
1074            * @param end the upper bound of the range of user groups (not inclusive)
1075            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
1076            * @return the ordered range of users associated with the user group
1077            * @throws SystemException if a system exception occurred
1078            */
1079            public java.util.List<com.liferay.portal.model.User> getUsers(long pk,
1080                    int start, int end,
1081                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
1082                    throws com.liferay.portal.kernel.exception.SystemException;
1083    
1084            /**
1085            * Returns the number of users associated with the user group.
1086            *
1087            * @param pk the primary key of the user group
1088            * @return the number of users associated with the user group
1089            * @throws SystemException if a system exception occurred
1090            */
1091            public int getUsersSize(long pk)
1092                    throws com.liferay.portal.kernel.exception.SystemException;
1093    
1094            /**
1095            * Returns <code>true</code> if the user is associated with the user group.
1096            *
1097            * @param pk the primary key of the user group
1098            * @param userPK the primary key of the user
1099            * @return <code>true</code> if the user is associated with the user group; <code>false</code> otherwise
1100            * @throws SystemException if a system exception occurred
1101            */
1102            public boolean containsUser(long pk, long userPK)
1103                    throws com.liferay.portal.kernel.exception.SystemException;
1104    
1105            /**
1106            * Returns <code>true</code> if the user group has any users associated with it.
1107            *
1108            * @param pk the primary key of the user group to check for associations with users
1109            * @return <code>true</code> if the user group has any users associated with it; <code>false</code> otherwise
1110            * @throws SystemException if a system exception occurred
1111            */
1112            public boolean containsUsers(long pk)
1113                    throws com.liferay.portal.kernel.exception.SystemException;
1114    
1115            /**
1116            * Adds an association between the user group and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.
1117            *
1118            * @param pk the primary key of the user group
1119            * @param userPK the primary key of the user
1120            * @throws SystemException if a system exception occurred
1121            */
1122            public void addUser(long pk, long userPK)
1123                    throws com.liferay.portal.kernel.exception.SystemException;
1124    
1125            /**
1126            * Adds an association between the user group and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.
1127            *
1128            * @param pk the primary key of the user group
1129            * @param user the user
1130            * @throws SystemException if a system exception occurred
1131            */
1132            public void addUser(long pk, com.liferay.portal.model.User user)
1133                    throws com.liferay.portal.kernel.exception.SystemException;
1134    
1135            /**
1136            * Adds an association between the user group and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.
1137            *
1138            * @param pk the primary key of the user group
1139            * @param userPKs the primary keys of the users
1140            * @throws SystemException if a system exception occurred
1141            */
1142            public void addUsers(long pk, long[] userPKs)
1143                    throws com.liferay.portal.kernel.exception.SystemException;
1144    
1145            /**
1146            * Adds an association between the user group and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.
1147            *
1148            * @param pk the primary key of the user group
1149            * @param users the users
1150            * @throws SystemException if a system exception occurred
1151            */
1152            public void addUsers(long pk,
1153                    java.util.List<com.liferay.portal.model.User> users)
1154                    throws com.liferay.portal.kernel.exception.SystemException;
1155    
1156            /**
1157            * Clears all associations between the user group and its users. Also notifies the appropriate model listeners and clears the mapping table finder cache.
1158            *
1159            * @param pk the primary key of the user group to clear the associated users from
1160            * @throws SystemException if a system exception occurred
1161            */
1162            public void clearUsers(long pk)
1163                    throws com.liferay.portal.kernel.exception.SystemException;
1164    
1165            /**
1166            * Removes the association between the user group and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.
1167            *
1168            * @param pk the primary key of the user group
1169            * @param userPK the primary key of the user
1170            * @throws SystemException if a system exception occurred
1171            */
1172            public void removeUser(long pk, long userPK)
1173                    throws com.liferay.portal.kernel.exception.SystemException;
1174    
1175            /**
1176            * Removes the association between the user group and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.
1177            *
1178            * @param pk the primary key of the user group
1179            * @param user the user
1180            * @throws SystemException if a system exception occurred
1181            */
1182            public void removeUser(long pk, com.liferay.portal.model.User user)
1183                    throws com.liferay.portal.kernel.exception.SystemException;
1184    
1185            /**
1186            * Removes the association between the user group and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.
1187            *
1188            * @param pk the primary key of the user group
1189            * @param userPKs the primary keys of the users
1190            * @throws SystemException if a system exception occurred
1191            */
1192            public void removeUsers(long pk, long[] userPKs)
1193                    throws com.liferay.portal.kernel.exception.SystemException;
1194    
1195            /**
1196            * Removes the association between the user group and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.
1197            *
1198            * @param pk the primary key of the user group
1199            * @param users the users
1200            * @throws SystemException if a system exception occurred
1201            */
1202            public void removeUsers(long pk,
1203                    java.util.List<com.liferay.portal.model.User> users)
1204                    throws com.liferay.portal.kernel.exception.SystemException;
1205    
1206            /**
1207            * Sets the users associated with the user group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.
1208            *
1209            * @param pk the primary key of the user group
1210            * @param userPKs the primary keys of the users to be associated with the user group
1211            * @throws SystemException if a system exception occurred
1212            */
1213            public void setUsers(long pk, long[] userPKs)
1214                    throws com.liferay.portal.kernel.exception.SystemException;
1215    
1216            /**
1217            * Sets the users associated with the user group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.
1218            *
1219            * @param pk the primary key of the user group
1220            * @param users the users to be associated with the user group
1221            * @throws SystemException if a system exception occurred
1222            */
1223            public void setUsers(long pk,
1224                    java.util.List<com.liferay.portal.model.User> users)
1225                    throws com.liferay.portal.kernel.exception.SystemException;
1226    }