001    /**
002     * Copyright (c) 2000-2012 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            * <p>
151            * 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.
152            * </p>
153            *
154            * @param companyId the company ID
155            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
156            * @return the first matching user group
157            * @throws com.liferay.portal.NoSuchUserGroupException if a matching user group could not be found
158            * @throws SystemException if a system exception occurred
159            */
160            public com.liferay.portal.model.UserGroup findByCompanyId_First(
161                    long companyId,
162                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
163                    throws com.liferay.portal.NoSuchUserGroupException,
164                            com.liferay.portal.kernel.exception.SystemException;
165    
166            /**
167            * Returns the last user group in the ordered set where companyId = &#63;.
168            *
169            * <p>
170            * 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.
171            * </p>
172            *
173            * @param companyId the company ID
174            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
175            * @return the last matching user group
176            * @throws com.liferay.portal.NoSuchUserGroupException if a matching user group could not be found
177            * @throws SystemException if a system exception occurred
178            */
179            public com.liferay.portal.model.UserGroup findByCompanyId_Last(
180                    long companyId,
181                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
182                    throws com.liferay.portal.NoSuchUserGroupException,
183                            com.liferay.portal.kernel.exception.SystemException;
184    
185            /**
186            * Returns the user groups before and after the current user group in the ordered set where companyId = &#63;.
187            *
188            * <p>
189            * 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.
190            * </p>
191            *
192            * @param userGroupId the primary key of the current user group
193            * @param companyId the company ID
194            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
195            * @return the previous, current, and next user group
196            * @throws com.liferay.portal.NoSuchUserGroupException if a user group with the primary key could not be found
197            * @throws SystemException if a system exception occurred
198            */
199            public com.liferay.portal.model.UserGroup[] findByCompanyId_PrevAndNext(
200                    long userGroupId, long companyId,
201                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
202                    throws com.liferay.portal.NoSuchUserGroupException,
203                            com.liferay.portal.kernel.exception.SystemException;
204    
205            /**
206            * Returns all the user groups that the user has permission to view where companyId = &#63;.
207            *
208            * @param companyId the company ID
209            * @return the matching user groups that the user has permission to view
210            * @throws SystemException if a system exception occurred
211            */
212            public java.util.List<com.liferay.portal.model.UserGroup> filterFindByCompanyId(
213                    long companyId)
214                    throws com.liferay.portal.kernel.exception.SystemException;
215    
216            /**
217            * Returns a range of all the user groups that the user has permission to view where companyId = &#63;.
218            *
219            * <p>
220            * 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.
221            * </p>
222            *
223            * @param companyId the company ID
224            * @param start the lower bound of the range of user groups
225            * @param end the upper bound of the range of user groups (not inclusive)
226            * @return the range of matching user groups that the user has permission to view
227            * @throws SystemException if a system exception occurred
228            */
229            public java.util.List<com.liferay.portal.model.UserGroup> filterFindByCompanyId(
230                    long companyId, int start, int end)
231                    throws com.liferay.portal.kernel.exception.SystemException;
232    
233            /**
234            * Returns an ordered range of all the user groups that the user has permissions to view where companyId = &#63;.
235            *
236            * <p>
237            * 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.
238            * </p>
239            *
240            * @param companyId the company ID
241            * @param start the lower bound of the range of user groups
242            * @param end the upper bound of the range of user groups (not inclusive)
243            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
244            * @return the ordered range of matching user groups that the user has permission to view
245            * @throws SystemException if a system exception occurred
246            */
247            public java.util.List<com.liferay.portal.model.UserGroup> filterFindByCompanyId(
248                    long companyId, int start, int end,
249                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
250                    throws com.liferay.portal.kernel.exception.SystemException;
251    
252            /**
253            * 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;.
254            *
255            * @param userGroupId the primary key of the current user group
256            * @param companyId the company ID
257            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
258            * @return the previous, current, and next user group
259            * @throws com.liferay.portal.NoSuchUserGroupException if a user group with the primary key could not be found
260            * @throws SystemException if a system exception occurred
261            */
262            public com.liferay.portal.model.UserGroup[] filterFindByCompanyId_PrevAndNext(
263                    long userGroupId, long companyId,
264                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
265                    throws com.liferay.portal.NoSuchUserGroupException,
266                            com.liferay.portal.kernel.exception.SystemException;
267    
268            /**
269            * Returns all the user groups where companyId = &#63; and parentUserGroupId = &#63;.
270            *
271            * @param companyId the company ID
272            * @param parentUserGroupId the parent user group ID
273            * @return the matching user groups
274            * @throws SystemException if a system exception occurred
275            */
276            public java.util.List<com.liferay.portal.model.UserGroup> findByC_P(
277                    long companyId, long parentUserGroupId)
278                    throws com.liferay.portal.kernel.exception.SystemException;
279    
280            /**
281            * Returns a range of all the user groups where companyId = &#63; and parentUserGroupId = &#63;.
282            *
283            * <p>
284            * 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.
285            * </p>
286            *
287            * @param companyId the company ID
288            * @param parentUserGroupId the parent user group ID
289            * @param start the lower bound of the range of user groups
290            * @param end the upper bound of the range of user groups (not inclusive)
291            * @return the range of matching user groups
292            * @throws SystemException if a system exception occurred
293            */
294            public java.util.List<com.liferay.portal.model.UserGroup> findByC_P(
295                    long companyId, long parentUserGroupId, int start, int end)
296                    throws com.liferay.portal.kernel.exception.SystemException;
297    
298            /**
299            * Returns an ordered range of all the user groups where companyId = &#63; and parentUserGroupId = &#63;.
300            *
301            * <p>
302            * 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.
303            * </p>
304            *
305            * @param companyId the company ID
306            * @param parentUserGroupId the parent user group ID
307            * @param start the lower bound of the range of user groups
308            * @param end the upper bound of the range of user groups (not inclusive)
309            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
310            * @return the ordered range of matching user groups
311            * @throws SystemException if a system exception occurred
312            */
313            public java.util.List<com.liferay.portal.model.UserGroup> findByC_P(
314                    long companyId, long parentUserGroupId, int start, int end,
315                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
316                    throws com.liferay.portal.kernel.exception.SystemException;
317    
318            /**
319            * Returns the first user group in the ordered set where companyId = &#63; and parentUserGroupId = &#63;.
320            *
321            * <p>
322            * 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.
323            * </p>
324            *
325            * @param companyId the company ID
326            * @param parentUserGroupId the parent user group ID
327            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
328            * @return the first matching user group
329            * @throws com.liferay.portal.NoSuchUserGroupException if a matching user group could not be found
330            * @throws SystemException if a system exception occurred
331            */
332            public com.liferay.portal.model.UserGroup findByC_P_First(long companyId,
333                    long parentUserGroupId,
334                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
335                    throws com.liferay.portal.NoSuchUserGroupException,
336                            com.liferay.portal.kernel.exception.SystemException;
337    
338            /**
339            * Returns the last user group in the ordered set where companyId = &#63; and parentUserGroupId = &#63;.
340            *
341            * <p>
342            * 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.
343            * </p>
344            *
345            * @param companyId the company ID
346            * @param parentUserGroupId the parent user group ID
347            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
348            * @return the last matching user group
349            * @throws com.liferay.portal.NoSuchUserGroupException if a matching user group could not be found
350            * @throws SystemException if a system exception occurred
351            */
352            public com.liferay.portal.model.UserGroup findByC_P_Last(long companyId,
353                    long parentUserGroupId,
354                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
355                    throws com.liferay.portal.NoSuchUserGroupException,
356                            com.liferay.portal.kernel.exception.SystemException;
357    
358            /**
359            * Returns the user groups before and after the current user group in the ordered set where companyId = &#63; and parentUserGroupId = &#63;.
360            *
361            * <p>
362            * 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.
363            * </p>
364            *
365            * @param userGroupId the primary key of the current user group
366            * @param companyId the company ID
367            * @param parentUserGroupId the parent user group ID
368            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
369            * @return the previous, current, and next user group
370            * @throws com.liferay.portal.NoSuchUserGroupException if a user group with the primary key could not be found
371            * @throws SystemException if a system exception occurred
372            */
373            public com.liferay.portal.model.UserGroup[] findByC_P_PrevAndNext(
374                    long userGroupId, long companyId, long parentUserGroupId,
375                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
376                    throws com.liferay.portal.NoSuchUserGroupException,
377                            com.liferay.portal.kernel.exception.SystemException;
378    
379            /**
380            * Returns all the user groups that the user has permission to view where companyId = &#63; and parentUserGroupId = &#63;.
381            *
382            * @param companyId the company ID
383            * @param parentUserGroupId the parent user group ID
384            * @return the matching user groups that the user has permission to view
385            * @throws SystemException if a system exception occurred
386            */
387            public java.util.List<com.liferay.portal.model.UserGroup> filterFindByC_P(
388                    long companyId, long parentUserGroupId)
389                    throws com.liferay.portal.kernel.exception.SystemException;
390    
391            /**
392            * Returns a range of all the user groups that the user has permission to view where companyId = &#63; and parentUserGroupId = &#63;.
393            *
394            * <p>
395            * 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.
396            * </p>
397            *
398            * @param companyId the company ID
399            * @param parentUserGroupId the parent user group ID
400            * @param start the lower bound of the range of user groups
401            * @param end the upper bound of the range of user groups (not inclusive)
402            * @return the range of matching user groups that the user has permission to view
403            * @throws SystemException if a system exception occurred
404            */
405            public java.util.List<com.liferay.portal.model.UserGroup> filterFindByC_P(
406                    long companyId, long parentUserGroupId, int start, int end)
407                    throws com.liferay.portal.kernel.exception.SystemException;
408    
409            /**
410            * Returns an ordered range of all the user groups that the user has permissions to view where companyId = &#63; and parentUserGroupId = &#63;.
411            *
412            * <p>
413            * 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.
414            * </p>
415            *
416            * @param companyId the company ID
417            * @param parentUserGroupId the parent user group ID
418            * @param start the lower bound of the range of user groups
419            * @param end the upper bound of the range of user groups (not inclusive)
420            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
421            * @return the ordered range of matching user groups that the user has permission to view
422            * @throws SystemException if a system exception occurred
423            */
424            public java.util.List<com.liferay.portal.model.UserGroup> filterFindByC_P(
425                    long companyId, long parentUserGroupId, int start, int end,
426                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
427                    throws com.liferay.portal.kernel.exception.SystemException;
428    
429            /**
430            * 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;.
431            *
432            * @param userGroupId the primary key of the current user group
433            * @param companyId the company ID
434            * @param parentUserGroupId the parent user group ID
435            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
436            * @return the previous, current, and next user group
437            * @throws com.liferay.portal.NoSuchUserGroupException if a user group with the primary key could not be found
438            * @throws SystemException if a system exception occurred
439            */
440            public com.liferay.portal.model.UserGroup[] filterFindByC_P_PrevAndNext(
441                    long userGroupId, long companyId, long parentUserGroupId,
442                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
443                    throws com.liferay.portal.NoSuchUserGroupException,
444                            com.liferay.portal.kernel.exception.SystemException;
445    
446            /**
447            * Returns the user group where companyId = &#63; and name = &#63; or throws a {@link com.liferay.portal.NoSuchUserGroupException} if it could not be found.
448            *
449            * @param companyId the company ID
450            * @param name the name
451            * @return the matching user group
452            * @throws com.liferay.portal.NoSuchUserGroupException if a matching user group could not be found
453            * @throws SystemException if a system exception occurred
454            */
455            public com.liferay.portal.model.UserGroup findByC_N(long companyId,
456                    java.lang.String name)
457                    throws com.liferay.portal.NoSuchUserGroupException,
458                            com.liferay.portal.kernel.exception.SystemException;
459    
460            /**
461            * 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.
462            *
463            * @param companyId the company ID
464            * @param name the name
465            * @return the matching user group, or <code>null</code> if a matching user group could not be found
466            * @throws SystemException if a system exception occurred
467            */
468            public com.liferay.portal.model.UserGroup fetchByC_N(long companyId,
469                    java.lang.String name)
470                    throws com.liferay.portal.kernel.exception.SystemException;
471    
472            /**
473            * 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.
474            *
475            * @param companyId the company ID
476            * @param name the name
477            * @param retrieveFromCache whether to use the finder cache
478            * @return the matching user group, or <code>null</code> if a matching user group could not be found
479            * @throws SystemException if a system exception occurred
480            */
481            public com.liferay.portal.model.UserGroup fetchByC_N(long companyId,
482                    java.lang.String name, boolean retrieveFromCache)
483                    throws com.liferay.portal.kernel.exception.SystemException;
484    
485            /**
486            * Returns all the user groups.
487            *
488            * @return the user groups
489            * @throws SystemException if a system exception occurred
490            */
491            public java.util.List<com.liferay.portal.model.UserGroup> findAll()
492                    throws com.liferay.portal.kernel.exception.SystemException;
493    
494            /**
495            * Returns a range of all the user groups.
496            *
497            * <p>
498            * 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.
499            * </p>
500            *
501            * @param start the lower bound of the range of user groups
502            * @param end the upper bound of the range of user groups (not inclusive)
503            * @return the range of user groups
504            * @throws SystemException if a system exception occurred
505            */
506            public java.util.List<com.liferay.portal.model.UserGroup> findAll(
507                    int start, int end)
508                    throws com.liferay.portal.kernel.exception.SystemException;
509    
510            /**
511            * Returns an ordered range of all the user groups.
512            *
513            * <p>
514            * 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.
515            * </p>
516            *
517            * @param start the lower bound of the range of user groups
518            * @param end the upper bound of the range of user groups (not inclusive)
519            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
520            * @return the ordered range of user groups
521            * @throws SystemException if a system exception occurred
522            */
523            public java.util.List<com.liferay.portal.model.UserGroup> findAll(
524                    int start, int end,
525                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
526                    throws com.liferay.portal.kernel.exception.SystemException;
527    
528            /**
529            * Removes all the user groups where companyId = &#63; from the database.
530            *
531            * @param companyId the company ID
532            * @throws SystemException if a system exception occurred
533            */
534            public void removeByCompanyId(long companyId)
535                    throws com.liferay.portal.kernel.exception.SystemException;
536    
537            /**
538            * Removes all the user groups where companyId = &#63; and parentUserGroupId = &#63; from the database.
539            *
540            * @param companyId the company ID
541            * @param parentUserGroupId the parent user group ID
542            * @throws SystemException if a system exception occurred
543            */
544            public void removeByC_P(long companyId, long parentUserGroupId)
545                    throws com.liferay.portal.kernel.exception.SystemException;
546    
547            /**
548            * Removes the user group where companyId = &#63; and name = &#63; from the database.
549            *
550            * @param companyId the company ID
551            * @param name the name
552            * @throws SystemException if a system exception occurred
553            */
554            public void removeByC_N(long companyId, java.lang.String name)
555                    throws com.liferay.portal.NoSuchUserGroupException,
556                            com.liferay.portal.kernel.exception.SystemException;
557    
558            /**
559            * Removes all the user groups from the database.
560            *
561            * @throws SystemException if a system exception occurred
562            */
563            public void removeAll()
564                    throws com.liferay.portal.kernel.exception.SystemException;
565    
566            /**
567            * Returns the number of user groups where companyId = &#63;.
568            *
569            * @param companyId the company ID
570            * @return the number of matching user groups
571            * @throws SystemException if a system exception occurred
572            */
573            public int countByCompanyId(long companyId)
574                    throws com.liferay.portal.kernel.exception.SystemException;
575    
576            /**
577            * Returns the number of user groups that the user has permission to view where companyId = &#63;.
578            *
579            * @param companyId the company ID
580            * @return the number of matching user groups that the user has permission to view
581            * @throws SystemException if a system exception occurred
582            */
583            public int filterCountByCompanyId(long companyId)
584                    throws com.liferay.portal.kernel.exception.SystemException;
585    
586            /**
587            * Returns the number of user groups where companyId = &#63; and parentUserGroupId = &#63;.
588            *
589            * @param companyId the company ID
590            * @param parentUserGroupId the parent user group ID
591            * @return the number of matching user groups
592            * @throws SystemException if a system exception occurred
593            */
594            public int countByC_P(long companyId, long parentUserGroupId)
595                    throws com.liferay.portal.kernel.exception.SystemException;
596    
597            /**
598            * Returns the number of user groups that the user has permission to view where companyId = &#63; and parentUserGroupId = &#63;.
599            *
600            * @param companyId the company ID
601            * @param parentUserGroupId the parent user group ID
602            * @return the number of matching user groups that the user has permission to view
603            * @throws SystemException if a system exception occurred
604            */
605            public int filterCountByC_P(long companyId, long parentUserGroupId)
606                    throws com.liferay.portal.kernel.exception.SystemException;
607    
608            /**
609            * Returns the number of user groups where companyId = &#63; and name = &#63;.
610            *
611            * @param companyId the company ID
612            * @param name the name
613            * @return the number of matching user groups
614            * @throws SystemException if a system exception occurred
615            */
616            public int countByC_N(long companyId, java.lang.String name)
617                    throws com.liferay.portal.kernel.exception.SystemException;
618    
619            /**
620            * Returns the number of user groups.
621            *
622            * @return the number of user groups
623            * @throws SystemException if a system exception occurred
624            */
625            public int countAll()
626                    throws com.liferay.portal.kernel.exception.SystemException;
627    
628            /**
629            * Returns all the groups associated with the user group.
630            *
631            * @param pk the primary key of the user group
632            * @return the groups associated with the user group
633            * @throws SystemException if a system exception occurred
634            */
635            public java.util.List<com.liferay.portal.model.Group> getGroups(long pk)
636                    throws com.liferay.portal.kernel.exception.SystemException;
637    
638            /**
639            * Returns a range of all the groups associated with the user group.
640            *
641            * <p>
642            * 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.
643            * </p>
644            *
645            * @param pk the primary key of the user group
646            * @param start the lower bound of the range of user groups
647            * @param end the upper bound of the range of user groups (not inclusive)
648            * @return the range of groups associated with the user group
649            * @throws SystemException if a system exception occurred
650            */
651            public java.util.List<com.liferay.portal.model.Group> getGroups(long pk,
652                    int start, int end)
653                    throws com.liferay.portal.kernel.exception.SystemException;
654    
655            /**
656            * Returns an ordered range of all the groups associated with the user group.
657            *
658            * <p>
659            * 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.
660            * </p>
661            *
662            * @param pk the primary key of the user group
663            * @param start the lower bound of the range of user groups
664            * @param end the upper bound of the range of user groups (not inclusive)
665            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
666            * @return the ordered range of groups associated with the user group
667            * @throws SystemException if a system exception occurred
668            */
669            public java.util.List<com.liferay.portal.model.Group> getGroups(long pk,
670                    int start, int end,
671                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
672                    throws com.liferay.portal.kernel.exception.SystemException;
673    
674            /**
675            * Returns the number of groups associated with the user group.
676            *
677            * @param pk the primary key of the user group
678            * @return the number of groups associated with the user group
679            * @throws SystemException if a system exception occurred
680            */
681            public int getGroupsSize(long pk)
682                    throws com.liferay.portal.kernel.exception.SystemException;
683    
684            /**
685            * Returns <code>true</code> if the group is associated with the user group.
686            *
687            * @param pk the primary key of the user group
688            * @param groupPK the primary key of the group
689            * @return <code>true</code> if the group is associated with the user group; <code>false</code> otherwise
690            * @throws SystemException if a system exception occurred
691            */
692            public boolean containsGroup(long pk, long groupPK)
693                    throws com.liferay.portal.kernel.exception.SystemException;
694    
695            /**
696            * Returns <code>true</code> if the user group has any groups associated with it.
697            *
698            * @param pk the primary key of the user group to check for associations with groups
699            * @return <code>true</code> if the user group has any groups associated with it; <code>false</code> otherwise
700            * @throws SystemException if a system exception occurred
701            */
702            public boolean containsGroups(long pk)
703                    throws com.liferay.portal.kernel.exception.SystemException;
704    
705            /**
706            * Adds an association between the user group and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache.
707            *
708            * @param pk the primary key of the user group
709            * @param groupPK the primary key of the group
710            * @throws SystemException if a system exception occurred
711            */
712            public void addGroup(long pk, long groupPK)
713                    throws com.liferay.portal.kernel.exception.SystemException;
714    
715            /**
716            * Adds an association between the user group and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache.
717            *
718            * @param pk the primary key of the user group
719            * @param group the group
720            * @throws SystemException if a system exception occurred
721            */
722            public void addGroup(long pk, com.liferay.portal.model.Group group)
723                    throws com.liferay.portal.kernel.exception.SystemException;
724    
725            /**
726            * Adds an association between the user group and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.
727            *
728            * @param pk the primary key of the user group
729            * @param groupPKs the primary keys of the groups
730            * @throws SystemException if a system exception occurred
731            */
732            public void addGroups(long pk, long[] groupPKs)
733                    throws com.liferay.portal.kernel.exception.SystemException;
734    
735            /**
736            * Adds an association between the user group and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.
737            *
738            * @param pk the primary key of the user group
739            * @param groups the groups
740            * @throws SystemException if a system exception occurred
741            */
742            public void addGroups(long pk,
743                    java.util.List<com.liferay.portal.model.Group> groups)
744                    throws com.liferay.portal.kernel.exception.SystemException;
745    
746            /**
747            * Clears all associations between the user group and its groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.
748            *
749            * @param pk the primary key of the user group to clear the associated groups from
750            * @throws SystemException if a system exception occurred
751            */
752            public void clearGroups(long pk)
753                    throws com.liferay.portal.kernel.exception.SystemException;
754    
755            /**
756            * Removes the association between the user group and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache.
757            *
758            * @param pk the primary key of the user group
759            * @param groupPK the primary key of the group
760            * @throws SystemException if a system exception occurred
761            */
762            public void removeGroup(long pk, long groupPK)
763                    throws com.liferay.portal.kernel.exception.SystemException;
764    
765            /**
766            * Removes the association between the user group and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache.
767            *
768            * @param pk the primary key of the user group
769            * @param group the group
770            * @throws SystemException if a system exception occurred
771            */
772            public void removeGroup(long pk, com.liferay.portal.model.Group group)
773                    throws com.liferay.portal.kernel.exception.SystemException;
774    
775            /**
776            * Removes the association between the user group and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.
777            *
778            * @param pk the primary key of the user group
779            * @param groupPKs the primary keys of the groups
780            * @throws SystemException if a system exception occurred
781            */
782            public void removeGroups(long pk, long[] groupPKs)
783                    throws com.liferay.portal.kernel.exception.SystemException;
784    
785            /**
786            * Removes the association between the user group and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.
787            *
788            * @param pk the primary key of the user group
789            * @param groups the groups
790            * @throws SystemException if a system exception occurred
791            */
792            public void removeGroups(long pk,
793                    java.util.List<com.liferay.portal.model.Group> groups)
794                    throws com.liferay.portal.kernel.exception.SystemException;
795    
796            /**
797            * 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.
798            *
799            * @param pk the primary key of the user group
800            * @param groupPKs the primary keys of the groups to be associated with the user group
801            * @throws SystemException if a system exception occurred
802            */
803            public void setGroups(long pk, long[] groupPKs)
804                    throws com.liferay.portal.kernel.exception.SystemException;
805    
806            /**
807            * 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.
808            *
809            * @param pk the primary key of the user group
810            * @param groups the groups to be associated with the user group
811            * @throws SystemException if a system exception occurred
812            */
813            public void setGroups(long pk,
814                    java.util.List<com.liferay.portal.model.Group> groups)
815                    throws com.liferay.portal.kernel.exception.SystemException;
816    
817            /**
818            * Returns all the teams associated with the user group.
819            *
820            * @param pk the primary key of the user group
821            * @return the teams associated with the user group
822            * @throws SystemException if a system exception occurred
823            */
824            public java.util.List<com.liferay.portal.model.Team> getTeams(long pk)
825                    throws com.liferay.portal.kernel.exception.SystemException;
826    
827            /**
828            * Returns a range of all the teams associated with the user group.
829            *
830            * <p>
831            * 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.
832            * </p>
833            *
834            * @param pk the primary key of the user group
835            * @param start the lower bound of the range of user groups
836            * @param end the upper bound of the range of user groups (not inclusive)
837            * @return the range of teams associated with the user group
838            * @throws SystemException if a system exception occurred
839            */
840            public java.util.List<com.liferay.portal.model.Team> getTeams(long pk,
841                    int start, int end)
842                    throws com.liferay.portal.kernel.exception.SystemException;
843    
844            /**
845            * Returns an ordered range of all the teams associated with the user group.
846            *
847            * <p>
848            * 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.
849            * </p>
850            *
851            * @param pk the primary key of the user group
852            * @param start the lower bound of the range of user groups
853            * @param end the upper bound of the range of user groups (not inclusive)
854            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
855            * @return the ordered range of teams associated with the user group
856            * @throws SystemException if a system exception occurred
857            */
858            public java.util.List<com.liferay.portal.model.Team> getTeams(long pk,
859                    int start, int end,
860                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
861                    throws com.liferay.portal.kernel.exception.SystemException;
862    
863            /**
864            * Returns the number of teams associated with the user group.
865            *
866            * @param pk the primary key of the user group
867            * @return the number of teams associated with the user group
868            * @throws SystemException if a system exception occurred
869            */
870            public int getTeamsSize(long pk)
871                    throws com.liferay.portal.kernel.exception.SystemException;
872    
873            /**
874            * Returns <code>true</code> if the team is associated with the user group.
875            *
876            * @param pk the primary key of the user group
877            * @param teamPK the primary key of the team
878            * @return <code>true</code> if the team is associated with the user group; <code>false</code> otherwise
879            * @throws SystemException if a system exception occurred
880            */
881            public boolean containsTeam(long pk, long teamPK)
882                    throws com.liferay.portal.kernel.exception.SystemException;
883    
884            /**
885            * Returns <code>true</code> if the user group has any teams associated with it.
886            *
887            * @param pk the primary key of the user group to check for associations with teams
888            * @return <code>true</code> if the user group has any teams associated with it; <code>false</code> otherwise
889            * @throws SystemException if a system exception occurred
890            */
891            public boolean containsTeams(long pk)
892                    throws com.liferay.portal.kernel.exception.SystemException;
893    
894            /**
895            * Adds an association between the user group and the team. Also notifies the appropriate model listeners and clears the mapping table finder cache.
896            *
897            * @param pk the primary key of the user group
898            * @param teamPK the primary key of the team
899            * @throws SystemException if a system exception occurred
900            */
901            public void addTeam(long pk, long teamPK)
902                    throws com.liferay.portal.kernel.exception.SystemException;
903    
904            /**
905            * Adds an association between the user group and the team. Also notifies the appropriate model listeners and clears the mapping table finder cache.
906            *
907            * @param pk the primary key of the user group
908            * @param team the team
909            * @throws SystemException if a system exception occurred
910            */
911            public void addTeam(long pk, com.liferay.portal.model.Team team)
912                    throws com.liferay.portal.kernel.exception.SystemException;
913    
914            /**
915            * Adds an association between the user group and the teams. Also notifies the appropriate model listeners and clears the mapping table finder cache.
916            *
917            * @param pk the primary key of the user group
918            * @param teamPKs the primary keys of the teams
919            * @throws SystemException if a system exception occurred
920            */
921            public void addTeams(long pk, long[] teamPKs)
922                    throws com.liferay.portal.kernel.exception.SystemException;
923    
924            /**
925            * Adds an association between the user group and the teams. Also notifies the appropriate model listeners and clears the mapping table finder cache.
926            *
927            * @param pk the primary key of the user group
928            * @param teams the teams
929            * @throws SystemException if a system exception occurred
930            */
931            public void addTeams(long pk,
932                    java.util.List<com.liferay.portal.model.Team> teams)
933                    throws com.liferay.portal.kernel.exception.SystemException;
934    
935            /**
936            * Clears all associations between the user group and its teams. Also notifies the appropriate model listeners and clears the mapping table finder cache.
937            *
938            * @param pk the primary key of the user group to clear the associated teams from
939            * @throws SystemException if a system exception occurred
940            */
941            public void clearTeams(long pk)
942                    throws com.liferay.portal.kernel.exception.SystemException;
943    
944            /**
945            * Removes the association between the user group and the team. Also notifies the appropriate model listeners and clears the mapping table finder cache.
946            *
947            * @param pk the primary key of the user group
948            * @param teamPK the primary key of the team
949            * @throws SystemException if a system exception occurred
950            */
951            public void removeTeam(long pk, long teamPK)
952                    throws com.liferay.portal.kernel.exception.SystemException;
953    
954            /**
955            * Removes the association between the user group and the team. Also notifies the appropriate model listeners and clears the mapping table finder cache.
956            *
957            * @param pk the primary key of the user group
958            * @param team the team
959            * @throws SystemException if a system exception occurred
960            */
961            public void removeTeam(long pk, com.liferay.portal.model.Team team)
962                    throws com.liferay.portal.kernel.exception.SystemException;
963    
964            /**
965            * Removes the association between the user group and the teams. Also notifies the appropriate model listeners and clears the mapping table finder cache.
966            *
967            * @param pk the primary key of the user group
968            * @param teamPKs the primary keys of the teams
969            * @throws SystemException if a system exception occurred
970            */
971            public void removeTeams(long pk, long[] teamPKs)
972                    throws com.liferay.portal.kernel.exception.SystemException;
973    
974            /**
975            * Removes the association between the user group and the teams. Also notifies the appropriate model listeners and clears the mapping table finder cache.
976            *
977            * @param pk the primary key of the user group
978            * @param teams the teams
979            * @throws SystemException if a system exception occurred
980            */
981            public void removeTeams(long pk,
982                    java.util.List<com.liferay.portal.model.Team> teams)
983                    throws com.liferay.portal.kernel.exception.SystemException;
984    
985            /**
986            * 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.
987            *
988            * @param pk the primary key of the user group
989            * @param teamPKs the primary keys of the teams to be associated with the user group
990            * @throws SystemException if a system exception occurred
991            */
992            public void setTeams(long pk, long[] teamPKs)
993                    throws com.liferay.portal.kernel.exception.SystemException;
994    
995            /**
996            * 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.
997            *
998            * @param pk the primary key of the user group
999            * @param teams the teams to be associated with the user group
1000            * @throws SystemException if a system exception occurred
1001            */
1002            public void setTeams(long pk,
1003                    java.util.List<com.liferay.portal.model.Team> teams)
1004                    throws com.liferay.portal.kernel.exception.SystemException;
1005    
1006            /**
1007            * Returns all the users associated with the user group.
1008            *
1009            * @param pk the primary key of the user group
1010            * @return the users associated with the user group
1011            * @throws SystemException if a system exception occurred
1012            */
1013            public java.util.List<com.liferay.portal.model.User> getUsers(long pk)
1014                    throws com.liferay.portal.kernel.exception.SystemException;
1015    
1016            /**
1017            * Returns a range of all the users associated with the user group.
1018            *
1019            * <p>
1020            * 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.
1021            * </p>
1022            *
1023            * @param pk the primary key of the user group
1024            * @param start the lower bound of the range of user groups
1025            * @param end the upper bound of the range of user groups (not inclusive)
1026            * @return the range of users associated with the user group
1027            * @throws SystemException if a system exception occurred
1028            */
1029            public java.util.List<com.liferay.portal.model.User> getUsers(long pk,
1030                    int start, int end)
1031                    throws com.liferay.portal.kernel.exception.SystemException;
1032    
1033            /**
1034            * Returns an ordered range of all the users associated with the user group.
1035            *
1036            * <p>
1037            * 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.
1038            * </p>
1039            *
1040            * @param pk the primary key of the user group
1041            * @param start the lower bound of the range of user groups
1042            * @param end the upper bound of the range of user groups (not inclusive)
1043            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
1044            * @return the ordered range of users associated with the user group
1045            * @throws SystemException if a system exception occurred
1046            */
1047            public java.util.List<com.liferay.portal.model.User> getUsers(long pk,
1048                    int start, int end,
1049                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
1050                    throws com.liferay.portal.kernel.exception.SystemException;
1051    
1052            /**
1053            * Returns the number of users associated with the user group.
1054            *
1055            * @param pk the primary key of the user group
1056            * @return the number of users associated with the user group
1057            * @throws SystemException if a system exception occurred
1058            */
1059            public int getUsersSize(long pk)
1060                    throws com.liferay.portal.kernel.exception.SystemException;
1061    
1062            /**
1063            * Returns <code>true</code> if the user is associated with the user group.
1064            *
1065            * @param pk the primary key of the user group
1066            * @param userPK the primary key of the user
1067            * @return <code>true</code> if the user is associated with the user group; <code>false</code> otherwise
1068            * @throws SystemException if a system exception occurred
1069            */
1070            public boolean containsUser(long pk, long userPK)
1071                    throws com.liferay.portal.kernel.exception.SystemException;
1072    
1073            /**
1074            * Returns <code>true</code> if the user group has any users associated with it.
1075            *
1076            * @param pk the primary key of the user group to check for associations with users
1077            * @return <code>true</code> if the user group has any users associated with it; <code>false</code> otherwise
1078            * @throws SystemException if a system exception occurred
1079            */
1080            public boolean containsUsers(long pk)
1081                    throws com.liferay.portal.kernel.exception.SystemException;
1082    
1083            /**
1084            * Adds an association between the user group and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.
1085            *
1086            * @param pk the primary key of the user group
1087            * @param userPK the primary key of the user
1088            * @throws SystemException if a system exception occurred
1089            */
1090            public void addUser(long pk, long userPK)
1091                    throws com.liferay.portal.kernel.exception.SystemException;
1092    
1093            /**
1094            * Adds an association between the user group and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.
1095            *
1096            * @param pk the primary key of the user group
1097            * @param user the user
1098            * @throws SystemException if a system exception occurred
1099            */
1100            public void addUser(long pk, com.liferay.portal.model.User user)
1101                    throws com.liferay.portal.kernel.exception.SystemException;
1102    
1103            /**
1104            * Adds an association between the user group and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.
1105            *
1106            * @param pk the primary key of the user group
1107            * @param userPKs the primary keys of the users
1108            * @throws SystemException if a system exception occurred
1109            */
1110            public void addUsers(long pk, long[] userPKs)
1111                    throws com.liferay.portal.kernel.exception.SystemException;
1112    
1113            /**
1114            * Adds an association between the user group and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.
1115            *
1116            * @param pk the primary key of the user group
1117            * @param users the users
1118            * @throws SystemException if a system exception occurred
1119            */
1120            public void addUsers(long pk,
1121                    java.util.List<com.liferay.portal.model.User> users)
1122                    throws com.liferay.portal.kernel.exception.SystemException;
1123    
1124            /**
1125            * Clears all associations between the user group and its users. Also notifies the appropriate model listeners and clears the mapping table finder cache.
1126            *
1127            * @param pk the primary key of the user group to clear the associated users from
1128            * @throws SystemException if a system exception occurred
1129            */
1130            public void clearUsers(long pk)
1131                    throws com.liferay.portal.kernel.exception.SystemException;
1132    
1133            /**
1134            * Removes the association between the user group and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.
1135            *
1136            * @param pk the primary key of the user group
1137            * @param userPK the primary key of the user
1138            * @throws SystemException if a system exception occurred
1139            */
1140            public void removeUser(long pk, long userPK)
1141                    throws com.liferay.portal.kernel.exception.SystemException;
1142    
1143            /**
1144            * Removes the association between the user group and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.
1145            *
1146            * @param pk the primary key of the user group
1147            * @param user the user
1148            * @throws SystemException if a system exception occurred
1149            */
1150            public void removeUser(long pk, com.liferay.portal.model.User user)
1151                    throws com.liferay.portal.kernel.exception.SystemException;
1152    
1153            /**
1154            * Removes the association between the user group and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.
1155            *
1156            * @param pk the primary key of the user group
1157            * @param userPKs the primary keys of the users
1158            * @throws SystemException if a system exception occurred
1159            */
1160            public void removeUsers(long pk, long[] userPKs)
1161                    throws com.liferay.portal.kernel.exception.SystemException;
1162    
1163            /**
1164            * Removes the association between the user group and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.
1165            *
1166            * @param pk the primary key of the user group
1167            * @param users the users
1168            * @throws SystemException if a system exception occurred
1169            */
1170            public void removeUsers(long pk,
1171                    java.util.List<com.liferay.portal.model.User> users)
1172                    throws com.liferay.portal.kernel.exception.SystemException;
1173    
1174            /**
1175            * 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.
1176            *
1177            * @param pk the primary key of the user group
1178            * @param userPKs the primary keys of the users to be associated with the user group
1179            * @throws SystemException if a system exception occurred
1180            */
1181            public void setUsers(long pk, long[] userPKs)
1182                    throws com.liferay.portal.kernel.exception.SystemException;
1183    
1184            /**
1185            * 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.
1186            *
1187            * @param pk the primary key of the user group
1188            * @param users the users to be associated with the user group
1189            * @throws SystemException if a system exception occurred
1190            */
1191            public void setUsers(long pk,
1192                    java.util.List<com.liferay.portal.model.User> users)
1193                    throws com.liferay.portal.kernel.exception.SystemException;
1194    }