001    /**
002     * Copyright (c) 2000-2010 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     * 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.
024     * </p>
025     *
026     * <p>
027     * Caching information and settings can be found in <code>portal.properties</code>
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see UserGroupPersistenceImpl
032     * @see UserGroupUtil
033     * @generated
034     */
035    public interface UserGroupPersistence extends BasePersistence<UserGroup> {
036            /**
037            * Caches the user group in the entity cache if it is enabled.
038            *
039            * @param userGroup the user group to cache
040            */
041            public void cacheResult(com.liferay.portal.model.UserGroup userGroup);
042    
043            /**
044            * Caches the user groups in the entity cache if it is enabled.
045            *
046            * @param userGroups the user groups to cache
047            */
048            public void cacheResult(
049                    java.util.List<com.liferay.portal.model.UserGroup> userGroups);
050    
051            /**
052            * Creates a new user group with the primary key. Does not add the user group to the database.
053            *
054            * @param userGroupId the primary key for the new user group
055            * @return the new user group
056            */
057            public com.liferay.portal.model.UserGroup create(long userGroupId);
058    
059            /**
060            * Removes the user group with the primary key from the database. Also notifies the appropriate model listeners.
061            *
062            * @param userGroupId the primary key of the user group to remove
063            * @return the user group that was removed
064            * @throws com.liferay.portal.NoSuchUserGroupException if a user group with the primary key could not be found
065            * @throws SystemException if a system exception occurred
066            */
067            public com.liferay.portal.model.UserGroup remove(long userGroupId)
068                    throws com.liferay.portal.NoSuchUserGroupException,
069                            com.liferay.portal.kernel.exception.SystemException;
070    
071            public com.liferay.portal.model.UserGroup updateImpl(
072                    com.liferay.portal.model.UserGroup userGroup, boolean merge)
073                    throws com.liferay.portal.kernel.exception.SystemException;
074    
075            /**
076            * Finds the user group with the primary key or throws a {@link com.liferay.portal.NoSuchUserGroupException} if it could not be found.
077            *
078            * @param userGroupId the primary key of the user group to find
079            * @return the user group
080            * @throws com.liferay.portal.NoSuchUserGroupException if a user group with the primary key could not be found
081            * @throws SystemException if a system exception occurred
082            */
083            public com.liferay.portal.model.UserGroup findByPrimaryKey(long userGroupId)
084                    throws com.liferay.portal.NoSuchUserGroupException,
085                            com.liferay.portal.kernel.exception.SystemException;
086    
087            /**
088            * Finds the user group with the primary key or returns <code>null</code> if it could not be found.
089            *
090            * @param userGroupId the primary key of the user group to find
091            * @return the user group, or <code>null</code> if a user group with the primary key could not be found
092            * @throws SystemException if a system exception occurred
093            */
094            public com.liferay.portal.model.UserGroup fetchByPrimaryKey(
095                    long userGroupId)
096                    throws com.liferay.portal.kernel.exception.SystemException;
097    
098            /**
099            * Finds all the user groups where companyId = &#63;.
100            *
101            * @param companyId the company id to search with
102            * @return the matching user groups
103            * @throws SystemException if a system exception occurred
104            */
105            public java.util.List<com.liferay.portal.model.UserGroup> findByCompanyId(
106                    long companyId)
107                    throws com.liferay.portal.kernel.exception.SystemException;
108    
109            /**
110            * Finds a range of all the user groups where companyId = &#63;.
111            *
112            * <p>
113            * 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.
114            * </p>
115            *
116            * @param companyId the company id to search with
117            * @param start the lower bound of the range of user groups to return
118            * @param end the upper bound of the range of user groups to return (not inclusive)
119            * @return the range of matching user groups
120            * @throws SystemException if a system exception occurred
121            */
122            public java.util.List<com.liferay.portal.model.UserGroup> findByCompanyId(
123                    long companyId, int start, int end)
124                    throws com.liferay.portal.kernel.exception.SystemException;
125    
126            /**
127            * Finds an ordered range of all the user groups where companyId = &#63;.
128            *
129            * <p>
130            * 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.
131            * </p>
132            *
133            * @param companyId the company id to search with
134            * @param start the lower bound of the range of user groups to return
135            * @param end the upper bound of the range of user groups to return (not inclusive)
136            * @param orderByComparator the comparator to order the results by
137            * @return the ordered range of matching user groups
138            * @throws SystemException if a system exception occurred
139            */
140            public java.util.List<com.liferay.portal.model.UserGroup> findByCompanyId(
141                    long companyId, int start, int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException;
144    
145            /**
146            * Finds the first user group in the ordered set where companyId = &#63;.
147            *
148            * <p>
149            * 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.
150            * </p>
151            *
152            * @param companyId the company id to search with
153            * @param orderByComparator the comparator to order the set by
154            * @return the first matching user group
155            * @throws com.liferay.portal.NoSuchUserGroupException if a matching user group could not be found
156            * @throws SystemException if a system exception occurred
157            */
158            public com.liferay.portal.model.UserGroup findByCompanyId_First(
159                    long companyId,
160                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
161                    throws com.liferay.portal.NoSuchUserGroupException,
162                            com.liferay.portal.kernel.exception.SystemException;
163    
164            /**
165            * Finds the last user group in the ordered set where companyId = &#63;.
166            *
167            * <p>
168            * 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.
169            * </p>
170            *
171            * @param companyId the company id to search with
172            * @param orderByComparator the comparator to order the set by
173            * @return the last matching user group
174            * @throws com.liferay.portal.NoSuchUserGroupException if a matching user group could not be found
175            * @throws SystemException if a system exception occurred
176            */
177            public com.liferay.portal.model.UserGroup findByCompanyId_Last(
178                    long companyId,
179                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
180                    throws com.liferay.portal.NoSuchUserGroupException,
181                            com.liferay.portal.kernel.exception.SystemException;
182    
183            /**
184            * Finds the user groups before and after the current user group in the ordered set where companyId = &#63;.
185            *
186            * <p>
187            * 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.
188            * </p>
189            *
190            * @param userGroupId the primary key of the current user group
191            * @param companyId the company id to search with
192            * @param orderByComparator the comparator to order the set by
193            * @return the previous, current, and next user group
194            * @throws com.liferay.portal.NoSuchUserGroupException if a user group with the primary key could not be found
195            * @throws SystemException if a system exception occurred
196            */
197            public com.liferay.portal.model.UserGroup[] findByCompanyId_PrevAndNext(
198                    long userGroupId, long companyId,
199                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
200                    throws com.liferay.portal.NoSuchUserGroupException,
201                            com.liferay.portal.kernel.exception.SystemException;
202    
203            /**
204            * Finds all the user groups where companyId = &#63; and parentUserGroupId = &#63;.
205            *
206            * @param companyId the company id to search with
207            * @param parentUserGroupId the parent user group id to search with
208            * @return the matching user groups
209            * @throws SystemException if a system exception occurred
210            */
211            public java.util.List<com.liferay.portal.model.UserGroup> findByC_P(
212                    long companyId, long parentUserGroupId)
213                    throws com.liferay.portal.kernel.exception.SystemException;
214    
215            /**
216            * Finds a range of all the user groups where companyId = &#63; and parentUserGroupId = &#63;.
217            *
218            * <p>
219            * 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.
220            * </p>
221            *
222            * @param companyId the company id to search with
223            * @param parentUserGroupId the parent user group id to search with
224            * @param start the lower bound of the range of user groups to return
225            * @param end the upper bound of the range of user groups to return (not inclusive)
226            * @return the range of matching user groups
227            * @throws SystemException if a system exception occurred
228            */
229            public java.util.List<com.liferay.portal.model.UserGroup> findByC_P(
230                    long companyId, long parentUserGroupId, int start, int end)
231                    throws com.liferay.portal.kernel.exception.SystemException;
232    
233            /**
234            * Finds an ordered range of all the user groups where companyId = &#63; and parentUserGroupId = &#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 to search with
241            * @param parentUserGroupId the parent user group id to search with
242            * @param start the lower bound of the range of user groups to return
243            * @param end the upper bound of the range of user groups to return (not inclusive)
244            * @param orderByComparator the comparator to order the results by
245            * @return the ordered range of matching user groups
246            * @throws SystemException if a system exception occurred
247            */
248            public java.util.List<com.liferay.portal.model.UserGroup> findByC_P(
249                    long companyId, long parentUserGroupId, int start, int end,
250                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
251                    throws com.liferay.portal.kernel.exception.SystemException;
252    
253            /**
254            * Finds the first user group in the ordered set where companyId = &#63; and parentUserGroupId = &#63;.
255            *
256            * <p>
257            * 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.
258            * </p>
259            *
260            * @param companyId the company id to search with
261            * @param parentUserGroupId the parent user group id to search with
262            * @param orderByComparator the comparator to order the set by
263            * @return the first matching user group
264            * @throws com.liferay.portal.NoSuchUserGroupException if a matching user group could not be found
265            * @throws SystemException if a system exception occurred
266            */
267            public com.liferay.portal.model.UserGroup findByC_P_First(long companyId,
268                    long parentUserGroupId,
269                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
270                    throws com.liferay.portal.NoSuchUserGroupException,
271                            com.liferay.portal.kernel.exception.SystemException;
272    
273            /**
274            * Finds the last user group in the ordered set where companyId = &#63; and parentUserGroupId = &#63;.
275            *
276            * <p>
277            * 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.
278            * </p>
279            *
280            * @param companyId the company id to search with
281            * @param parentUserGroupId the parent user group id to search with
282            * @param orderByComparator the comparator to order the set by
283            * @return the last matching user group
284            * @throws com.liferay.portal.NoSuchUserGroupException if a matching user group could not be found
285            * @throws SystemException if a system exception occurred
286            */
287            public com.liferay.portal.model.UserGroup findByC_P_Last(long companyId,
288                    long parentUserGroupId,
289                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
290                    throws com.liferay.portal.NoSuchUserGroupException,
291                            com.liferay.portal.kernel.exception.SystemException;
292    
293            /**
294            * Finds the user groups before and after the current user group in the ordered set where companyId = &#63; and parentUserGroupId = &#63;.
295            *
296            * <p>
297            * 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.
298            * </p>
299            *
300            * @param userGroupId the primary key of the current user group
301            * @param companyId the company id to search with
302            * @param parentUserGroupId the parent user group id to search with
303            * @param orderByComparator the comparator to order the set by
304            * @return the previous, current, and next user group
305            * @throws com.liferay.portal.NoSuchUserGroupException if a user group with the primary key could not be found
306            * @throws SystemException if a system exception occurred
307            */
308            public com.liferay.portal.model.UserGroup[] findByC_P_PrevAndNext(
309                    long userGroupId, long companyId, long parentUserGroupId,
310                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
311                    throws com.liferay.portal.NoSuchUserGroupException,
312                            com.liferay.portal.kernel.exception.SystemException;
313    
314            /**
315            * Finds the user group where companyId = &#63; and name = &#63; or throws a {@link com.liferay.portal.NoSuchUserGroupException} if it could not be found.
316            *
317            * @param companyId the company id to search with
318            * @param name the name to search with
319            * @return the matching user group
320            * @throws com.liferay.portal.NoSuchUserGroupException if a matching user group could not be found
321            * @throws SystemException if a system exception occurred
322            */
323            public com.liferay.portal.model.UserGroup findByC_N(long companyId,
324                    java.lang.String name)
325                    throws com.liferay.portal.NoSuchUserGroupException,
326                            com.liferay.portal.kernel.exception.SystemException;
327    
328            /**
329            * Finds the user group where companyId = &#63; and name = &#63; or returns <code>null</code> if it could not be found. Uses the finder cache.
330            *
331            * @param companyId the company id to search with
332            * @param name the name to search with
333            * @return the matching user group, or <code>null</code> if a matching user group could not be found
334            * @throws SystemException if a system exception occurred
335            */
336            public com.liferay.portal.model.UserGroup fetchByC_N(long companyId,
337                    java.lang.String name)
338                    throws com.liferay.portal.kernel.exception.SystemException;
339    
340            /**
341            * Finds 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.
342            *
343            * @param companyId the company id to search with
344            * @param name the name to search with
345            * @return the matching user group, or <code>null</code> if a matching user group could not be found
346            * @throws SystemException if a system exception occurred
347            */
348            public com.liferay.portal.model.UserGroup fetchByC_N(long companyId,
349                    java.lang.String name, boolean retrieveFromCache)
350                    throws com.liferay.portal.kernel.exception.SystemException;
351    
352            /**
353            * Finds all the user groups.
354            *
355            * @return the user groups
356            * @throws SystemException if a system exception occurred
357            */
358            public java.util.List<com.liferay.portal.model.UserGroup> findAll()
359                    throws com.liferay.portal.kernel.exception.SystemException;
360    
361            /**
362            * Finds a range of all the user groups.
363            *
364            * <p>
365            * 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.
366            * </p>
367            *
368            * @param start the lower bound of the range of user groups to return
369            * @param end the upper bound of the range of user groups to return (not inclusive)
370            * @return the range of user groups
371            * @throws SystemException if a system exception occurred
372            */
373            public java.util.List<com.liferay.portal.model.UserGroup> findAll(
374                    int start, int end)
375                    throws com.liferay.portal.kernel.exception.SystemException;
376    
377            /**
378            * Finds an ordered range of all the user groups.
379            *
380            * <p>
381            * 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.
382            * </p>
383            *
384            * @param start the lower bound of the range of user groups to return
385            * @param end the upper bound of the range of user groups to return (not inclusive)
386            * @param orderByComparator the comparator to order the results by
387            * @return the ordered range of user groups
388            * @throws SystemException if a system exception occurred
389            */
390            public java.util.List<com.liferay.portal.model.UserGroup> findAll(
391                    int start, int end,
392                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
393                    throws com.liferay.portal.kernel.exception.SystemException;
394    
395            /**
396            * Removes all the user groups where companyId = &#63; from the database.
397            *
398            * @param companyId the company id to search with
399            * @throws SystemException if a system exception occurred
400            */
401            public void removeByCompanyId(long companyId)
402                    throws com.liferay.portal.kernel.exception.SystemException;
403    
404            /**
405            * Removes all the user groups where companyId = &#63; and parentUserGroupId = &#63; from the database.
406            *
407            * @param companyId the company id to search with
408            * @param parentUserGroupId the parent user group id to search with
409            * @throws SystemException if a system exception occurred
410            */
411            public void removeByC_P(long companyId, long parentUserGroupId)
412                    throws com.liferay.portal.kernel.exception.SystemException;
413    
414            /**
415            * Removes the user group where companyId = &#63; and name = &#63; from the database.
416            *
417            * @param companyId the company id to search with
418            * @param name the name to search with
419            * @throws SystemException if a system exception occurred
420            */
421            public void removeByC_N(long companyId, java.lang.String name)
422                    throws com.liferay.portal.NoSuchUserGroupException,
423                            com.liferay.portal.kernel.exception.SystemException;
424    
425            /**
426            * Removes all the user groups from the database.
427            *
428            * @throws SystemException if a system exception occurred
429            */
430            public void removeAll()
431                    throws com.liferay.portal.kernel.exception.SystemException;
432    
433            /**
434            * Counts all the user groups where companyId = &#63;.
435            *
436            * @param companyId the company id to search with
437            * @return the number of matching user groups
438            * @throws SystemException if a system exception occurred
439            */
440            public int countByCompanyId(long companyId)
441                    throws com.liferay.portal.kernel.exception.SystemException;
442    
443            /**
444            * Counts all the user groups where companyId = &#63; and parentUserGroupId = &#63;.
445            *
446            * @param companyId the company id to search with
447            * @param parentUserGroupId the parent user group id to search with
448            * @return the number of matching user groups
449            * @throws SystemException if a system exception occurred
450            */
451            public int countByC_P(long companyId, long parentUserGroupId)
452                    throws com.liferay.portal.kernel.exception.SystemException;
453    
454            /**
455            * Counts all the user groups where companyId = &#63; and name = &#63;.
456            *
457            * @param companyId the company id to search with
458            * @param name the name to search with
459            * @return the number of matching user groups
460            * @throws SystemException if a system exception occurred
461            */
462            public int countByC_N(long companyId, java.lang.String name)
463                    throws com.liferay.portal.kernel.exception.SystemException;
464    
465            /**
466            * Counts all the user groups.
467            *
468            * @return the number of user groups
469            * @throws SystemException if a system exception occurred
470            */
471            public int countAll()
472                    throws com.liferay.portal.kernel.exception.SystemException;
473    
474            /**
475            * Gets all the groups associated with the user group.
476            *
477            * @param pk the primary key of the user group to get the associated groups for
478            * @return the groups associated with the user group
479            * @throws SystemException if a system exception occurred
480            */
481            public java.util.List<com.liferay.portal.model.Group> getGroups(long pk)
482                    throws com.liferay.portal.kernel.exception.SystemException;
483    
484            /**
485            * Gets a range of all the groups associated with the user group.
486            *
487            * <p>
488            * 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.
489            * </p>
490            *
491            * @param pk the primary key of the user group to get the associated groups for
492            * @param start the lower bound of the range of user groups to return
493            * @param end the upper bound of the range of user groups to return (not inclusive)
494            * @return the range of groups associated with the user group
495            * @throws SystemException if a system exception occurred
496            */
497            public java.util.List<com.liferay.portal.model.Group> getGroups(long pk,
498                    int start, int end)
499                    throws com.liferay.portal.kernel.exception.SystemException;
500    
501            /**
502            * Gets an ordered range of all the groups associated with the user group.
503            *
504            * <p>
505            * 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.
506            * </p>
507            *
508            * @param pk the primary key of the user group to get the associated groups for
509            * @param start the lower bound of the range of user groups to return
510            * @param end the upper bound of the range of user groups to return (not inclusive)
511            * @param orderByComparator the comparator to order the results by
512            * @return the ordered range of groups associated with the user group
513            * @throws SystemException if a system exception occurred
514            */
515            public java.util.List<com.liferay.portal.model.Group> getGroups(long pk,
516                    int start, int end,
517                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
518                    throws com.liferay.portal.kernel.exception.SystemException;
519    
520            /**
521            * Gets the number of groups associated with the user group.
522            *
523            * @param pk the primary key of the user group to get the number of associated groups for
524            * @return the number of groups associated with the user group
525            * @throws SystemException if a system exception occurred
526            */
527            public int getGroupsSize(long pk)
528                    throws com.liferay.portal.kernel.exception.SystemException;
529    
530            /**
531            * Determines whether the group is associated with the user group.
532            *
533            * @param pk the primary key of the user group
534            * @param groupPK the primary key of the group
535            * @return whether the group is associated with the user group
536            * @throws SystemException if a system exception occurred
537            */
538            public boolean containsGroup(long pk, long groupPK)
539                    throws com.liferay.portal.kernel.exception.SystemException;
540    
541            /**
542            * Determines whether the user group has any groups associated with it.
543            *
544            * @param pk the primary key of the user group to check for associations with groups
545            * @return whether the user group has any groups associated with it
546            * @throws SystemException if a system exception occurred
547            */
548            public boolean containsGroups(long pk)
549                    throws com.liferay.portal.kernel.exception.SystemException;
550    
551            /**
552            * Adds an association between the user group and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache.
553            *
554            * @param pk the primary key of the user group
555            * @param groupPK the primary key of the group
556            * @throws SystemException if a system exception occurred
557            */
558            public void addGroup(long pk, long groupPK)
559                    throws com.liferay.portal.kernel.exception.SystemException;
560    
561            /**
562            * Adds an association between the user group and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache.
563            *
564            * @param pk the primary key of the user group
565            * @param group the group
566            * @throws SystemException if a system exception occurred
567            */
568            public void addGroup(long pk, com.liferay.portal.model.Group group)
569                    throws com.liferay.portal.kernel.exception.SystemException;
570    
571            /**
572            * Adds an association between the user group and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.
573            *
574            * @param pk the primary key of the user group
575            * @param groupPKs the primary keys of the groups
576            * @throws SystemException if a system exception occurred
577            */
578            public void addGroups(long pk, long[] groupPKs)
579                    throws com.liferay.portal.kernel.exception.SystemException;
580    
581            /**
582            * Adds an association between the user group and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.
583            *
584            * @param pk the primary key of the user group
585            * @param groups the groups
586            * @throws SystemException if a system exception occurred
587            */
588            public void addGroups(long pk,
589                    java.util.List<com.liferay.portal.model.Group> groups)
590                    throws com.liferay.portal.kernel.exception.SystemException;
591    
592            /**
593            * Clears all associations between the user group and its groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.
594            *
595            * @param pk the primary key of the user group to clear the associated groups from
596            * @throws SystemException if a system exception occurred
597            */
598            public void clearGroups(long pk)
599                    throws com.liferay.portal.kernel.exception.SystemException;
600    
601            /**
602            * Removes the association between the user group and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache.
603            *
604            * @param pk the primary key of the user group
605            * @param groupPK the primary key of the group
606            * @throws SystemException if a system exception occurred
607            */
608            public void removeGroup(long pk, long groupPK)
609                    throws com.liferay.portal.kernel.exception.SystemException;
610    
611            /**
612            * Removes the association between the user group and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache.
613            *
614            * @param pk the primary key of the user group
615            * @param group the group
616            * @throws SystemException if a system exception occurred
617            */
618            public void removeGroup(long pk, com.liferay.portal.model.Group group)
619                    throws com.liferay.portal.kernel.exception.SystemException;
620    
621            /**
622            * Removes the association between the user group and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.
623            *
624            * @param pk the primary key of the user group
625            * @param groupPKs the primary keys of the groups
626            * @throws SystemException if a system exception occurred
627            */
628            public void removeGroups(long pk, long[] groupPKs)
629                    throws com.liferay.portal.kernel.exception.SystemException;
630    
631            /**
632            * Removes the association between the user group and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.
633            *
634            * @param pk the primary key of the user group
635            * @param groups the groups
636            * @throws SystemException if a system exception occurred
637            */
638            public void removeGroups(long pk,
639                    java.util.List<com.liferay.portal.model.Group> groups)
640                    throws com.liferay.portal.kernel.exception.SystemException;
641    
642            /**
643            * 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.
644            *
645            * @param pk the primary key of the user group to set the associations for
646            * @param groupPKs the primary keys of the groups to be associated with the user group
647            * @throws SystemException if a system exception occurred
648            */
649            public void setGroups(long pk, long[] groupPKs)
650                    throws com.liferay.portal.kernel.exception.SystemException;
651    
652            /**
653            * 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.
654            *
655            * @param pk the primary key of the user group to set the associations for
656            * @param groups the groups to be associated with the user group
657            * @throws SystemException if a system exception occurred
658            */
659            public void setGroups(long pk,
660                    java.util.List<com.liferay.portal.model.Group> groups)
661                    throws com.liferay.portal.kernel.exception.SystemException;
662    
663            /**
664            * Gets all the users associated with the user group.
665            *
666            * @param pk the primary key of the user group to get the associated users for
667            * @return the users associated with the user group
668            * @throws SystemException if a system exception occurred
669            */
670            public java.util.List<com.liferay.portal.model.User> getUsers(long pk)
671                    throws com.liferay.portal.kernel.exception.SystemException;
672    
673            /**
674            * Gets a range of all the users associated with the user group.
675            *
676            * <p>
677            * 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.
678            * </p>
679            *
680            * @param pk the primary key of the user group to get the associated users for
681            * @param start the lower bound of the range of user groups to return
682            * @param end the upper bound of the range of user groups to return (not inclusive)
683            * @return the range of users associated with the user group
684            * @throws SystemException if a system exception occurred
685            */
686            public java.util.List<com.liferay.portal.model.User> getUsers(long pk,
687                    int start, int end)
688                    throws com.liferay.portal.kernel.exception.SystemException;
689    
690            /**
691            * Gets an ordered range of all the users associated with the user group.
692            *
693            * <p>
694            * 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.
695            * </p>
696            *
697            * @param pk the primary key of the user group to get the associated users for
698            * @param start the lower bound of the range of user groups to return
699            * @param end the upper bound of the range of user groups to return (not inclusive)
700            * @param orderByComparator the comparator to order the results by
701            * @return the ordered range of users associated with the user group
702            * @throws SystemException if a system exception occurred
703            */
704            public java.util.List<com.liferay.portal.model.User> getUsers(long pk,
705                    int start, int end,
706                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
707                    throws com.liferay.portal.kernel.exception.SystemException;
708    
709            /**
710            * Gets the number of users associated with the user group.
711            *
712            * @param pk the primary key of the user group to get the number of associated users for
713            * @return the number of users associated with the user group
714            * @throws SystemException if a system exception occurred
715            */
716            public int getUsersSize(long pk)
717                    throws com.liferay.portal.kernel.exception.SystemException;
718    
719            /**
720            * Determines whether the user is associated with the user group.
721            *
722            * @param pk the primary key of the user group
723            * @param userPK the primary key of the user
724            * @return whether the user is associated with the user group
725            * @throws SystemException if a system exception occurred
726            */
727            public boolean containsUser(long pk, long userPK)
728                    throws com.liferay.portal.kernel.exception.SystemException;
729    
730            /**
731            * Determines whether the user group has any users associated with it.
732            *
733            * @param pk the primary key of the user group to check for associations with users
734            * @return whether the user group has any users associated with it
735            * @throws SystemException if a system exception occurred
736            */
737            public boolean containsUsers(long pk)
738                    throws com.liferay.portal.kernel.exception.SystemException;
739    
740            /**
741            * Adds an association between the user group and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.
742            *
743            * @param pk the primary key of the user group
744            * @param userPK the primary key of the user
745            * @throws SystemException if a system exception occurred
746            */
747            public void addUser(long pk, long userPK)
748                    throws com.liferay.portal.kernel.exception.SystemException;
749    
750            /**
751            * Adds an association between the user group and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.
752            *
753            * @param pk the primary key of the user group
754            * @param user the user
755            * @throws SystemException if a system exception occurred
756            */
757            public void addUser(long pk, com.liferay.portal.model.User user)
758                    throws com.liferay.portal.kernel.exception.SystemException;
759    
760            /**
761            * Adds an association between the user group and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.
762            *
763            * @param pk the primary key of the user group
764            * @param userPKs the primary keys of the users
765            * @throws SystemException if a system exception occurred
766            */
767            public void addUsers(long pk, long[] userPKs)
768                    throws com.liferay.portal.kernel.exception.SystemException;
769    
770            /**
771            * Adds an association between the user group and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.
772            *
773            * @param pk the primary key of the user group
774            * @param users the users
775            * @throws SystemException if a system exception occurred
776            */
777            public void addUsers(long pk,
778                    java.util.List<com.liferay.portal.model.User> users)
779                    throws com.liferay.portal.kernel.exception.SystemException;
780    
781            /**
782            * Clears all associations between the user group and its users. Also notifies the appropriate model listeners and clears the mapping table finder cache.
783            *
784            * @param pk the primary key of the user group to clear the associated users from
785            * @throws SystemException if a system exception occurred
786            */
787            public void clearUsers(long pk)
788                    throws com.liferay.portal.kernel.exception.SystemException;
789    
790            /**
791            * Removes the association between the user group and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.
792            *
793            * @param pk the primary key of the user group
794            * @param userPK the primary key of the user
795            * @throws SystemException if a system exception occurred
796            */
797            public void removeUser(long pk, long userPK)
798                    throws com.liferay.portal.kernel.exception.SystemException;
799    
800            /**
801            * Removes the association between the user group and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.
802            *
803            * @param pk the primary key of the user group
804            * @param user the user
805            * @throws SystemException if a system exception occurred
806            */
807            public void removeUser(long pk, com.liferay.portal.model.User user)
808                    throws com.liferay.portal.kernel.exception.SystemException;
809    
810            /**
811            * Removes the association between the user group and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.
812            *
813            * @param pk the primary key of the user group
814            * @param userPKs the primary keys of the users
815            * @throws SystemException if a system exception occurred
816            */
817            public void removeUsers(long pk, long[] userPKs)
818                    throws com.liferay.portal.kernel.exception.SystemException;
819    
820            /**
821            * Removes the association between the user group and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.
822            *
823            * @param pk the primary key of the user group
824            * @param users the users
825            * @throws SystemException if a system exception occurred
826            */
827            public void removeUsers(long pk,
828                    java.util.List<com.liferay.portal.model.User> users)
829                    throws com.liferay.portal.kernel.exception.SystemException;
830    
831            /**
832            * 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.
833            *
834            * @param pk the primary key of the user group to set the associations for
835            * @param userPKs the primary keys of the users to be associated with the user group
836            * @throws SystemException if a system exception occurred
837            */
838            public void setUsers(long pk, long[] userPKs)
839                    throws com.liferay.portal.kernel.exception.SystemException;
840    
841            /**
842            * 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.
843            *
844            * @param pk the primary key of the user group to set the associations for
845            * @param users the users to be associated with the user group
846            * @throws SystemException if a system exception occurred
847            */
848            public void setUsers(long pk,
849                    java.util.List<com.liferay.portal.model.User> users)
850                    throws com.liferay.portal.kernel.exception.SystemException;
851    }