001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.service;
016    
017    /**
018     * <p>
019     * This class is a wrapper for {@link GroupLocalService}.
020     * </p>
021     *
022     * @author    Brian Wing Shun Chan
023     * @see       GroupLocalService
024     * @generated
025     */
026    public class GroupLocalServiceWrapper implements GroupLocalService,
027            ServiceWrapper<GroupLocalService> {
028            public GroupLocalServiceWrapper(GroupLocalService groupLocalService) {
029                    _groupLocalService = groupLocalService;
030            }
031    
032            /**
033            * Adds the group to the database. Also notifies the appropriate model listeners.
034            *
035            * @param group the group
036            * @return the group that was added
037            * @throws SystemException if a system exception occurred
038            */
039            public com.liferay.portal.model.Group addGroup(
040                    com.liferay.portal.model.Group group)
041                    throws com.liferay.portal.kernel.exception.SystemException {
042                    return _groupLocalService.addGroup(group);
043            }
044    
045            /**
046            * Creates a new group with the primary key. Does not add the group to the database.
047            *
048            * @param groupId the primary key for the new group
049            * @return the new group
050            */
051            public com.liferay.portal.model.Group createGroup(long groupId) {
052                    return _groupLocalService.createGroup(groupId);
053            }
054    
055            /**
056            * Deletes the group with the primary key from the database. Also notifies the appropriate model listeners.
057            *
058            * @param groupId the primary key of the group
059            * @return the group that was removed
060            * @throws PortalException if a group with the primary key could not be found
061            * @throws SystemException if a system exception occurred
062            */
063            public com.liferay.portal.model.Group deleteGroup(long groupId)
064                    throws com.liferay.portal.kernel.exception.PortalException,
065                            com.liferay.portal.kernel.exception.SystemException {
066                    return _groupLocalService.deleteGroup(groupId);
067            }
068    
069            /**
070            * Deletes the group from the database. Also notifies the appropriate model listeners.
071            *
072            * @param group the group
073            * @return the group that was removed
074            * @throws PortalException
075            * @throws SystemException if a system exception occurred
076            */
077            public com.liferay.portal.model.Group deleteGroup(
078                    com.liferay.portal.model.Group group)
079                    throws com.liferay.portal.kernel.exception.PortalException,
080                            com.liferay.portal.kernel.exception.SystemException {
081                    return _groupLocalService.deleteGroup(group);
082            }
083    
084            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
085                    return _groupLocalService.dynamicQuery();
086            }
087    
088            /**
089            * Performs a dynamic query on the database and returns the matching rows.
090            *
091            * @param dynamicQuery the dynamic query
092            * @return the matching rows
093            * @throws SystemException if a system exception occurred
094            */
095            @SuppressWarnings("rawtypes")
096            public java.util.List dynamicQuery(
097                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
098                    throws com.liferay.portal.kernel.exception.SystemException {
099                    return _groupLocalService.dynamicQuery(dynamicQuery);
100            }
101    
102            /**
103            * Performs a dynamic query on the database and returns a range of the matching rows.
104            *
105            * <p>
106            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.GroupModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
107            * </p>
108            *
109            * @param dynamicQuery the dynamic query
110            * @param start the lower bound of the range of model instances
111            * @param end the upper bound of the range of model instances (not inclusive)
112            * @return the range of matching rows
113            * @throws SystemException if a system exception occurred
114            */
115            @SuppressWarnings("rawtypes")
116            public java.util.List dynamicQuery(
117                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
118                    int end) throws com.liferay.portal.kernel.exception.SystemException {
119                    return _groupLocalService.dynamicQuery(dynamicQuery, start, end);
120            }
121    
122            /**
123            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
124            *
125            * <p>
126            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.GroupModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
127            * </p>
128            *
129            * @param dynamicQuery the dynamic query
130            * @param start the lower bound of the range of model instances
131            * @param end the upper bound of the range of model instances (not inclusive)
132            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
133            * @return the ordered range of matching rows
134            * @throws SystemException if a system exception occurred
135            */
136            @SuppressWarnings("rawtypes")
137            public java.util.List dynamicQuery(
138                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
139                    int end,
140                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
141                    throws com.liferay.portal.kernel.exception.SystemException {
142                    return _groupLocalService.dynamicQuery(dynamicQuery, start, end,
143                            orderByComparator);
144            }
145    
146            /**
147            * Returns the number of rows that match the dynamic query.
148            *
149            * @param dynamicQuery the dynamic query
150            * @return the number of rows that match the dynamic query
151            * @throws SystemException if a system exception occurred
152            */
153            public long dynamicQueryCount(
154                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
155                    throws com.liferay.portal.kernel.exception.SystemException {
156                    return _groupLocalService.dynamicQueryCount(dynamicQuery);
157            }
158    
159            public com.liferay.portal.model.Group fetchGroup(long groupId)
160                    throws com.liferay.portal.kernel.exception.SystemException {
161                    return _groupLocalService.fetchGroup(groupId);
162            }
163    
164            /**
165            * Returns the group with the primary key.
166            *
167            * @param groupId the primary key of the group
168            * @return the group
169            * @throws PortalException if a group with the primary key could not be found
170            * @throws SystemException if a system exception occurred
171            */
172            public com.liferay.portal.model.Group getGroup(long groupId)
173                    throws com.liferay.portal.kernel.exception.PortalException,
174                            com.liferay.portal.kernel.exception.SystemException {
175                    return _groupLocalService.getGroup(groupId);
176            }
177    
178            public com.liferay.portal.model.PersistedModel getPersistedModel(
179                    java.io.Serializable primaryKeyObj)
180                    throws com.liferay.portal.kernel.exception.PortalException,
181                            com.liferay.portal.kernel.exception.SystemException {
182                    return _groupLocalService.getPersistedModel(primaryKeyObj);
183            }
184    
185            /**
186            * Returns a range of all the groups.
187            *
188            * <p>
189            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.GroupModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
190            * </p>
191            *
192            * @param start the lower bound of the range of groups
193            * @param end the upper bound of the range of groups (not inclusive)
194            * @return the range of groups
195            * @throws SystemException if a system exception occurred
196            */
197            public java.util.List<com.liferay.portal.model.Group> getGroups(int start,
198                    int end) throws com.liferay.portal.kernel.exception.SystemException {
199                    return _groupLocalService.getGroups(start, end);
200            }
201    
202            /**
203            * Returns the number of groups.
204            *
205            * @return the number of groups
206            * @throws SystemException if a system exception occurred
207            */
208            public int getGroupsCount()
209                    throws com.liferay.portal.kernel.exception.SystemException {
210                    return _groupLocalService.getGroupsCount();
211            }
212    
213            /**
214            * Updates the group in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
215            *
216            * @param group the group
217            * @return the group that was updated
218            * @throws SystemException if a system exception occurred
219            */
220            public com.liferay.portal.model.Group updateGroup(
221                    com.liferay.portal.model.Group group)
222                    throws com.liferay.portal.kernel.exception.SystemException {
223                    return _groupLocalService.updateGroup(group);
224            }
225    
226            /**
227            * Returns the Spring bean ID for this bean.
228            *
229            * @return the Spring bean ID for this bean
230            */
231            public java.lang.String getBeanIdentifier() {
232                    return _groupLocalService.getBeanIdentifier();
233            }
234    
235            /**
236            * Sets the Spring bean ID for this bean.
237            *
238            * @param beanIdentifier the Spring bean ID for this bean
239            */
240            public void setBeanIdentifier(java.lang.String beanIdentifier) {
241                    _groupLocalService.setBeanIdentifier(beanIdentifier);
242            }
243    
244            /**
245            * Adds a group.
246            *
247            * @param userId the primary key of the group's creator/owner
248            * @param parentGroupId the primary key of the parent group
249            * @param className the entity's class name
250            * @param classPK the primary key of the entity's instance
251            * @param liveGroupId the primary key of the live group
252            * @param name the entity's name
253            * @param description the group's description (optionally
254            <code>null</code>)
255            * @param type the group's type. For more information see {@link
256            com.liferay.portal.model.GroupConstants}
257            * @param friendlyURL the group's friendlyURL (optionally
258            <code>null</code>)
259            * @param site whether the group is to be associated with a main site
260            * @param active whether the group is active
261            * @param serviceContext the service context to be applied (optionally
262            <code>null</code>). Can set asset category IDs and asset tag
263            names for the group, and whether the group is for staging.
264            * @return the group
265            * @throws PortalException if a creator could not be found, if the group's
266            information was invalid, if a layout could not be found, or if a
267            valid friendly URL could not be created for the group
268            * @throws SystemException if a system exception occurred
269            */
270            public com.liferay.portal.model.Group addGroup(long userId,
271                    long parentGroupId, java.lang.String className, long classPK,
272                    long liveGroupId, java.lang.String name, java.lang.String description,
273                    int type, java.lang.String friendlyURL, boolean site, boolean active,
274                    com.liferay.portal.service.ServiceContext serviceContext)
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException {
277                    return _groupLocalService.addGroup(userId, parentGroupId, className,
278                            classPK, liveGroupId, name, description, type, friendlyURL, site,
279                            active, serviceContext);
280            }
281    
282            /**
283            * Adds the group using the default live group.
284            *
285            * @param userId the primary key of the group's creator/owner
286            * @param parentGroupId the primary key of the parent group
287            * @param className the entity's class name
288            * @param classPK the primary key of the entity's instance
289            * @param name the entity's name
290            * @param description the group's description (optionally
291            <code>null</code>)
292            * @param type the group's type. For more information see {@link
293            com.liferay.portal.model.GroupConstants}
294            * @param friendlyURL the group's friendlyURL
295            * @param site whether the group is to be associated with a main site
296            * @param active whether the group is active
297            * @param serviceContext the service context to be applied (optionally
298            <code>null</code>). Can set asset category IDs and asset tag
299            names for the group, and whether the group is for staging.
300            * @return the group
301            * @throws PortalException if a creator could not be found, if the
302            group's information was invalid, if a layout could not be
303            found, or if a valid friendly URL could not be created for
304            the group
305            * @throws SystemException if a system exception occurred
306            * @deprecated {@link #addGroup(long, long, String, long, long, String,
307            String, int, String, boolean, boolean, ServiceContext)}
308            */
309            public com.liferay.portal.model.Group addGroup(long userId,
310                    long parentGroupId, java.lang.String className, long classPK,
311                    java.lang.String name, java.lang.String description, int type,
312                    java.lang.String friendlyURL, boolean site, boolean active,
313                    com.liferay.portal.service.ServiceContext serviceContext)
314                    throws com.liferay.portal.kernel.exception.PortalException,
315                            com.liferay.portal.kernel.exception.SystemException {
316                    return _groupLocalService.addGroup(userId, parentGroupId, className,
317                            classPK, name, description, type, friendlyURL, site, active,
318                            serviceContext);
319            }
320    
321            /**
322            * Adds the groups to the role.
323            *
324            * @param roleId the primary key of the role
325            * @param groupIds the primary keys of the groups
326            * @throws SystemException if a system exception occurred
327            */
328            public void addRoleGroups(long roleId, long[] groupIds)
329                    throws com.liferay.portal.kernel.exception.SystemException {
330                    _groupLocalService.addRoleGroups(roleId, groupIds);
331            }
332    
333            /**
334            * Adds the user to the groups.
335            *
336            * @param userId the primary key of the user
337            * @param groupIds the primary keys of the groups
338            * @throws SystemException if a system exception occurred
339            */
340            public void addUserGroups(long userId, long[] groupIds)
341                    throws com.liferay.portal.kernel.exception.SystemException {
342                    _groupLocalService.addUserGroups(userId, groupIds);
343            }
344    
345            /**
346            * Adds a company group if it does not exist. This method is typically used
347            * when a virtual host is added.
348            *
349            * @param companyId the primary key of the company
350            * @throws PortalException if a default user for the company could not be
351            found, if the group's information was invalid, if a layout could
352            not be found, or if a valid friendly URL could not be created for
353            the group
354            * @throws SystemException if a system exception occurred
355            */
356            public void checkCompanyGroup(long companyId)
357                    throws com.liferay.portal.kernel.exception.PortalException,
358                            com.liferay.portal.kernel.exception.SystemException {
359                    _groupLocalService.checkCompanyGroup(companyId);
360            }
361    
362            public void checkMembershipPolicy(com.liferay.portal.model.User user)
363                    throws com.liferay.portal.kernel.exception.SystemException {
364                    _groupLocalService.checkMembershipPolicy(user);
365            }
366    
367            /**
368            * Creates systems groups and other related data needed by the system on the
369            * very first startup. Also takes care of creating the Control Panel groups
370            * and layouts.
371            *
372            * @param companyId the primary key of the company
373            * @throws PortalException if a new system group could not be created
374            * @throws SystemException if a system exception occurred
375            */
376            public void checkSystemGroups(long companyId)
377                    throws com.liferay.portal.kernel.exception.PortalException,
378                            com.liferay.portal.kernel.exception.SystemException {
379                    _groupLocalService.checkSystemGroups(companyId);
380            }
381    
382            /**
383            * Returns the group with the matching friendly URL.
384            *
385            * @param companyId the primary key of the company
386            * @param friendlyURL the friendly URL
387            * @return the group with the friendly URL, or <code>null</code> if a
388            matching group could not be found
389            * @throws SystemException if a system exception occurred
390            */
391            public com.liferay.portal.model.Group fetchFriendlyURLGroup(
392                    long companyId, java.lang.String friendlyURL)
393                    throws com.liferay.portal.kernel.exception.SystemException {
394                    return _groupLocalService.fetchFriendlyURLGroup(companyId, friendlyURL);
395            }
396    
397            /**
398            * Returns the group with the matching group name by first searching the
399            * system groups and then using the finder cache.
400            *
401            * @param companyId the primary key of the company
402            * @param name the group's name
403            * @return the group with the name and associated company, or
404            <code>null</code> if a matching group could not be found
405            * @throws SystemException if a system exception occurred
406            */
407            public com.liferay.portal.model.Group fetchGroup(long companyId,
408                    java.lang.String name)
409                    throws com.liferay.portal.kernel.exception.SystemException {
410                    return _groupLocalService.fetchGroup(companyId, name);
411            }
412    
413            /**
414            * Returns the company group.
415            *
416            * @param companyId the primary key of the company
417            * @return the group associated with the company
418            * @throws PortalException if a matching group could not be found
419            * @throws SystemException if a system exception occurred
420            */
421            public com.liferay.portal.model.Group getCompanyGroup(long companyId)
422                    throws com.liferay.portal.kernel.exception.PortalException,
423                            com.liferay.portal.kernel.exception.SystemException {
424                    return _groupLocalService.getCompanyGroup(companyId);
425            }
426    
427            /**
428            * Returns a range of all the groups associated with the company.
429            *
430            * <p>
431            * Useful when paginating results. Returns a maximum of <code>end -
432            * start</code> instances. <code>start</code> and <code>end</code> are not
433            * primary keys, they are indexes in the result set. Thus, <code>0</code>
434            * refers to the first result in the set. Setting both <code>start</code>
435            * and <code>end</code> to {@link
436            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
437            * result set.
438            * </p>
439            *
440            * @param companyId the primary key of the company
441            * @param start the lower bound of the range of groups to return
442            * @param end the upper bound of the range of groups to return (not
443            inclusive)
444            * @return the range of groups associated with the company
445            * @throws SystemException if a system exception occurred
446            */
447            public java.util.List<com.liferay.portal.model.Group> getCompanyGroups(
448                    long companyId, int start, int end)
449                    throws com.liferay.portal.kernel.exception.SystemException {
450                    return _groupLocalService.getCompanyGroups(companyId, start, end);
451            }
452    
453            /**
454            * Returns the number of groups associated with the company.
455            *
456            * @param companyId the primary key of the company
457            * @return the number of groups associated with the company
458            * @throws SystemException if a system exception occurred
459            */
460            public int getCompanyGroupsCount(long companyId)
461                    throws com.liferay.portal.kernel.exception.SystemException {
462                    return _groupLocalService.getCompanyGroupsCount(companyId);
463            }
464    
465            /**
466            * Returns the group with the matching friendly URL.
467            *
468            * @param companyId the primary key of the company
469            * @param friendlyURL the group's friendlyURL
470            * @return the group with the friendly URL
471            * @throws PortalException if a matching group could not be found, or if the
472            friendly URL was invalid
473            * @throws SystemException if a system exception occurred
474            */
475            public com.liferay.portal.model.Group getFriendlyURLGroup(long companyId,
476                    java.lang.String friendlyURL)
477                    throws com.liferay.portal.kernel.exception.PortalException,
478                            com.liferay.portal.kernel.exception.SystemException {
479                    return _groupLocalService.getFriendlyURLGroup(companyId, friendlyURL);
480            }
481    
482            /**
483            * Returns the group with the matching group name.
484            *
485            * @param companyId the primary key of the company
486            * @param name the group's name
487            * @return the group with the name
488            * @throws PortalException if a matching group could not be found
489            * @throws SystemException if a system exception occurred
490            */
491            public com.liferay.portal.model.Group getGroup(long companyId,
492                    java.lang.String name)
493                    throws com.liferay.portal.kernel.exception.PortalException,
494                            com.liferay.portal.kernel.exception.SystemException {
495                    return _groupLocalService.getGroup(companyId, name);
496            }
497    
498            public java.lang.String getGroupDescriptiveName(
499                    com.liferay.portal.model.Group group, java.util.Locale locale)
500                    throws com.liferay.portal.kernel.exception.PortalException,
501                            com.liferay.portal.kernel.exception.SystemException {
502                    return _groupLocalService.getGroupDescriptiveName(group, locale);
503            }
504    
505            public java.lang.String getGroupDescriptiveName(long groupId,
506                    java.util.Locale locale)
507                    throws com.liferay.portal.kernel.exception.PortalException,
508                            com.liferay.portal.kernel.exception.SystemException {
509                    return _groupLocalService.getGroupDescriptiveName(groupId, locale);
510            }
511    
512            /**
513            * Returns all the groups that are direct children of the parent group.
514            *
515            * @param companyId the primary key of the company
516            * @param parentGroupId the primary key of the parent group
517            * @param site whether the group is to be associated with a main site
518            * @return the matching groups, or <code>null</code> if no matches were
519            found
520            * @throws SystemException if a system exception occurred
521            */
522            public java.util.List<com.liferay.portal.model.Group> getGroups(
523                    long companyId, long parentGroupId, boolean site)
524                    throws com.liferay.portal.kernel.exception.SystemException {
525                    return _groupLocalService.getGroups(companyId, parentGroupId, site);
526            }
527    
528            public java.util.List<com.liferay.portal.model.Group> getGroups(
529                    long companyId, java.lang.String className, long parentGroupId)
530                    throws com.liferay.portal.kernel.exception.SystemException {
531                    return _groupLocalService.getGroups(companyId, className, parentGroupId);
532            }
533    
534            public java.util.List<com.liferay.portal.model.Group> getGroups(
535                    long companyId, java.lang.String className, long parentGroupId,
536                    int start, int end)
537                    throws com.liferay.portal.kernel.exception.SystemException {
538                    return _groupLocalService.getGroups(companyId, className,
539                            parentGroupId, start, end);
540            }
541    
542            /**
543            * Returns the groups with the matching primary keys.
544            *
545            * @param groupIds the primary keys of the groups
546            * @return the groups with the primary keys
547            * @throws PortalException if any one of the groups could not be found
548            * @throws SystemException if a system exception occurred
549            */
550            public java.util.List<com.liferay.portal.model.Group> getGroups(
551                    long[] groupIds)
552                    throws com.liferay.portal.kernel.exception.PortalException,
553                            com.liferay.portal.kernel.exception.SystemException {
554                    return _groupLocalService.getGroups(groupIds);
555            }
556    
557            /**
558            * Returns the number of groups that are direct children of the parent
559            * group.
560            *
561            * @param companyId the primary key of the company
562            * @param parentGroupId the primary key of the parent group
563            * @param site whether the group is to be associated with a main site
564            * @return the number of matching groups
565            * @throws SystemException if a system exception occurred
566            */
567            public int getGroupsCount(long companyId, long parentGroupId, boolean site)
568                    throws com.liferay.portal.kernel.exception.SystemException {
569                    return _groupLocalService.getGroupsCount(companyId, parentGroupId, site);
570            }
571    
572            public int getGroupsCount(long companyId, java.lang.String className,
573                    long parentGroupId)
574                    throws com.liferay.portal.kernel.exception.SystemException {
575                    return _groupLocalService.getGroupsCount(companyId, className,
576                            parentGroupId);
577            }
578    
579            /**
580            * Returns the group associated with the layout.
581            *
582            * @param companyId the primary key of the company
583            * @param plid the primary key of the layout
584            * @return the group associated with the layout
585            * @throws PortalException if a matching group could not be found
586            * @throws SystemException if a system exception occurred
587            */
588            public com.liferay.portal.model.Group getLayoutGroup(long companyId,
589                    long plid)
590                    throws com.liferay.portal.kernel.exception.PortalException,
591                            com.liferay.portal.kernel.exception.SystemException {
592                    return _groupLocalService.getLayoutGroup(companyId, plid);
593            }
594    
595            /**
596            * Returns the group associated with the layout prototype.
597            *
598            * @param companyId the primary key of the company
599            * @param layoutPrototypeId the primary key of the layout prototype
600            * @return the group associated with the layout prototype
601            * @throws PortalException if a matching group could not be found
602            * @throws SystemException if a system exception occurred
603            */
604            public com.liferay.portal.model.Group getLayoutPrototypeGroup(
605                    long companyId, long layoutPrototypeId)
606                    throws com.liferay.portal.kernel.exception.PortalException,
607                            com.liferay.portal.kernel.exception.SystemException {
608                    return _groupLocalService.getLayoutPrototypeGroup(companyId,
609                            layoutPrototypeId);
610            }
611    
612            /**
613            * Returns the group associated with the layout set prototype.
614            *
615            * @param companyId the primary key of the company
616            * @param layoutSetPrototypeId the primary key of the layout set prototype
617            * @return the group associated with the layout set prototype
618            * @throws PortalException if a matching group could not be found
619            * @throws SystemException if a system exception occurred
620            */
621            public com.liferay.portal.model.Group getLayoutSetPrototypeGroup(
622                    long companyId, long layoutSetPrototypeId)
623                    throws com.liferay.portal.kernel.exception.PortalException,
624                            com.liferay.portal.kernel.exception.SystemException {
625                    return _groupLocalService.getLayoutSetPrototypeGroup(companyId,
626                            layoutSetPrototypeId);
627            }
628    
629            /**
630            * Returns a range of all groups that are children of the parent group and
631            * that have at least one layout.
632            *
633            * <p>
634            * Useful when paginating results. Returns a maximum of <code>end -
635            * start</code> instances. <code>start</code> and <code>end</code> are not
636            * primary keys, they are indexes in the result set. Thus, <code>0</code>
637            * refers to the first result in the set. Setting both <code>start</code>
638            * and <code>end</code> to {@link
639            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
640            * result set.
641            * </p>
642            *
643            * @param companyId the primary key of the company
644            * @param parentGroupId the primary key of the parent group
645            * @param site whether the group is to be associated with a main site
646            * @param start the lower bound of the range of groups to return
647            * @param end the upper bound of the range of groups to return (not
648            inclusive)
649            * @return the range of matching groups
650            * @throws SystemException if a system exception occurred
651            */
652            public java.util.List<com.liferay.portal.model.Group> getLayoutsGroups(
653                    long companyId, long parentGroupId, boolean site, int start, int end)
654                    throws com.liferay.portal.kernel.exception.SystemException {
655                    return _groupLocalService.getLayoutsGroups(companyId, parentGroupId,
656                            site, start, end);
657            }
658    
659            /**
660            * Returns the number of groups that are children or the parent group and
661            * that have at least one layout
662            *
663            * @param companyId the primary key of the company
664            * @param parentGroupId the primary key of the parent group
665            * @param site whether the group is to be associated with a main site
666            * @return the number of matching groups
667            * @throws SystemException if a system exception occurred
668            */
669            public int getLayoutsGroupsCount(long companyId, long parentGroupId,
670                    boolean site)
671                    throws com.liferay.portal.kernel.exception.SystemException {
672                    return _groupLocalService.getLayoutsGroupsCount(companyId,
673                            parentGroupId, site);
674            }
675    
676            /**
677            * Returns all live groups.
678            *
679            * @return all live groups
680            * @throws SystemException if a system exception occurred
681            */
682            public java.util.List<com.liferay.portal.model.Group> getLiveGroups()
683                    throws com.liferay.portal.kernel.exception.SystemException {
684                    return _groupLocalService.getLiveGroups();
685            }
686    
687            /**
688            * Returns a range of all non-system groups of a specified type (className)
689            * that have no layouts.
690            *
691            * <p>
692            * Useful when paginating results. Returns a maximum of <code>end -
693            * start</code> instances. <code>start</code> and <code>end</code> are not
694            * primary keys, they are indexes in the result set. Thus, <code>0</code>
695            * refers to the first result in the set. Setting both <code>start</code>
696            * and <code>end</code> to {@link
697            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
698            * result set.
699            * </p>
700            *
701            * @param className the entity's class name
702            * @param privateLayout whether to include groups with private layout sets
703            or non-private layout sets
704            * @param start the lower bound of the range of groups to return
705            * @param end the upper bound of the range of groups to return (not
706            inclusive)
707            * @return the range of matching groups
708            * @throws SystemException if a system exception occurred
709            */
710            public java.util.List<com.liferay.portal.model.Group> getNoLayoutsGroups(
711                    java.lang.String className, boolean privateLayout, int start, int end)
712                    throws com.liferay.portal.kernel.exception.SystemException {
713                    return _groupLocalService.getNoLayoutsGroups(className, privateLayout,
714                            start, end);
715            }
716    
717            /**
718            * Returns all non-system groups having <code>null</code> or empty friendly
719            * URLs.
720            *
721            * @return the non-system groups having <code>null</code> or empty friendly
722            URLs
723            * @throws SystemException if a system exception occurred
724            */
725            public java.util.List<com.liferay.portal.model.Group> getNullFriendlyURLGroups()
726                    throws com.liferay.portal.kernel.exception.SystemException {
727                    return _groupLocalService.getNullFriendlyURLGroups();
728            }
729    
730            /**
731            * Returns the specified organization group.
732            *
733            * @param companyId the primary key of the company
734            * @param organizationId the primary key of the organization
735            * @return the group associated with the organization
736            * @throws PortalException if a matching group could not be found
737            * @throws SystemException if a system exception occurred
738            */
739            public com.liferay.portal.model.Group getOrganizationGroup(long companyId,
740                    long organizationId)
741                    throws com.liferay.portal.kernel.exception.PortalException,
742                            com.liferay.portal.kernel.exception.SystemException {
743                    return _groupLocalService.getOrganizationGroup(companyId, organizationId);
744            }
745    
746            /**
747            * Returns the specified organization groups.
748            *
749            * @param organizations the organizations
750            * @return the groups associated with the organizations
751            */
752            public java.util.List<com.liferay.portal.model.Group> getOrganizationsGroups(
753                    java.util.List<com.liferay.portal.model.Organization> organizations) {
754                    return _groupLocalService.getOrganizationsGroups(organizations);
755            }
756    
757            /**
758            * Returns all the groups related to the organizations.
759            *
760            * @param organizations the organizations
761            * @return the groups related to the organizations
762            * @throws SystemException if a system exception occurred
763            */
764            public java.util.List<com.liferay.portal.model.Group> getOrganizationsRelatedGroups(
765                    java.util.List<com.liferay.portal.model.Organization> organizations)
766                    throws com.liferay.portal.kernel.exception.SystemException {
767                    return _groupLocalService.getOrganizationsRelatedGroups(organizations);
768            }
769    
770            /**
771            * Returns all the groups associated with the role.
772            *
773            * @param roleId the primary key of the role
774            * @return the groups associated with the role
775            * @throws SystemException if a system exception occurred
776            */
777            public java.util.List<com.liferay.portal.model.Group> getRoleGroups(
778                    long roleId) throws com.liferay.portal.kernel.exception.SystemException {
779                    return _groupLocalService.getRoleGroups(roleId);
780            }
781    
782            /**
783            * Returns the staging group.
784            *
785            * @param liveGroupId the primary key of the live group
786            * @return the staging group
787            * @throws PortalException if a matching staging group could not be found
788            * @throws SystemException if a system exception occurred
789            */
790            public com.liferay.portal.model.Group getStagingGroup(long liveGroupId)
791                    throws com.liferay.portal.kernel.exception.PortalException,
792                            com.liferay.portal.kernel.exception.SystemException {
793                    return _groupLocalService.getStagingGroup(liveGroupId);
794            }
795    
796            /**
797            * Returns the group associated with the user.
798            *
799            * @param companyId the primary key of the company
800            * @param userId the primary key of the user
801            * @return the group associated with the user
802            * @throws PortalException if a matching group could not be found
803            * @throws SystemException if a system exception occurred
804            */
805            public com.liferay.portal.model.Group getUserGroup(long companyId,
806                    long userId)
807                    throws com.liferay.portal.kernel.exception.PortalException,
808                            com.liferay.portal.kernel.exception.SystemException {
809                    return _groupLocalService.getUserGroup(companyId, userId);
810            }
811    
812            /**
813            * Returns the specified "user group" group. That is, the group that
814            * represents the {@link com.liferay.portal.model.UserGroup} entity.
815            *
816            * @param companyId the primary key of the company
817            * @param userGroupId the primary key of the user group
818            * @return the group associated with the user group
819            * @throws PortalException if a matching group could not be found
820            * @throws SystemException if a system exception occurred
821            */
822            public com.liferay.portal.model.Group getUserGroupGroup(long companyId,
823                    long userGroupId)
824                    throws com.liferay.portal.kernel.exception.PortalException,
825                            com.liferay.portal.kernel.exception.SystemException {
826                    return _groupLocalService.getUserGroupGroup(companyId, userGroupId);
827            }
828    
829            /**
830            * Returns all the user's site groups and immediate organization groups.
831            * System and staged groups are not included.
832            *
833            * @param userId the primary key of the user
834            * @return the user's groups and organization groups
835            * @throws PortalException if a user with the primary key could not be found
836            * @throws SystemException if a system exception occurred
837            */
838            public java.util.List<com.liferay.portal.model.Group> getUserGroups(
839                    long userId)
840                    throws com.liferay.portal.kernel.exception.PortalException,
841                            com.liferay.portal.kernel.exception.SystemException {
842                    return _groupLocalService.getUserGroups(userId);
843            }
844    
845            /**
846            * Returns all the user's site groups and immediate organization groups,
847            * optionally including the user's inherited organization groups and user
848            * groups. System and staged groups are not included.
849            *
850            * @param userId the primary key of the user
851            * @param inherit whether to include the user's inherited organization
852            groups and user groups
853            * @return the user's groups and immediate organization groups
854            * @throws PortalException if a user with the primary key could not be found
855            * @throws SystemException if a system exception occurred
856            */
857            public java.util.List<com.liferay.portal.model.Group> getUserGroups(
858                    long userId, boolean inherit)
859                    throws com.liferay.portal.kernel.exception.PortalException,
860                            com.liferay.portal.kernel.exception.SystemException {
861                    return _groupLocalService.getUserGroups(userId, inherit);
862            }
863    
864            /**
865            * Returns an ordered range of all the user's site groups and immediate
866            * organization groups, optionally including the user's inherited
867            * organization groups and user groups. System and staged groups are not
868            * included.
869            *
870            * <p>
871            * Useful when paginating results. Returns a maximum of <code>end -
872            * start</code> instances. <code>start</code> and <code>end</code> are not
873            * primary keys, they are indexes in the result set. Thus, <code>0</code>
874            * refers to the first result in the set. Setting both <code>start</code>
875            * and <code>end</code> to {@link
876            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
877            * result set.
878            * </p>
879            *
880            * @param userId the primary key of the user
881            * @param inherit whether to include the user's inherited organization
882            groups and user groups
883            * @param start the lower bound of the range of groups to return
884            * @param end the upper bound of the range of groups to return (not
885            inclusive)
886            * @return the range of the user's groups and immediate organization groups
887            ordered by name
888            * @throws PortalException if a user with the primary key could not be found
889            * @throws SystemException if a system exception occurred
890            */
891            public java.util.List<com.liferay.portal.model.Group> getUserGroups(
892                    long userId, boolean inherit, int start, int end)
893                    throws com.liferay.portal.kernel.exception.PortalException,
894                            com.liferay.portal.kernel.exception.SystemException {
895                    return _groupLocalService.getUserGroups(userId, inherit, start, end);
896            }
897    
898            /**
899            * Returns an ordered range of all the user's site groups and immediate
900            * organization groups. System and staged groups are not included.
901            *
902            * <p>
903            * Useful when paginating results. Returns a maximum of <code>end -
904            * start</code> instances. <code>start</code> and <code>end</code> are not
905            * primary keys, they are indexes in the result set. Thus, <code>0</code>
906            * refers to the first result in the set. Setting both <code>start</code>
907            * and <code>end</code> to {@link
908            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
909            * result set.
910            * </p>
911            *
912            * @param userId the primary key of the user
913            * @param start the lower bound of the range of groups to return
914            * @param end the upper bound of the range of groups to return (not
915            inclusive)
916            * @return the range of the user's groups and organization groups ordered by
917            name
918            * @throws PortalException if a user with the primary key could not be found
919            * @throws SystemException if a system exception occurred
920            */
921            public java.util.List<com.liferay.portal.model.Group> getUserGroups(
922                    long userId, int start, int end)
923                    throws com.liferay.portal.kernel.exception.PortalException,
924                            com.liferay.portal.kernel.exception.SystemException {
925                    return _groupLocalService.getUserGroups(userId, start, end);
926            }
927    
928            /**
929            * Returns the groups associated with the user groups.
930            *
931            * @param userGroups the user groups
932            * @return the groups associated with the user groups
933            * @throws PortalException if any one of the user group's group could not be
934            found
935            * @throws SystemException if a system exception occurred
936            */
937            public java.util.List<com.liferay.portal.model.Group> getUserGroupsGroups(
938                    java.util.List<com.liferay.portal.model.UserGroup> userGroups)
939                    throws com.liferay.portal.kernel.exception.PortalException,
940                            com.liferay.portal.kernel.exception.SystemException {
941                    return _groupLocalService.getUserGroupsGroups(userGroups);
942            }
943    
944            /**
945            * Returns all the groups related to the user groups.
946            *
947            * @param userGroups the user groups
948            * @return the groups related to the user groups
949            * @throws SystemException if a system exception occurred
950            */
951            public java.util.List<com.liferay.portal.model.Group> getUserGroupsRelatedGroups(
952                    java.util.List<com.liferay.portal.model.UserGroup> userGroups)
953                    throws com.liferay.portal.kernel.exception.SystemException {
954                    return _groupLocalService.getUserGroupsRelatedGroups(userGroups);
955            }
956    
957            /**
958            * Returns the range of all groups associated with the user's organization
959            * groups, including the ancestors of the organization groups, unless portal
960            * property <code>organizations.membership.strict</code> is set to
961            * <code>true</code>.
962            *
963            * <p>
964            * Useful when paginating results. Returns a maximum of <code>end -
965            * start</code> instances. <code>start</code> and <code>end</code> are not
966            * primary keys, they are indexes in the result set. Thus, <code>0</code>
967            * refers to the first result in the set. Setting both <code>start</code>
968            * and <code>end</code> to {@link
969            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
970            * result set.
971            * </p>
972            *
973            * @param userId the primary key of the user
974            * @param start the lower bound of the range of groups to consider
975            * @param end the upper bound of the range of groups to consider (not
976            inclusive)
977            * @return the range of groups associated with the user's organization
978            groups
979            * @throws PortalException if a user with the primary key could not be found
980            or if another portal exception occurred
981            * @throws SystemException if a system exception occurred
982            */
983            public java.util.List<com.liferay.portal.model.Group> getUserOrganizationsGroups(
984                    long userId, int start, int end)
985                    throws com.liferay.portal.kernel.exception.PortalException,
986                            com.liferay.portal.kernel.exception.SystemException {
987                    return _groupLocalService.getUserOrganizationsGroups(userId, start, end);
988            }
989    
990            /**
991            * Returns <code>true</code> if the group is associated with the role.
992            *
993            * @param roleId the primary key of the role
994            * @param groupId the primary key of the group
995            * @return <code>true</code> if the group is associated with the role;
996            <code>false</code> otherwise
997            * @throws SystemException if a system exception occurred
998            */
999            public boolean hasRoleGroup(long roleId, long groupId)
1000                    throws com.liferay.portal.kernel.exception.SystemException {
1001                    return _groupLocalService.hasRoleGroup(roleId, groupId);
1002            }
1003    
1004            /**
1005            * Returns <code>true</code> if the live group has a staging group.
1006            *
1007            * @param liveGroupId the primary key of the live group
1008            * @return <code>true</code> if the live group has a staging group;
1009            <code>false</code> otherwise
1010            * @throws SystemException if a system exception occurred
1011            */
1012            public boolean hasStagingGroup(long liveGroupId)
1013                    throws com.liferay.portal.kernel.exception.SystemException {
1014                    return _groupLocalService.hasStagingGroup(liveGroupId);
1015            }
1016    
1017            /**
1018            * Returns <code>true</code> if the user is immediately associated with the
1019            * group, or associated with the group via the user's organizations,
1020            * inherited organizations, or user groups.
1021            *
1022            * @param userId the primary key of the user
1023            * @param groupId the primary key of the group
1024            * @return <code>true</code> if the user is associated with the group;
1025            <code>false</code> otherwise
1026            * @throws SystemException if a system exception occurred
1027            */
1028            public boolean hasUserGroup(long userId, long groupId)
1029                    throws com.liferay.portal.kernel.exception.SystemException {
1030                    return _groupLocalService.hasUserGroup(userId, groupId);
1031            }
1032    
1033            /**
1034            * Returns <code>true</code> if the user is immediately associated with the
1035            * group, or optionally if the user is associated with the group via the
1036            * user's organizations, inherited organizations, or user groups.
1037            *
1038            * @param userId the primary key of the user
1039            * @param groupId the primary key of the group
1040            * @param inherit whether to include organization groups and user groups to
1041            which the user belongs in the determination
1042            * @return <code>true</code> if the user is associated with the group;
1043            <code>false</code> otherwise
1044            * @throws SystemException if a system exception occurred
1045            */
1046            public boolean hasUserGroup(long userId, long groupId, boolean inherit)
1047                    throws com.liferay.portal.kernel.exception.SystemException {
1048                    return _groupLocalService.hasUserGroup(userId, groupId, inherit);
1049            }
1050    
1051            /**
1052            * Returns the group with the matching group name by first searching the
1053            * system groups and then using the finder cache.
1054            *
1055            * @param companyId the primary key of the company
1056            * @param name the group's name
1057            * @return the group with the name and associated company, or
1058            <code>null</code> if a matching group could not be found
1059            * @throws SystemException if a system exception occurred
1060            */
1061            public com.liferay.portal.model.Group loadFetchGroup(long companyId,
1062                    java.lang.String name)
1063                    throws com.liferay.portal.kernel.exception.SystemException {
1064                    return _groupLocalService.loadFetchGroup(companyId, name);
1065            }
1066    
1067            /**
1068            * Returns the group with the matching group name.
1069            *
1070            * @param companyId the primary key of the company
1071            * @param name the group's name
1072            * @return the group with the name and associated company
1073            * @throws PortalException if a matching group could not be found
1074            * @throws SystemException if a system exception occurred
1075            */
1076            public com.liferay.portal.model.Group loadGetGroup(long companyId,
1077                    java.lang.String name)
1078                    throws com.liferay.portal.kernel.exception.PortalException,
1079                            com.liferay.portal.kernel.exception.SystemException {
1080                    return _groupLocalService.loadGetGroup(companyId, name);
1081            }
1082    
1083            /**
1084            * Rebuilds the group tree.
1085            *
1086            * <p>
1087            * Only call this method if the tree has become stale through operations
1088            * other than normal CRUD. Under normal circumstances the tree is
1089            * automatically rebuilt whenever necessary.
1090            * </p>
1091            *
1092            * @param companyId the primary key of the group's company
1093            * @throws PortalException if a group with the primary key could not be
1094            found
1095            * @throws SystemException if a system exception occurred
1096            */
1097            public void rebuildTree(long companyId)
1098                    throws com.liferay.portal.kernel.exception.PortalException,
1099                            com.liferay.portal.kernel.exception.SystemException {
1100                    _groupLocalService.rebuildTree(companyId);
1101            }
1102    
1103            /**
1104            * Returns an ordered range of all the company's groups, optionally
1105            * including the user's inherited organization groups and user groups.
1106            * System and staged groups are not included.
1107            *
1108            * <p>
1109            * Useful when paginating results. Returns a maximum of <code>end -
1110            * start</code> instances. <code>start</code> and <code>end</code> are not
1111            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1112            * refers to the first result in the set. Setting both <code>start</code>
1113            * and <code>end</code> to {@link
1114            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1115            * result set.
1116            * </p>
1117            *
1118            * @param companyId the primary key of the company
1119            * @param params the finder params (optionally <code>null</code>). To
1120            include a user's organizations, inherited organizations, and user
1121            groups in the search, add an entry with key
1122            &quot;usersGroups&quot; mapped to the user's ID and an entry with
1123            key &quot;inherit&quot; mapped to a non-<code>null</code> object.
1124            For more information see {@link
1125            com.liferay.portal.service.persistence.GroupFinder}
1126            * @param start the lower bound of the range of groups to return
1127            * @param end the upper bound of the range of groups to return (not
1128            inclusive)
1129            * @return the matching groups ordered by name
1130            * @throws SystemException if a system exception occurred
1131            */
1132            public java.util.List<com.liferay.portal.model.Group> search(
1133                    long companyId,
1134                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1135                    int start, int end)
1136                    throws com.liferay.portal.kernel.exception.SystemException {
1137                    return _groupLocalService.search(companyId, params, start, end);
1138            }
1139    
1140            /**
1141            * Returns an ordered range of all the groups belonging to the parent group
1142            * that match the keywords, optionally including the user's inherited
1143            * organization groups and user groups. System and staged groups are not
1144            * included.
1145            *
1146            * <p>
1147            * Useful when paginating results. Returns a maximum of <code>end -
1148            * start</code> instances. <code>start</code> and <code>end</code> are not
1149            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1150            * refers to the first result in the set. Setting both <code>start</code>
1151            * and <code>end</code> to {@link
1152            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1153            * result set.
1154            * </p>
1155            *
1156            * @param companyId the primary key of the company
1157            * @param parentGroupId the primary key of the parent group
1158            * @param keywords the keywords (space separated), which may occur in the
1159            sites's name, or description (optionally <code>null</code>)
1160            * @param params the finder params (optionally <code>null</code>). To
1161            include the user's inherited organizations and user groups in the
1162            search, add entries having &quot;usersGroups&quot; and
1163            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1164            information see {@link
1165            com.liferay.portal.service.persistence.GroupFinder}
1166            * @param start the lower bound of the range of groups to return
1167            * @param end the upper bound of the range of groups to return (not
1168            inclusive)
1169            * @return the matching groups ordered by name
1170            * @throws SystemException if a system exception occurred
1171            */
1172            public java.util.List<com.liferay.portal.model.Group> search(
1173                    long companyId, long parentGroupId, java.lang.String keywords,
1174                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1175                    int start, int end)
1176                    throws com.liferay.portal.kernel.exception.SystemException {
1177                    return _groupLocalService.search(companyId, parentGroupId, keywords,
1178                            params, start, end);
1179            }
1180    
1181            /**
1182            * Returns an ordered range of all the groups belonging to the parent group
1183            * that match the keywords, optionally including the user's inherited
1184            * organization groups and user groups. System and staged groups are not
1185            * included.
1186            *
1187            * <p>
1188            * Useful when paginating results. Returns a maximum of <code>end -
1189            * start</code> instances. <code>start</code> and <code>end</code> are not
1190            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1191            * refers to the first result in the set. Setting both <code>start</code>
1192            * and <code>end</code> to {@link
1193            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1194            * result set.
1195            * </p>
1196            *
1197            * @param companyId the primary key of the company
1198            * @param parentGroupId the primary key of the parent group
1199            * @param keywords the keywords (space separated), which may occur in the
1200            sites's name, or description (optionally <code>null</code>)
1201            * @param params the finder params (optionally <code>null</code>). To
1202            include the user's inherited organizations and user groups in the
1203            search, add entries having &quot;usersGroups&quot; and
1204            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1205            information see {@link
1206            com.liferay.portal.service.persistence.GroupFinder}
1207            * @param start the lower bound of the range of groups to return
1208            * @param end the upper bound of the range of groups to return (not
1209            inclusive)
1210            * @param obc the comparator to order the groups (optionally
1211            <code>null</code>)
1212            * @return the matching groups ordered by comparator <code>obc</code>
1213            * @throws SystemException if a system exception occurred
1214            */
1215            public java.util.List<com.liferay.portal.model.Group> search(
1216                    long companyId, long parentGroupId, java.lang.String keywords,
1217                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1218                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
1219                    throws com.liferay.portal.kernel.exception.SystemException {
1220                    return _groupLocalService.search(companyId, parentGroupId, keywords,
1221                            params, start, end, obc);
1222            }
1223    
1224            /**
1225            * Returns an ordered range of all the site groups belonging to the parent
1226            * group and organization groups that match the name and description,
1227            * optionally including the user's inherited organization groups and user
1228            * groups. System and staged groups are not included.
1229            *
1230            * <p>
1231            * Useful when paginating results. Returns a maximum of <code>end -
1232            * start</code> instances. <code>start</code> and <code>end</code> are not
1233            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1234            * refers to the first result in the set. Setting both <code>start</code>
1235            * and <code>end</code> to {@link
1236            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1237            * result set.
1238            * </p>
1239            *
1240            * @param companyId the primary key of the company
1241            * @param parentGroupId the primary key of the parent group
1242            * @param name the group's name (optionally <code>null</code>)
1243            * @param description the group's description (optionally
1244            <code>null</code>)
1245            * @param params the finder params (optionally <code>null</code>). To
1246            include the user's inherited organizations and user groups in the
1247            search, add entries having &quot;usersGroups&quot; and
1248            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1249            information see {@link
1250            com.liferay.portal.service.persistence.GroupFinder}
1251            * @param andOperator whether every field must match its keywords, or just
1252            one field.
1253            * @param start the lower bound of the range of groups to return
1254            * @param end the upper bound of the range of groups to return (not
1255            inclusive)
1256            * @return the matching groups ordered by name
1257            * @throws SystemException if a system exception occurred
1258            */
1259            public java.util.List<com.liferay.portal.model.Group> search(
1260                    long companyId, long parentGroupId, java.lang.String name,
1261                    java.lang.String description,
1262                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1263                    boolean andOperator, int start, int end)
1264                    throws com.liferay.portal.kernel.exception.SystemException {
1265                    return _groupLocalService.search(companyId, parentGroupId, name,
1266                            description, params, andOperator, start, end);
1267            }
1268    
1269            /**
1270            * Returns an ordered range of all the site groups belonging to the parent
1271            * group and organization groups that match the name and description,
1272            * optionally including the user's inherited organization groups and user
1273            * groups. System and staged groups are not included.
1274            *
1275            * <p>
1276            * Useful when paginating results. Returns a maximum of <code>end -
1277            * start</code> instances. <code>start</code> and <code>end</code> are not
1278            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1279            * refers to the first result in the set. Setting both <code>start</code>
1280            * and <code>end</code> to {@link
1281            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1282            * result set.
1283            * </p>
1284            *
1285            * @param companyId the primary key of the company
1286            * @param parentGroupId the primary key of the parent group
1287            * @param name the group's name (optionally <code>null</code>)
1288            * @param description the group's description (optionally
1289            <code>null</code>)
1290            * @param params the finder params (optionally <code>null</code>). To
1291            include the user's inherited organizations and user groups in the
1292            search, add entries having &quot;usersGroups&quot; and
1293            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1294            information see {@link
1295            com.liferay.portal.service.persistence.GroupFinder}
1296            * @param andOperator whether every field must match its keywords, or just
1297            one field.
1298            * @param start the lower bound of the range of groups to return
1299            * @param end the upper bound of the range of groups to return (not
1300            inclusive)
1301            * @param obc the comparator to order the groups (optionally
1302            <code>null</code>)
1303            * @return the matching groups ordered by comparator <code>obc</code>
1304            * @throws SystemException if a system exception occurred
1305            */
1306            public java.util.List<com.liferay.portal.model.Group> search(
1307                    long companyId, long parentGroupId, java.lang.String name,
1308                    java.lang.String description,
1309                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1310                    boolean andOperator, int start, int end,
1311                    com.liferay.portal.kernel.util.OrderByComparator obc)
1312                    throws com.liferay.portal.kernel.exception.SystemException {
1313                    return _groupLocalService.search(companyId, parentGroupId, name,
1314                            description, params, andOperator, start, end, obc);
1315            }
1316    
1317            /**
1318            * Returns an ordered range of all the groups belonging to the parent group
1319            * that match the class name IDs and keywords, optionally including the
1320            * user's inherited organization groups and user groups. System and staged
1321            * groups are not included.
1322            *
1323            * <p>
1324            * Useful when paginating results. Returns a maximum of <code>end -
1325            * start</code> instances. <code>start</code> and <code>end</code> are not
1326            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1327            * refers to the first result in the set. Setting both <code>start</code>
1328            * and <code>end</code> to {@link
1329            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1330            * result set.
1331            * </p>
1332            *
1333            * @param companyId the primary key of the company
1334            * @param classNameIds the primary keys of the class names of the entities
1335            the groups are related to (optionally <code>null</code>)
1336            * @param parentGroupId the primary key of the parent group
1337            * @param keywords the keywords (space separated), which may occur in the
1338            sites's name, or description (optionally <code>null</code>)
1339            * @param params the finder params (optionally <code>null</code>). To
1340            include a user's organizations, inherited organizations, and user
1341            groups in the search, add an entry with key
1342            &quot;usersGroups&quot; mapped to the user's ID and an entry with
1343            key &quot;inherit&quot; mapped to a non-<code>null</code> object.
1344            For more information see {@link
1345            com.liferay.portal.service.persistence.GroupFinder}
1346            * @param start the lower bound of the range of groups to return
1347            * @param end the upper bound of the range of groups to return (not
1348            inclusive)
1349            * @return the matching groups ordered by name
1350            * @throws SystemException if a system exception occurred
1351            */
1352            public java.util.List<com.liferay.portal.model.Group> search(
1353                    long companyId, long[] classNameIds, long parentGroupId,
1354                    java.lang.String keywords,
1355                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1356                    int start, int end)
1357                    throws com.liferay.portal.kernel.exception.SystemException {
1358                    return _groupLocalService.search(companyId, classNameIds,
1359                            parentGroupId, keywords, params, start, end);
1360            }
1361    
1362            /**
1363            * Returns an ordered range of all the groups belonging to the parent group
1364            * that match the class name IDs and keywords, optionally including the
1365            * user's inherited organization groups and user groups. System and staged
1366            * groups are not included.
1367            *
1368            * <p>
1369            * Useful when paginating results. Returns a maximum of <code>end -
1370            * start</code> instances. <code>start</code> and <code>end</code> are not
1371            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1372            * refers to the first result in the set. Setting both <code>start</code>
1373            * and <code>end</code> to {@link
1374            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1375            * result set.
1376            * </p>
1377            *
1378            * @param companyId the primary key of the company
1379            * @param classNameIds the primary keys of the class names of the entities
1380            the groups are related to (optionally <code>null</code>)
1381            * @param parentGroupId the primary key of the parent group
1382            * @param keywords the keywords (space separated), which may occur in the
1383            sites's name, or description (optionally <code>null</code>)
1384            * @param params the finder params (optionally <code>null</code>). To
1385            include a user's organizations, inherited organizations, and user
1386            groups in the search, add an entry with key
1387            &quot;usersGroups&quot; mapped to the user's ID and an entry with
1388            key &quot;inherit&quot; mapped to a non-<code>null</code> object.
1389            For more information see {@link
1390            com.liferay.portal.service.persistence.GroupFinder}
1391            * @param start the lower bound of the range of groups to return
1392            * @param end the upper bound of the range of groups to return (not
1393            inclusive)
1394            * @param obc the comparator to order the groups (optionally
1395            <code>null</code>)
1396            * @return the matching groups ordered by comparator <code>obc</code>
1397            * @throws SystemException if a system exception occurred
1398            */
1399            public java.util.List<com.liferay.portal.model.Group> search(
1400                    long companyId, long[] classNameIds, long parentGroupId,
1401                    java.lang.String keywords,
1402                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1403                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
1404                    throws com.liferay.portal.kernel.exception.SystemException {
1405                    return _groupLocalService.search(companyId, classNameIds,
1406                            parentGroupId, keywords, params, start, end, obc);
1407            }
1408    
1409            /**
1410            * Returns an ordered range of all the groups belonging to the parent group
1411            * that match the class name IDs, name, and description, optionally
1412            * including the user's inherited organization groups and user groups.
1413            * System and staged groups are not included.
1414            *
1415            * <p>
1416            * Useful when paginating results. Returns a maximum of <code>end -
1417            * start</code> instances. <code>start</code> and <code>end</code> are not
1418            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1419            * refers to the first result in the set. Setting both <code>start</code>
1420            * and <code>end</code> to {@link
1421            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1422            * result set.
1423            * </p>
1424            *
1425            * @param companyId the primary key of the company
1426            * @param classNameIds the primary keys of the class names of the entities
1427            the groups are related to (optionally <code>null</code>)
1428            * @param parentGroupId the primary key of the parent group
1429            * @param name the group's name (optionally <code>null</code>)
1430            * @param description the group's description (optionally
1431            <code>null</code>)
1432            * @param params the finder params (optionally <code>null</code>). To
1433            include a user's organizations, inherited organizations, and user
1434            groups in the search, add an entry with key
1435            &quot;usersGroups&quot; mapped to the user's ID and an entry with
1436            key &quot;inherit&quot; mapped to a non-<code>null</code> object.
1437            For more information see {@link
1438            com.liferay.portal.service.persistence.GroupFinder}
1439            * @param andOperator whether every field must match its keywords, or just
1440            one field.
1441            * @param start the lower bound of the range of groups to return
1442            * @param end the upper bound of the range of groups to return (not
1443            inclusive)
1444            * @return the matching groups ordered by name
1445            * @throws SystemException if a system exception occurred
1446            */
1447            public java.util.List<com.liferay.portal.model.Group> search(
1448                    long companyId, long[] classNameIds, long parentGroupId,
1449                    java.lang.String name, java.lang.String description,
1450                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1451                    boolean andOperator, int start, int end)
1452                    throws com.liferay.portal.kernel.exception.SystemException {
1453                    return _groupLocalService.search(companyId, classNameIds,
1454                            parentGroupId, name, description, params, andOperator, start, end);
1455            }
1456    
1457            /**
1458            * Returns an ordered range of all the groups belonging to the parent group
1459            * that match the class name IDs, name, and description, optionally
1460            * including the user's inherited organization groups and user groups.
1461            * System and staged groups are not included.
1462            *
1463            * <p>
1464            * Useful when paginating results. Returns a maximum of <code>end -
1465            * start</code> instances. <code>start</code> and <code>end</code> are not
1466            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1467            * refers to the first result in the set. Setting both <code>start</code>
1468            * and <code>end</code> to {@link
1469            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1470            * result set.
1471            * </p>
1472            *
1473            * @param companyId the primary key of the company
1474            * @param classNameIds the primary keys of the class names of the entities
1475            the groups are related to (optionally <code>null</code>)
1476            * @param parentGroupId the primary key of the parent group
1477            * @param name the group's name (optionally <code>null</code>)
1478            * @param description the group's description (optionally
1479            <code>null</code>)
1480            * @param params the finder params (optionally <code>null</code>). To
1481            include a user's organizations, inherited organizations, and user
1482            groups in the search, add an entry with key
1483            &quot;usersGroups&quot; mapped to the user's ID and an entry with
1484            key &quot;inherit&quot; mapped to a non-<code>null</code> object.
1485            For more information see {@link
1486            com.liferay.portal.service.persistence.GroupFinder}
1487            * @param andOperator whether every field must match its keywords, or just
1488            one field.
1489            * @param start the lower bound of the range of groups to return
1490            * @param end the upper bound of the range of groups to return (not
1491            inclusive)
1492            * @param obc the comparator to order the groups (optionally
1493            <code>null</code>)
1494            * @return the matching groups ordered by comparator <code>obc</code>
1495            * @throws SystemException if a system exception occurred
1496            */
1497            public java.util.List<com.liferay.portal.model.Group> search(
1498                    long companyId, long[] classNameIds, long parentGroupId,
1499                    java.lang.String name, java.lang.String description,
1500                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1501                    boolean andOperator, int start, int end,
1502                    com.liferay.portal.kernel.util.OrderByComparator obc)
1503                    throws com.liferay.portal.kernel.exception.SystemException {
1504                    return _groupLocalService.search(companyId, classNameIds,
1505                            parentGroupId, name, description, params, andOperator, start, end,
1506                            obc);
1507            }
1508    
1509            /**
1510            * Returns an ordered range of all the groups that match the class name IDs
1511            * and keywords, optionally including the user's inherited organization
1512            * groups and user groups. System and staged groups are not included.
1513            *
1514            * <p>
1515            * Useful when paginating results. Returns a maximum of <code>end -
1516            * start</code> instances. <code>start</code> and <code>end</code> are not
1517            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1518            * refers to the first result in the set. Setting both <code>start</code>
1519            * and <code>end</code> to {@link
1520            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1521            * result set.
1522            * </p>
1523            *
1524            * @param companyId the primary key of the company
1525            * @param classNameIds the primary keys of the class names of the entities
1526            the groups are related to (optionally <code>null</code>)
1527            * @param keywords the keywords (space separated), which may occur in the
1528            sites's name, or description (optionally <code>null</code>)
1529            * @param params the finder params (optionally <code>null</code>). To
1530            include a user's organizations, inherited organizations, and user
1531            groups in the search, add an entry with key
1532            &quot;usersGroups&quot; mapped to the user's ID and an entry with
1533            key &quot;inherit&quot; mapped to a non-<code>null</code> object.
1534            For more information see {@link
1535            com.liferay.portal.service.persistence.GroupFinder}
1536            * @param start the lower bound of the range of groups to return
1537            * @param end the upper bound of the range of groups to return (not
1538            inclusive)
1539            * @return the matching groups ordered by name
1540            * @throws SystemException if a system exception occurred
1541            */
1542            public java.util.List<com.liferay.portal.model.Group> search(
1543                    long companyId, long[] classNameIds, java.lang.String keywords,
1544                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1545                    int start, int end)
1546                    throws com.liferay.portal.kernel.exception.SystemException {
1547                    return _groupLocalService.search(companyId, classNameIds, keywords,
1548                            params, start, end);
1549            }
1550    
1551            /**
1552            * Returns an ordered range of all the groups that match the class name IDs
1553            * and keywords, optionally including the user's inherited organization
1554            * groups and user groups. System and staged groups are not included.
1555            *
1556            * <p>
1557            * Useful when paginating results. Returns a maximum of <code>end -
1558            * start</code> instances. <code>start</code> and <code>end</code> are not
1559            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1560            * refers to the first result in the set. Setting both <code>start</code>
1561            * and <code>end</code> to {@link
1562            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1563            * result set.
1564            * </p>
1565            *
1566            * @param companyId the primary key of the company
1567            * @param classNameIds the primary keys of the class names of the entities
1568            the groups are related to (optionally <code>null</code>)
1569            * @param keywords the keywords (space separated), which may occur in the
1570            sites's name, or description (optionally <code>null</code>)
1571            * @param params the finder params (optionally <code>null</code>). To
1572            include a user's organizations, inherited organizations, and user
1573            groups in the search, add an entry with key
1574            &quot;usersGroups&quot; mapped to the user's ID and an entry with
1575            key &quot;inherit&quot; mapped to a non-<code>null</code> object.
1576            For more information see {@link
1577            com.liferay.portal.service.persistence.GroupFinder}
1578            * @param start the lower bound of the range of groups to return
1579            * @param end the upper bound of the range of groups to return (not
1580            inclusive)
1581            * @param obc the comparator to order the groups (optionally
1582            <code>null</code>)
1583            * @return the matching groups ordered by comparator <code>obc</code>
1584            * @throws SystemException if a system exception occurred
1585            */
1586            public java.util.List<com.liferay.portal.model.Group> search(
1587                    long companyId, long[] classNameIds, java.lang.String keywords,
1588                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1589                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
1590                    throws com.liferay.portal.kernel.exception.SystemException {
1591                    return _groupLocalService.search(companyId, classNameIds, keywords,
1592                            params, start, end, obc);
1593            }
1594    
1595            /**
1596            * Returns an ordered range of all the groups that match the class name IDs,
1597            * name, and description, optionally including the user's inherited
1598            * organization groups and user groups. System and staged groups are not
1599            * included.
1600            *
1601            * <p>
1602            * Useful when paginating results. Returns a maximum of <code>end -
1603            * start</code> instances. <code>start</code> and <code>end</code> are not
1604            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1605            * refers to the first result in the set. Setting both <code>start</code>
1606            * and <code>end</code> to {@link
1607            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1608            * result set.
1609            * </p>
1610            *
1611            * @param companyId the primary key of the company
1612            * @param classNameIds the primary keys of the class names of the entities
1613            the groups are related to (optionally <code>null</code>)
1614            * @param name the group's name (optionally <code>null</code>)
1615            * @param description the group's description (optionally
1616            <code>null</code>)
1617            * @param params the finder params (optionally <code>null</code>). To
1618            include a user's organizations, inherited organizations, and user
1619            groups in the search, add an entry with key
1620            &quot;usersGroups&quot; mapped to the user's ID and an entry with
1621            key &quot;inherit&quot; mapped to a non-<code>null</code> object.
1622            For more information see {@link
1623            com.liferay.portal.service.persistence.GroupFinder}
1624            * @param andOperator whether every field must match its keywords, or just
1625            one field.
1626            * @param start the lower bound of the range of groups to return
1627            * @param end the upper bound of the range of groups to return (not
1628            inclusive)
1629            * @return the matching groups ordered by name
1630            * @throws SystemException if a system exception occurred
1631            */
1632            public java.util.List<com.liferay.portal.model.Group> search(
1633                    long companyId, long[] classNameIds, java.lang.String name,
1634                    java.lang.String description,
1635                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1636                    boolean andOperator, int start, int end)
1637                    throws com.liferay.portal.kernel.exception.SystemException {
1638                    return _groupLocalService.search(companyId, classNameIds, name,
1639                            description, params, andOperator, start, end);
1640            }
1641    
1642            /**
1643            * Returns an ordered range of all the groups that match the class name IDs,
1644            * name, and description, optionally including the user's inherited
1645            * organization groups and user groups. System and staged groups are not
1646            * included.
1647            *
1648            * <p>
1649            * Useful when paginating results. Returns a maximum of <code>end -
1650            * start</code> instances. <code>start</code> and <code>end</code> are not
1651            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1652            * refers to the first result in the set. Setting both <code>start</code>
1653            * and <code>end</code> to {@link
1654            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1655            * result set.
1656            * </p>
1657            *
1658            * @param companyId the primary key of the company
1659            * @param classNameIds the primary keys of the class names of the entities
1660            the groups are related to (optionally <code>null</code>)
1661            * @param name the group's name (optionally <code>null</code>)
1662            * @param description the group's description (optionally
1663            <code>null</code>)
1664            * @param params the finder params (optionally <code>null</code>). To
1665            include a user's organizations, inherited organizations, and user
1666            groups in the search, add an entry with key
1667            &quot;usersGroups&quot; mapped to the user's ID and an entry with
1668            key &quot;inherit&quot; mapped to a non-<code>null</code> object.
1669            For more information see {@link
1670            com.liferay.portal.service.persistence.GroupFinder}
1671            * @param andOperator whether every field must match its keywords, or just
1672            one field.
1673            * @param start the lower bound of the range of groups to return
1674            * @param end the upper bound of the range of groups to return (not
1675            inclusive)
1676            * @param obc the comparator to order the groups (optionally
1677            <code>null</code>)
1678            * @return the matching groups ordered by comparator <code>obc</code>
1679            * @throws SystemException if a system exception occurred
1680            */
1681            public java.util.List<com.liferay.portal.model.Group> search(
1682                    long companyId, long[] classNameIds, java.lang.String name,
1683                    java.lang.String description,
1684                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1685                    boolean andOperator, int start, int end,
1686                    com.liferay.portal.kernel.util.OrderByComparator obc)
1687                    throws com.liferay.portal.kernel.exception.SystemException {
1688                    return _groupLocalService.search(companyId, classNameIds, name,
1689                            description, params, andOperator, start, end, obc);
1690            }
1691    
1692            /**
1693            * Returns an ordered range of all the groups that match the keywords,
1694            * optionally including the user's inherited organization groups and user
1695            * groups. System and staged groups are not included.
1696            *
1697            * <p>
1698            * Useful when paginating results. Returns a maximum of <code>end -
1699            * start</code> instances. <code>start</code> and <code>end</code> are not
1700            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1701            * refers to the first result in the set. Setting both <code>start</code>
1702            * and <code>end</code> to {@link
1703            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1704            * result set.
1705            * </p>
1706            *
1707            * @param companyId the primary key of the company
1708            * @param keywords the keywords (space separated), which may occur in the
1709            sites's name, or description (optionally <code>null</code>)
1710            * @param params the finder params (optionally <code>null</code>). To
1711            include the user's inherited organizations and user groups in the
1712            search, add entries having &quot;usersGroups&quot; and
1713            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1714            information see {@link
1715            com.liferay.portal.service.persistence.GroupFinder}
1716            * @param start the lower bound of the range of groups to return
1717            * @param end the upper bound of the range of groups to return (not
1718            inclusive)
1719            * @return the matching groups ordered by name
1720            * @throws SystemException if a system exception occurred
1721            */
1722            public java.util.List<com.liferay.portal.model.Group> search(
1723                    long companyId, java.lang.String keywords,
1724                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1725                    int start, int end)
1726                    throws com.liferay.portal.kernel.exception.SystemException {
1727                    return _groupLocalService.search(companyId, keywords, params, start, end);
1728            }
1729    
1730            /**
1731            * Returns an ordered range of all the groups that match the keywords,
1732            * optionally including the user's inherited organization groups and user
1733            * groups. System and staged groups are not included.
1734            *
1735            * <p>
1736            * Useful when paginating results. Returns a maximum of <code>end -
1737            * start</code> instances. <code>start</code> and <code>end</code> are not
1738            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1739            * refers to the first result in the set. Setting both <code>start</code>
1740            * and <code>end</code> to {@link
1741            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1742            * result set.
1743            * </p>
1744            *
1745            * @param companyId the primary key of the company
1746            * @param keywords the keywords (space separated), which may occur in the
1747            sites's name, or description (optionally <code>null</code>)
1748            * @param params the finder params (optionally <code>null</code>). To
1749            include the user's inherited organizations and user groups in the
1750            search, add entries having &quot;usersGroups&quot; and
1751            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1752            information see {@link
1753            com.liferay.portal.service.persistence.GroupFinder}
1754            * @param start the lower bound of the range of groups to return
1755            * @param end the upper bound of the range of groups to return (not
1756            inclusive)
1757            * @param obc the comparator to order the groups (optionally
1758            <code>null</code>)
1759            * @return the matching groups ordered by comparator <code>obc</code>
1760            * @throws SystemException if a system exception occurred
1761            */
1762            public java.util.List<com.liferay.portal.model.Group> search(
1763                    long companyId, java.lang.String keywords,
1764                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1765                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
1766                    throws com.liferay.portal.kernel.exception.SystemException {
1767                    return _groupLocalService.search(companyId, keywords, params, start,
1768                            end, obc);
1769            }
1770    
1771            /**
1772            * Returns an ordered range of all the site groups and organization groups
1773            * that match the name and description, optionally including the user's
1774            * inherited organization groups and user groups. System and staged groups
1775            * are not included.
1776            *
1777            * <p>
1778            * Useful when paginating results. Returns a maximum of <code>end -
1779            * start</code> instances. <code>start</code> and <code>end</code> are not
1780            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1781            * refers to the first result in the set. Setting both <code>start</code>
1782            * and <code>end</code> to {@link
1783            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1784            * result set.
1785            * </p>
1786            *
1787            * @param companyId the primary key of the company
1788            * @param name the group's name (optionally <code>null</code>)
1789            * @param description the group's description (optionally
1790            <code>null</code>)
1791            * @param params the finder params (optionally <code>null</code>). To
1792            include the user's inherited organizations and user groups in the
1793            search, add entries having &quot;usersGroups&quot; and
1794            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1795            information see {@link
1796            com.liferay.portal.service.persistence.GroupFinder}
1797            * @param andOperator whether every field must match its keywords, or just
1798            one field.
1799            * @param start the lower bound of the range of groups to return
1800            * @param end the upper bound of the range of groups to return (not
1801            inclusive)
1802            * @return the matching groups ordered by name
1803            * @throws SystemException if a system exception occurred
1804            */
1805            public java.util.List<com.liferay.portal.model.Group> search(
1806                    long companyId, java.lang.String name, java.lang.String description,
1807                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1808                    boolean andOperator, int start, int end)
1809                    throws com.liferay.portal.kernel.exception.SystemException {
1810                    return _groupLocalService.search(companyId, name, description, params,
1811                            andOperator, start, end);
1812            }
1813    
1814            /**
1815            * Returns an ordered range of all the site groups and organization groups
1816            * that match the name and description, optionally including the user's
1817            * inherited organization groups and user groups. System and staged groups
1818            * are not included.
1819            *
1820            * <p>
1821            * Useful when paginating results. Returns a maximum of <code>end -
1822            * start</code> instances. <code>start</code> and <code>end</code> are not
1823            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1824            * refers to the first result in the set. Setting both <code>start</code>
1825            * and <code>end</code> to {@link
1826            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1827            * result set.
1828            * </p>
1829            *
1830            * @param companyId the primary key of the company
1831            * @param name the group's name (optionally <code>null</code>)
1832            * @param description the group's description (optionally
1833            <code>null</code>)
1834            * @param params the finder params (optionally <code>null</code>). To
1835            include the user's inherited organizations and user groups in the
1836            search, add entries having &quot;usersGroups&quot; and
1837            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1838            information see {@link
1839            com.liferay.portal.service.persistence.GroupFinder}
1840            * @param andOperator whether every field must match its keywords, or just
1841            one field.
1842            * @param start the lower bound of the range of groups to return
1843            * @param end the upper bound of the range of groups to return (not
1844            inclusive)
1845            * @param obc the comparator to order the groups (optionally
1846            <code>null</code>)
1847            * @return the matching groups ordered by comparator <code>obc</code>
1848            * @throws SystemException if a system exception occurred
1849            */
1850            public java.util.List<com.liferay.portal.model.Group> search(
1851                    long companyId, java.lang.String name, java.lang.String description,
1852                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1853                    boolean andOperator, int start, int end,
1854                    com.liferay.portal.kernel.util.OrderByComparator obc)
1855                    throws com.liferay.portal.kernel.exception.SystemException {
1856                    return _groupLocalService.search(companyId, name, description, params,
1857                            andOperator, start, end, obc);
1858            }
1859    
1860            /**
1861            * Returns the number of groups belonging to the parent group that match the
1862            * keywords, optionally including the user's inherited organization groups
1863            * and user groups. System and staged groups are not included.
1864            *
1865            * @param companyId the primary key of the company
1866            * @param parentGroupId the primary key of the parent group
1867            * @param keywords the keywords (space separated), which may occur in the
1868            sites's name, or description (optionally <code>null</code>)
1869            * @param params the finder params (optionally <code>null</code>). To
1870            include the user's inherited organization groups and user groups
1871            in the search, add entries having &quot;usersGroups&quot; and
1872            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1873            information see {@link
1874            com.liferay.portal.service.persistence.GroupFinder}
1875            * @return the number of matching groups
1876            * @throws SystemException if a system exception occurred
1877            */
1878            public int searchCount(long companyId, long parentGroupId,
1879                    java.lang.String keywords,
1880                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params)
1881                    throws com.liferay.portal.kernel.exception.SystemException {
1882                    return _groupLocalService.searchCount(companyId, parentGroupId,
1883                            keywords, params);
1884            }
1885    
1886            /**
1887            * Returns the number of groups belonging to the parent group and immediate
1888            * organization groups that match the name and description, optionally
1889            * including the user's inherited organization groups and user groups.
1890            * System and staged groups are not included.
1891            *
1892            * @param companyId the primary key of the company
1893            * @param parentGroupId the primary key of the parent group
1894            * @param name the group's name (optionally <code>null</code>)
1895            * @param description the group's description (optionally
1896            <code>null</code>)
1897            * @param params the finder params (optionally <code>null</code>). To
1898            include the user's inherited organization groups and user groups
1899            in the search, add entries having &quot;usersGroups&quot; and
1900            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1901            information see {@link
1902            com.liferay.portal.service.persistence.GroupFinder}
1903            * @param andOperator whether every field must match its keywords, or just
1904            one field.
1905            * @return the number of matching groups
1906            * @throws SystemException if a system exception occurred
1907            */
1908            public int searchCount(long companyId, long parentGroupId,
1909                    java.lang.String name, java.lang.String description,
1910                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1911                    boolean andOperator)
1912                    throws com.liferay.portal.kernel.exception.SystemException {
1913                    return _groupLocalService.searchCount(companyId, parentGroupId, name,
1914                            description, params, andOperator);
1915            }
1916    
1917            /**
1918            * Returns the number of groups belonging to the parent group that match the
1919            * class name IDs, and keywords, optionally including the user's inherited
1920            * organization groups and user groups. System and staged groups are not
1921            * included.
1922            *
1923            * @param companyId the primary key of the company
1924            * @param classNameIds the primary keys of the class names of the entities
1925            the groups are related to (optionally <code>null</code>)
1926            * @param parentGroupId the primary key of the parent group
1927            * @param keywords the keywords (space separated), which may occur in the
1928            sites's name, or description (optionally <code>null</code>)
1929            * @param params the finder params (optionally <code>null</code>). To
1930            include the user's inherited organization groups and user groups
1931            in the search, add entries having &quot;usersGroups&quot; and
1932            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1933            information see {@link
1934            com.liferay.portal.service.persistence.GroupFinder}
1935            * @return the number of matching groups
1936            * @throws SystemException if a system exception occurred
1937            */
1938            public int searchCount(long companyId, long[] classNameIds,
1939                    long parentGroupId, java.lang.String keywords,
1940                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params)
1941                    throws com.liferay.portal.kernel.exception.SystemException {
1942                    return _groupLocalService.searchCount(companyId, classNameIds,
1943                            parentGroupId, keywords, params);
1944            }
1945    
1946            /**
1947            * Returns the number of groups belonging to the parent group that match the
1948            * class name IDs, name, and description, optionally including the user's
1949            * inherited organization groups and user groups. System and staged groups
1950            * are not included.
1951            *
1952            * @param companyId the primary key of the company
1953            * @param classNameIds the primary keys of the class names of the entities
1954            the groups are related to (optionally <code>null</code>)
1955            * @param parentGroupId the primary key of the parent group
1956            * @param name the group's name (optionally <code>null</code>)
1957            * @param description the group's description (optionally
1958            <code>null</code>)
1959            * @param params the finder params (optionally <code>null</code>). To
1960            include the user's inherited organization groups and user groups
1961            in the search, add entries having &quot;usersGroups&quot; and
1962            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1963            information see {@link
1964            com.liferay.portal.service.persistence.GroupFinder}
1965            * @param andOperator whether every field must match its keywords, or just
1966            one field.
1967            * @return the number of matching groups
1968            * @throws SystemException if a system exception occurred
1969            */
1970            public int searchCount(long companyId, long[] classNameIds,
1971                    long parentGroupId, java.lang.String name,
1972                    java.lang.String description,
1973                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1974                    boolean andOperator)
1975                    throws com.liferay.portal.kernel.exception.SystemException {
1976                    return _groupLocalService.searchCount(companyId, classNameIds,
1977                            parentGroupId, name, description, params, andOperator);
1978            }
1979    
1980            /**
1981            * Returns the number of groups that match the class name IDs, and keywords,
1982            * optionally including the user's inherited organization groups and user
1983            * groups. System and staged groups are not included.
1984            *
1985            * @param companyId the primary key of the company
1986            * @param classNameIds the primary keys of the class names of the entities
1987            the groups are related to (optionally <code>null</code>)
1988            * @param keywords the keywords (space separated), which may occur in the
1989            sites's name, or description (optionally <code>null</code>)
1990            * @param params the finder params (optionally <code>null</code>). To
1991            include the user's inherited organization groups and user groups
1992            in the search, add entries having &quot;usersGroups&quot; and
1993            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1994            information see {@link
1995            com.liferay.portal.service.persistence.GroupFinder}
1996            * @return the number of matching groups
1997            * @throws SystemException if a system exception occurred
1998            */
1999            public int searchCount(long companyId, long[] classNameIds,
2000                    java.lang.String keywords,
2001                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params)
2002                    throws com.liferay.portal.kernel.exception.SystemException {
2003                    return _groupLocalService.searchCount(companyId, classNameIds,
2004                            keywords, params);
2005            }
2006    
2007            /**
2008            * Returns the number of groups that match the class name IDs, name, and
2009            * description, optionally including the user's inherited organization
2010            * groups and user groups. System and staged groups are not included.
2011            *
2012            * @param companyId the primary key of the company
2013            * @param classNameIds the primary keys of the class names of the entities
2014            the groups are related to (optionally <code>null</code>)
2015            * @param name the group's name (optionally <code>null</code>)
2016            * @param description the group's description (optionally
2017            <code>null</code>)
2018            * @param params the finder params (optionally <code>null</code>). To
2019            include the user's inherited organization groups and user groups
2020            in the search, add entries having &quot;usersGroups&quot; and
2021            &quot;inherit&quot; as keys mapped to the the user's ID. For more
2022            information see {@link
2023            com.liferay.portal.service.persistence.GroupFinder}
2024            * @param andOperator whether every field must match its keywords, or just
2025            one field.
2026            * @return the number of matching groups
2027            * @throws SystemException if a system exception occurred
2028            */
2029            public int searchCount(long companyId, long[] classNameIds,
2030                    java.lang.String name, java.lang.String description,
2031                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
2032                    boolean andOperator)
2033                    throws com.liferay.portal.kernel.exception.SystemException {
2034                    return _groupLocalService.searchCount(companyId, classNameIds, name,
2035                            description, params, andOperator);
2036            }
2037    
2038            /**
2039            * Returns the number of groups that match the keywords, optionally
2040            * including the user's inherited organization groups and user groups.
2041            * System and staged groups are not included.
2042            *
2043            * @param companyId the primary key of the company
2044            * @param keywords the keywords (space separated), which may occur in the
2045            sites's name, or description (optionally <code>null</code>)
2046            * @param params the finder params (optionally <code>null</code>). To
2047            include the user's inherited organization groups and user groups
2048            in the search, add entries having &quot;usersGroups&quot; and
2049            &quot;inherit&quot; as keys mapped to the the user's ID. For more
2050            information see {@link
2051            com.liferay.portal.service.persistence.GroupFinder}
2052            * @return the number of matching groups
2053            * @throws SystemException if a system exception occurred
2054            */
2055            public int searchCount(long companyId, java.lang.String keywords,
2056                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params)
2057                    throws com.liferay.portal.kernel.exception.SystemException {
2058                    return _groupLocalService.searchCount(companyId, keywords, params);
2059            }
2060    
2061            /**
2062            * Returns the number of groups and immediate organization groups that match
2063            * the name and description, optionally including the user's inherited
2064            * organization groups and user groups. System and staged groups are not
2065            * included.
2066            *
2067            * @param companyId the primary key of the company
2068            * @param name the group's name (optionally <code>null</code>)
2069            * @param description the group's description (optionally
2070            <code>null</code>)
2071            * @param params the finder params (optionally <code>null</code>). To
2072            include the user's inherited organization groups and user groups
2073            in the search, add entries having &quot;usersGroups&quot; and
2074            &quot;inherit&quot; as keys mapped to the the user's ID. For more
2075            information see {@link
2076            com.liferay.portal.service.persistence.GroupFinder}
2077            * @param andOperator whether every field must match its keywords, or just
2078            one field.
2079            * @return the number of matching groups
2080            * @throws SystemException if a system exception occurred
2081            */
2082            public int searchCount(long companyId, java.lang.String name,
2083                    java.lang.String description,
2084                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
2085                    boolean andOperator)
2086                    throws com.liferay.portal.kernel.exception.SystemException {
2087                    return _groupLocalService.searchCount(companyId, name, description,
2088                            params, andOperator);
2089            }
2090    
2091            /**
2092            * Sets the groups associated with the role, removing and adding
2093            * associations as necessary.
2094            *
2095            * @param roleId the primary key of the role
2096            * @param groupIds the primary keys of the groups
2097            * @throws SystemException if a system exception occurred
2098            */
2099            public void setRoleGroups(long roleId, long[] groupIds)
2100                    throws com.liferay.portal.kernel.exception.SystemException {
2101                    _groupLocalService.setRoleGroups(roleId, groupIds);
2102            }
2103    
2104            /**
2105            * Removes the groups from the role.
2106            *
2107            * @param roleId the primary key of the role
2108            * @param groupIds the primary keys of the groups
2109            * @throws SystemException if a system exception occurred
2110            */
2111            public void unsetRoleGroups(long roleId, long[] groupIds)
2112                    throws com.liferay.portal.kernel.exception.SystemException {
2113                    _groupLocalService.unsetRoleGroups(roleId, groupIds);
2114            }
2115    
2116            /**
2117            * Removes the user from the groups.
2118            *
2119            * @param userId the primary key of the user
2120            * @param groupIds the primary keys of the groups
2121            * @throws SystemException if a system exception occurred
2122            */
2123            public void unsetUserGroups(long userId, long[] groupIds)
2124                    throws com.liferay.portal.kernel.exception.SystemException {
2125                    _groupLocalService.unsetUserGroups(userId, groupIds);
2126            }
2127    
2128            /**
2129            * Updates the group's asset replacing categories and tag names.
2130            *
2131            * @param userId the primary key of the user
2132            * @param group the group
2133            * @param assetCategoryIds the primary keys of the asset categories
2134            (optionally <code>null</code>)
2135            * @param assetTagNames the asset tag names (optionally <code>null</code>)
2136            * @throws PortalException if a user with the primary key could not be found
2137            * @throws SystemException if a system exception occurred
2138            */
2139            public void updateAsset(long userId, com.liferay.portal.model.Group group,
2140                    long[] assetCategoryIds, java.lang.String[] assetTagNames)
2141                    throws com.liferay.portal.kernel.exception.PortalException,
2142                            com.liferay.portal.kernel.exception.SystemException {
2143                    _groupLocalService.updateAsset(userId, group, assetCategoryIds,
2144                            assetTagNames);
2145            }
2146    
2147            /**
2148            * Updates the group's friendly URL.
2149            *
2150            * @param groupId the primary key of the group
2151            * @param friendlyURL the group's new friendlyURL (optionally
2152            <code>null</code>)
2153            * @return the group
2154            * @throws PortalException if a group with the primary key could not be
2155            found or if a valid friendly URL could not be created for the
2156            group
2157            * @throws SystemException if a system exception occurred
2158            */
2159            public com.liferay.portal.model.Group updateFriendlyURL(long groupId,
2160                    java.lang.String friendlyURL)
2161                    throws com.liferay.portal.kernel.exception.PortalException,
2162                            com.liferay.portal.kernel.exception.SystemException {
2163                    return _groupLocalService.updateFriendlyURL(groupId, friendlyURL);
2164            }
2165    
2166            /**
2167            * Updates the group.
2168            *
2169            * @param groupId the primary key of the group
2170            * @param parentGroupId the primary key of the parent group
2171            * @param name the group's new name
2172            * @param description the group's new description (optionally
2173            <code>null</code>)
2174            * @param type the group's new type. For more information see {@link
2175            com.liferay.portal.model.GroupConstants}
2176            * @param friendlyURL the group's new friendlyURL (optionally
2177            <code>null</code>)
2178            * @param active whether the group is active
2179            * @param serviceContext the service context to be applied (optionally
2180            <code>null</code>). Can set asset category IDs and asset tag
2181            names for the group.
2182            * @return the group
2183            * @throws PortalException if a group with the primary key could not be
2184            found or if the friendly URL was invalid or could one not be
2185            created
2186            * @throws SystemException if a system exception occurred
2187            */
2188            public com.liferay.portal.model.Group updateGroup(long groupId,
2189                    long parentGroupId, java.lang.String name,
2190                    java.lang.String description, int type, java.lang.String friendlyURL,
2191                    boolean active, com.liferay.portal.service.ServiceContext serviceContext)
2192                    throws com.liferay.portal.kernel.exception.PortalException,
2193                            com.liferay.portal.kernel.exception.SystemException {
2194                    return _groupLocalService.updateGroup(groupId, parentGroupId, name,
2195                            description, type, friendlyURL, active, serviceContext);
2196            }
2197    
2198            /**
2199            * Updates the group's type settings.
2200            *
2201            * @param groupId the primary key of the group
2202            * @param typeSettings the group's new type settings (optionally
2203            <code>null</code>)
2204            * @return the group
2205            * @throws PortalException if a group with the primary key could not be
2206            found
2207            * @throws SystemException if a system exception occurred
2208            */
2209            public com.liferay.portal.model.Group updateGroup(long groupId,
2210                    java.lang.String typeSettings)
2211                    throws com.liferay.portal.kernel.exception.PortalException,
2212                            com.liferay.portal.kernel.exception.SystemException {
2213                    return _groupLocalService.updateGroup(groupId, typeSettings);
2214            }
2215    
2216            /**
2217            * Associates the group with a main site if the group is an organization.
2218            *
2219            * @param groupId the primary key of the group
2220            * @param site whether the group is to be associated with a main site
2221            * @return the group
2222            * @throws PortalException if a group with the primary key could not be
2223            found
2224            * @throws SystemException if a system exception occurred
2225            */
2226            public com.liferay.portal.model.Group updateSite(long groupId, boolean site)
2227                    throws com.liferay.portal.kernel.exception.PortalException,
2228                            com.liferay.portal.kernel.exception.SystemException {
2229                    return _groupLocalService.updateSite(groupId, site);
2230            }
2231    
2232            /**
2233             * @deprecated Renamed to {@link #getWrappedService}
2234             */
2235            public GroupLocalService getWrappedGroupLocalService() {
2236                    return _groupLocalService;
2237            }
2238    
2239            /**
2240             * @deprecated Renamed to {@link #setWrappedService}
2241             */
2242            public void setWrappedGroupLocalService(GroupLocalService groupLocalService) {
2243                    _groupLocalService = groupLocalService;
2244            }
2245    
2246            public GroupLocalService getWrappedService() {
2247                    return _groupLocalService;
2248            }
2249    
2250            public void setWrappedService(GroupLocalService groupLocalService) {
2251                    _groupLocalService = groupLocalService;
2252            }
2253    
2254            private GroupLocalService _groupLocalService;
2255    }