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