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            /**
363            * Creates systems groups and other related data needed by the system on the
364            * very first startup. Also takes care of creating the Control Panel groups
365            * and layouts.
366            *
367            * @param companyId the primary key of the company
368            * @throws PortalException if a new system group could not be created
369            * @throws SystemException if a system exception occurred
370            */
371            public void checkSystemGroups(long companyId)
372                    throws com.liferay.portal.kernel.exception.PortalException,
373                            com.liferay.portal.kernel.exception.SystemException {
374                    _groupLocalService.checkSystemGroups(companyId);
375            }
376    
377            /**
378            * Returns the group with the matching friendly URL.
379            *
380            * @param companyId the primary key of the company
381            * @param friendlyURL the friendly URL
382            * @return the group with the friendly URL, or <code>null</code> if a
383            matching group could not be found
384            * @throws SystemException if a system exception occurred
385            */
386            public com.liferay.portal.model.Group fetchFriendlyURLGroup(
387                    long companyId, java.lang.String friendlyURL)
388                    throws com.liferay.portal.kernel.exception.SystemException {
389                    return _groupLocalService.fetchFriendlyURLGroup(companyId, friendlyURL);
390            }
391    
392            /**
393            * Returns the group with the matching group name by first searching the
394            * system groups and then using the finder cache.
395            *
396            * @param companyId the primary key of the company
397            * @param name the group's name
398            * @return the group with the name and associated company, or
399            <code>null</code> if a matching group could not be found
400            * @throws SystemException if a system exception occurred
401            */
402            public com.liferay.portal.model.Group fetchGroup(long companyId,
403                    java.lang.String name)
404                    throws com.liferay.portal.kernel.exception.SystemException {
405                    return _groupLocalService.fetchGroup(companyId, name);
406            }
407    
408            /**
409            * Returns the company group.
410            *
411            * @param companyId the primary key of the company
412            * @return the group associated with the company
413            * @throws PortalException if a matching group could not be found
414            * @throws SystemException if a system exception occurred
415            */
416            public com.liferay.portal.model.Group getCompanyGroup(long companyId)
417                    throws com.liferay.portal.kernel.exception.PortalException,
418                            com.liferay.portal.kernel.exception.SystemException {
419                    return _groupLocalService.getCompanyGroup(companyId);
420            }
421    
422            /**
423            * Returns a range of all the groups associated with the company.
424            *
425            * <p>
426            * Useful when paginating results. Returns a maximum of <code>end -
427            * start</code> instances. <code>start</code> and <code>end</code> are not
428            * primary keys, they are indexes in the result set. Thus, <code>0</code>
429            * refers to the first result in the set. Setting both <code>start</code>
430            * and <code>end</code> to {@link
431            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
432            * result set.
433            * </p>
434            *
435            * @param companyId the primary key of the company
436            * @param start the lower bound of the range of groups to return
437            * @param end the upper bound of the range of groups to return (not
438            inclusive)
439            * @return the range of groups associated with the company
440            * @throws SystemException if a system exception occurred
441            */
442            public java.util.List<com.liferay.portal.model.Group> getCompanyGroups(
443                    long companyId, int start, int end)
444                    throws com.liferay.portal.kernel.exception.SystemException {
445                    return _groupLocalService.getCompanyGroups(companyId, start, end);
446            }
447    
448            /**
449            * Returns the number of groups associated with the company.
450            *
451            * @param companyId the primary key of the company
452            * @return the number of groups associated with the company
453            * @throws SystemException if a system exception occurred
454            */
455            public int getCompanyGroupsCount(long companyId)
456                    throws com.liferay.portal.kernel.exception.SystemException {
457                    return _groupLocalService.getCompanyGroupsCount(companyId);
458            }
459    
460            /**
461            * Returns the group with the matching friendly URL.
462            *
463            * @param companyId the primary key of the company
464            * @param friendlyURL the group's friendlyURL
465            * @return the group with the friendly URL
466            * @throws PortalException if a matching group could not be found, or if the
467            friendly URL was invalid
468            * @throws SystemException if a system exception occurred
469            */
470            public com.liferay.portal.model.Group getFriendlyURLGroup(long companyId,
471                    java.lang.String friendlyURL)
472                    throws com.liferay.portal.kernel.exception.PortalException,
473                            com.liferay.portal.kernel.exception.SystemException {
474                    return _groupLocalService.getFriendlyURLGroup(companyId, friendlyURL);
475            }
476    
477            /**
478            * Returns the group with the matching group name.
479            *
480            * @param companyId the primary key of the company
481            * @param name the group's name
482            * @return the group with the name
483            * @throws PortalException if a matching group could not be found
484            * @throws SystemException if a system exception occurred
485            */
486            public com.liferay.portal.model.Group getGroup(long companyId,
487                    java.lang.String name)
488                    throws com.liferay.portal.kernel.exception.PortalException,
489                            com.liferay.portal.kernel.exception.SystemException {
490                    return _groupLocalService.getGroup(companyId, name);
491            }
492    
493            public java.lang.String getGroupDescriptiveName(
494                    com.liferay.portal.model.Group group, java.util.Locale locale)
495                    throws com.liferay.portal.kernel.exception.PortalException,
496                            com.liferay.portal.kernel.exception.SystemException {
497                    return _groupLocalService.getGroupDescriptiveName(group, locale);
498            }
499    
500            public java.lang.String getGroupDescriptiveName(long groupId,
501                    java.util.Locale locale)
502                    throws com.liferay.portal.kernel.exception.PortalException,
503                            com.liferay.portal.kernel.exception.SystemException {
504                    return _groupLocalService.getGroupDescriptiveName(groupId, locale);
505            }
506    
507            /**
508            * Returns all the sites that are children of the parent group.
509            *
510            * @param companyId the primary key of the company
511            * @param parentGroupId the primary key of the parent group
512            * @param site whether the group is to be associated with a main site
513            * @return the matching groups, or <code>null</code> if no matches were
514            found
515            * @throws SystemException if a system exception occurred
516            */
517            public java.util.List<com.liferay.portal.model.Group> getGroups(
518                    long companyId, long parentGroupId, boolean site)
519                    throws com.liferay.portal.kernel.exception.SystemException {
520                    return _groupLocalService.getGroups(companyId, parentGroupId, site);
521            }
522    
523            /**
524            * Returns the groups with the matching primary keys.
525            *
526            * @param groupIds the primary keys of the groups
527            * @return the groups with the primary keys
528            * @throws PortalException if any one of the groups could not be found
529            * @throws SystemException if a system exception occurred
530            */
531            public java.util.List<com.liferay.portal.model.Group> getGroups(
532                    long[] groupIds)
533                    throws com.liferay.portal.kernel.exception.PortalException,
534                            com.liferay.portal.kernel.exception.SystemException {
535                    return _groupLocalService.getGroups(groupIds);
536            }
537    
538            /**
539            * Returns the group associated with the layout.
540            *
541            * @param companyId the primary key of the company
542            * @param plid the primary key of the layout
543            * @return the group associated with the layout
544            * @throws PortalException if a matching group could not be found
545            * @throws SystemException if a system exception occurred
546            */
547            public com.liferay.portal.model.Group getLayoutGroup(long companyId,
548                    long plid)
549                    throws com.liferay.portal.kernel.exception.PortalException,
550                            com.liferay.portal.kernel.exception.SystemException {
551                    return _groupLocalService.getLayoutGroup(companyId, plid);
552            }
553    
554            /**
555            * Returns the group associated with the layout prototype.
556            *
557            * @param companyId the primary key of the company
558            * @param layoutPrototypeId the primary key of the layout prototype
559            * @return the group associated with the layout prototype
560            * @throws PortalException if a matching group could not be found
561            * @throws SystemException if a system exception occurred
562            */
563            public com.liferay.portal.model.Group getLayoutPrototypeGroup(
564                    long companyId, long layoutPrototypeId)
565                    throws com.liferay.portal.kernel.exception.PortalException,
566                            com.liferay.portal.kernel.exception.SystemException {
567                    return _groupLocalService.getLayoutPrototypeGroup(companyId,
568                            layoutPrototypeId);
569            }
570    
571            /**
572            * Returns the group associated with the layout set prototype.
573            *
574            * @param companyId the primary key of the company
575            * @param layoutSetPrototypeId the primary key of the layout set prototype
576            * @return the group associated with the layout set prototype
577            * @throws PortalException if a matching group could not be found
578            * @throws SystemException if a system exception occurred
579            */
580            public com.liferay.portal.model.Group getLayoutSetPrototypeGroup(
581                    long companyId, long layoutSetPrototypeId)
582                    throws com.liferay.portal.kernel.exception.PortalException,
583                            com.liferay.portal.kernel.exception.SystemException {
584                    return _groupLocalService.getLayoutSetPrototypeGroup(companyId,
585                            layoutSetPrototypeId);
586            }
587    
588            /**
589            * Returns a range of all groups that are children of the parent group and
590            * that have at least one layout.
591            *
592            * <p>
593            * Useful when paginating results. Returns a maximum of <code>end -
594            * start</code> instances. <code>start</code> and <code>end</code> are not
595            * primary keys, they are indexes in the result set. Thus, <code>0</code>
596            * refers to the first result in the set. Setting both <code>start</code>
597            * and <code>end</code> to {@link
598            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
599            * result set.
600            * </p>
601            *
602            * @param companyId the primary key of the company
603            * @param parentGroupId the primary key of the parent group
604            * @param site whether the group is to be associated with a main site
605            * @param start the lower bound of the range of groups to return
606            * @param end the upper bound of the range of groups to return (not
607            inclusive)
608            * @return the range of matching groups
609            * @throws SystemException if a system exception occurred
610            */
611            public java.util.List<com.liferay.portal.model.Group> getLayoutsGroups(
612                    long companyId, long parentGroupId, boolean site, int start, int end)
613                    throws com.liferay.portal.kernel.exception.SystemException {
614                    return _groupLocalService.getLayoutsGroups(companyId, parentGroupId,
615                            site, start, end);
616            }
617    
618            /**
619            * Returns the number of groups that are children or the parent group and
620            * that have at least one layout
621            *
622            * @param companyId the primary key of the company
623            * @param parentGroupId the primary key of the parent group
624            * @param site whether the group is to be associated with a main site
625            * @return the number of matching groups
626            * @throws SystemException if a system exception occurred
627            */
628            public int getLayoutsGroupsCount(long companyId, long parentGroupId,
629                    boolean site)
630                    throws com.liferay.portal.kernel.exception.SystemException {
631                    return _groupLocalService.getLayoutsGroupsCount(companyId,
632                            parentGroupId, site);
633            }
634    
635            /**
636            * Returns all live groups.
637            *
638            * @return all live groups
639            * @throws SystemException if a system exception occurred
640            */
641            public java.util.List<com.liferay.portal.model.Group> getLiveGroups()
642                    throws com.liferay.portal.kernel.exception.SystemException {
643                    return _groupLocalService.getLiveGroups();
644            }
645    
646            /**
647            * Returns a range of all non-system groups of a specified type (className)
648            * that have no layouts.
649            *
650            * <p>
651            * Useful when paginating results. Returns a maximum of <code>end -
652            * start</code> instances. <code>start</code> and <code>end</code> are not
653            * primary keys, they are indexes in the result set. Thus, <code>0</code>
654            * refers to the first result in the set. Setting both <code>start</code>
655            * and <code>end</code> to {@link
656            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
657            * result set.
658            * </p>
659            *
660            * @param className the entity's class name
661            * @param privateLayout whether to include groups with private layout sets
662            or non-private layout sets
663            * @param start the lower bound of the range of groups to return
664            * @param end the upper bound of the range of groups to return (not
665            inclusive)
666            * @return the range of matching groups
667            * @throws SystemException if a system exception occurred
668            */
669            public java.util.List<com.liferay.portal.model.Group> getNoLayoutsGroups(
670                    java.lang.String className, boolean privateLayout, int start, int end)
671                    throws com.liferay.portal.kernel.exception.SystemException {
672                    return _groupLocalService.getNoLayoutsGroups(className, privateLayout,
673                            start, end);
674            }
675    
676            /**
677            * Returns all non-system groups having <code>null</code> or empty friendly
678            * URLs.
679            *
680            * @return the non-system groups having <code>null</code> or empty friendly
681            URLs
682            * @throws SystemException if a system exception occurred
683            */
684            public java.util.List<com.liferay.portal.model.Group> getNullFriendlyURLGroups()
685                    throws com.liferay.portal.kernel.exception.SystemException {
686                    return _groupLocalService.getNullFriendlyURLGroups();
687            }
688    
689            /**
690            * Returns the specified organization group.
691            *
692            * @param companyId the primary key of the company
693            * @param organizationId the primary key of the organization
694            * @return the group associated with the organization
695            * @throws PortalException if a matching group could not be found
696            * @throws SystemException if a system exception occurred
697            */
698            public com.liferay.portal.model.Group getOrganizationGroup(long companyId,
699                    long organizationId)
700                    throws com.liferay.portal.kernel.exception.PortalException,
701                            com.liferay.portal.kernel.exception.SystemException {
702                    return _groupLocalService.getOrganizationGroup(companyId, organizationId);
703            }
704    
705            /**
706            * Returns the specified organization groups.
707            *
708            * @param organizations the organizations
709            * @return the groups associated with the organizations
710            */
711            public java.util.List<com.liferay.portal.model.Group> getOrganizationsGroups(
712                    java.util.List<com.liferay.portal.model.Organization> organizations) {
713                    return _groupLocalService.getOrganizationsGroups(organizations);
714            }
715    
716            /**
717            * Returns all the groups related to the organizations.
718            *
719            * @param organizations the organizations
720            * @return the groups related to the organizations
721            * @throws SystemException if a system exception occurred
722            */
723            public java.util.List<com.liferay.portal.model.Group> getOrganizationsRelatedGroups(
724                    java.util.List<com.liferay.portal.model.Organization> organizations)
725                    throws com.liferay.portal.kernel.exception.SystemException {
726                    return _groupLocalService.getOrganizationsRelatedGroups(organizations);
727            }
728    
729            /**
730            * Returns all the groups associated with the role.
731            *
732            * @param roleId the primary key of the role
733            * @return the groups associated with the role
734            * @throws SystemException if a system exception occurred
735            */
736            public java.util.List<com.liferay.portal.model.Group> getRoleGroups(
737                    long roleId) throws com.liferay.portal.kernel.exception.SystemException {
738                    return _groupLocalService.getRoleGroups(roleId);
739            }
740    
741            /**
742            * Returns the staging group.
743            *
744            * @param liveGroupId the primary key of the live group
745            * @return the staging group
746            * @throws PortalException if a matching staging group could not be found
747            * @throws SystemException if a system exception occurred
748            */
749            public com.liferay.portal.model.Group getStagingGroup(long liveGroupId)
750                    throws com.liferay.portal.kernel.exception.PortalException,
751                            com.liferay.portal.kernel.exception.SystemException {
752                    return _groupLocalService.getStagingGroup(liveGroupId);
753            }
754    
755            /**
756            * Returns the group associated with the user.
757            *
758            * @param companyId the primary key of the company
759            * @param userId the primary key of the user
760            * @return the group associated with the user
761            * @throws PortalException if a matching group could not be found
762            * @throws SystemException if a system exception occurred
763            */
764            public com.liferay.portal.model.Group getUserGroup(long companyId,
765                    long userId)
766                    throws com.liferay.portal.kernel.exception.PortalException,
767                            com.liferay.portal.kernel.exception.SystemException {
768                    return _groupLocalService.getUserGroup(companyId, userId);
769            }
770    
771            /**
772            * Returns the specified "user group" group. That is, the group that
773            * represents the {@link com.liferay.portal.model.UserGroup} entity.
774            *
775            * @param companyId the primary key of the company
776            * @param userGroupId the primary key of the user group
777            * @return the group associated with the user group
778            * @throws PortalException if a matching group could not be found
779            * @throws SystemException if a system exception occurred
780            */
781            public com.liferay.portal.model.Group getUserGroupGroup(long companyId,
782                    long userGroupId)
783                    throws com.liferay.portal.kernel.exception.PortalException,
784                            com.liferay.portal.kernel.exception.SystemException {
785                    return _groupLocalService.getUserGroupGroup(companyId, userGroupId);
786            }
787    
788            /**
789            * Returns all the user's site groups and immediate organization groups.
790            * System and staged groups are not included.
791            *
792            * @param userId the primary key of the user
793            * @return the user's groups and organization groups
794            * @throws PortalException if a user with the primary key could not be found
795            * @throws SystemException if a system exception occurred
796            */
797            public java.util.List<com.liferay.portal.model.Group> getUserGroups(
798                    long userId)
799                    throws com.liferay.portal.kernel.exception.PortalException,
800                            com.liferay.portal.kernel.exception.SystemException {
801                    return _groupLocalService.getUserGroups(userId);
802            }
803    
804            /**
805            * Returns all the user's site groups and immediate organization groups,
806            * optionally including the user's inherited organization groups and user
807            * groups. System and staged groups are not included.
808            *
809            * @param userId the primary key of the user
810            * @param inherit whether to include the user's inherited organization
811            groups and user groups
812            * @return the user's groups and immediate organization groups
813            * @throws PortalException if a user with the primary key could not be found
814            * @throws SystemException if a system exception occurred
815            */
816            public java.util.List<com.liferay.portal.model.Group> getUserGroups(
817                    long userId, boolean inherit)
818                    throws com.liferay.portal.kernel.exception.PortalException,
819                            com.liferay.portal.kernel.exception.SystemException {
820                    return _groupLocalService.getUserGroups(userId, inherit);
821            }
822    
823            /**
824            * Returns an ordered range of all the user's site groups and immediate
825            * organization groups, optionally including the user's inherited
826            * organization groups and user groups. System and staged groups are not
827            * included.
828            *
829            * <p>
830            * Useful when paginating results. Returns a maximum of <code>end -
831            * start</code> instances. <code>start</code> and <code>end</code> are not
832            * primary keys, they are indexes in the result set. Thus, <code>0</code>
833            * refers to the first result in the set. Setting both <code>start</code>
834            * and <code>end</code> to {@link
835            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
836            * result set.
837            * </p>
838            *
839            * @param userId the primary key of the user
840            * @param inherit whether to include the user's inherited organization
841            groups and user groups
842            * @param start the lower bound of the range of groups to return
843            * @param end the upper bound of the range of groups to return (not
844            inclusive)
845            * @return the range of the user's groups and immediate organization groups
846            ordered by name
847            * @throws PortalException if a user with the primary key could not be found
848            * @throws SystemException if a system exception occurred
849            */
850            public java.util.List<com.liferay.portal.model.Group> getUserGroups(
851                    long userId, boolean inherit, int start, int end)
852                    throws com.liferay.portal.kernel.exception.PortalException,
853                            com.liferay.portal.kernel.exception.SystemException {
854                    return _groupLocalService.getUserGroups(userId, inherit, start, end);
855            }
856    
857            /**
858            * Returns an ordered range of all the user's site groups and immediate
859            * organization groups. System and staged groups are not included.
860            *
861            * <p>
862            * Useful when paginating results. Returns a maximum of <code>end -
863            * start</code> instances. <code>start</code> and <code>end</code> are not
864            * primary keys, they are indexes in the result set. Thus, <code>0</code>
865            * refers to the first result in the set. Setting both <code>start</code>
866            * and <code>end</code> to {@link
867            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
868            * result set.
869            * </p>
870            *
871            * @param userId the primary key of the user
872            * @param start the lower bound of the range of groups to return
873            * @param end the upper bound of the range of groups to return (not
874            inclusive)
875            * @return the range of the user's groups and organization groups ordered by
876            name
877            * @throws PortalException if a user with the primary key could not be found
878            * @throws SystemException if a system exception occurred
879            */
880            public java.util.List<com.liferay.portal.model.Group> getUserGroups(
881                    long userId, int start, int end)
882                    throws com.liferay.portal.kernel.exception.PortalException,
883                            com.liferay.portal.kernel.exception.SystemException {
884                    return _groupLocalService.getUserGroups(userId, start, end);
885            }
886    
887            /**
888            * Returns the groups associated with the user groups.
889            *
890            * @param userGroups the user groups
891            * @return the groups associated with the user groups
892            * @throws PortalException if any one of the user group's group could not be
893            found
894            * @throws SystemException if a system exception occurred
895            */
896            public java.util.List<com.liferay.portal.model.Group> getUserGroupsGroups(
897                    java.util.List<com.liferay.portal.model.UserGroup> userGroups)
898                    throws com.liferay.portal.kernel.exception.PortalException,
899                            com.liferay.portal.kernel.exception.SystemException {
900                    return _groupLocalService.getUserGroupsGroups(userGroups);
901            }
902    
903            /**
904            * Returns all the groups related to the user groups.
905            *
906            * @param userGroups the user groups
907            * @return the groups related to the user groups
908            * @throws SystemException if a system exception occurred
909            */
910            public java.util.List<com.liferay.portal.model.Group> getUserGroupsRelatedGroups(
911                    java.util.List<com.liferay.portal.model.UserGroup> userGroups)
912                    throws com.liferay.portal.kernel.exception.SystemException {
913                    return _groupLocalService.getUserGroupsRelatedGroups(userGroups);
914            }
915    
916            /**
917            * Returns the range of all groups associated with the user's organization
918            * groups, including the ancestors of the organization groups, unless portal
919            * property <code>organizations.membership.strict</code> is set to
920            * <code>true</code>.
921            *
922            * <p>
923            * Useful when paginating results. Returns a maximum of <code>end -
924            * start</code> instances. <code>start</code> and <code>end</code> are not
925            * primary keys, they are indexes in the result set. Thus, <code>0</code>
926            * refers to the first result in the set. Setting both <code>start</code>
927            * and <code>end</code> to {@link
928            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
929            * result set.
930            * </p>
931            *
932            * @param userId the primary key of the user
933            * @param start the lower bound of the range of groups to consider
934            * @param end the upper bound of the range of groups to consider (not
935            inclusive)
936            * @return the range of groups associated with the user's organization
937            groups
938            * @throws PortalException if a user with the primary key could not be found
939            or if another portal exception occurred
940            * @throws SystemException if a system exception occurred
941            */
942            public java.util.List<com.liferay.portal.model.Group> getUserOrganizationsGroups(
943                    long userId, int start, int end)
944                    throws com.liferay.portal.kernel.exception.PortalException,
945                            com.liferay.portal.kernel.exception.SystemException {
946                    return _groupLocalService.getUserOrganizationsGroups(userId, start, end);
947            }
948    
949            /**
950            * Returns <code>true</code> if the group is associated with the role.
951            *
952            * @param roleId the primary key of the role
953            * @param groupId the primary key of the group
954            * @return <code>true</code> if the group is associated with the role;
955            <code>false</code> otherwise
956            * @throws SystemException if a system exception occurred
957            */
958            public boolean hasRoleGroup(long roleId, long groupId)
959                    throws com.liferay.portal.kernel.exception.SystemException {
960                    return _groupLocalService.hasRoleGroup(roleId, groupId);
961            }
962    
963            /**
964            * Returns <code>true</code> if the live group has a staging group.
965            *
966            * @param liveGroupId the primary key of the live group
967            * @return <code>true</code> if the live group has a staging group;
968            <code>false</code> otherwise
969            * @throws SystemException if a system exception occurred
970            */
971            public boolean hasStagingGroup(long liveGroupId)
972                    throws com.liferay.portal.kernel.exception.SystemException {
973                    return _groupLocalService.hasStagingGroup(liveGroupId);
974            }
975    
976            /**
977            * Returns <code>true</code> if the user is immediately associated with the
978            * group, or associated with the group via the user's organizations,
979            * inherited organizations, or user groups.
980            *
981            * @param userId the primary key of the user
982            * @param groupId the primary key of the group
983            * @return <code>true</code> if the user is associated with the group;
984            <code>false</code> otherwise
985            * @throws SystemException if a system exception occurred
986            */
987            public boolean hasUserGroup(long userId, long groupId)
988                    throws com.liferay.portal.kernel.exception.SystemException {
989                    return _groupLocalService.hasUserGroup(userId, groupId);
990            }
991    
992            /**
993            * Returns <code>true</code> if the user is immediately associated with the
994            * group, or optionally if the user is associated with the group via the
995            * user's organizations, inherited organizations, or user groups.
996            *
997            * @param userId the primary key of the user
998            * @param groupId the primary key of the group
999            * @param inherit whether to include organization groups and user groups to
1000            which the user belongs in the determination
1001            * @return <code>true</code> if the user is associated with the group;
1002            <code>false</code> otherwise
1003            * @throws SystemException if a system exception occurred
1004            */
1005            public boolean hasUserGroup(long userId, long groupId, boolean inherit)
1006                    throws com.liferay.portal.kernel.exception.SystemException {
1007                    return _groupLocalService.hasUserGroup(userId, groupId, inherit);
1008            }
1009    
1010            /**
1011            * Returns the group with the matching group name by first searching the
1012            * system groups and then using the finder cache.
1013            *
1014            * @param companyId the primary key of the company
1015            * @param name the group's name
1016            * @return the group with the name and associated company, or
1017            <code>null</code> if a matching group could not be found
1018            * @throws SystemException if a system exception occurred
1019            */
1020            public com.liferay.portal.model.Group loadFetchGroup(long companyId,
1021                    java.lang.String name)
1022                    throws com.liferay.portal.kernel.exception.SystemException {
1023                    return _groupLocalService.loadFetchGroup(companyId, name);
1024            }
1025    
1026            /**
1027            * Returns the group with the matching group name.
1028            *
1029            * @param companyId the primary key of the company
1030            * @param name the group's name
1031            * @return the group with the name and associated company
1032            * @throws PortalException if a matching group could not be found
1033            * @throws SystemException if a system exception occurred
1034            */
1035            public com.liferay.portal.model.Group loadGetGroup(long companyId,
1036                    java.lang.String name)
1037                    throws com.liferay.portal.kernel.exception.PortalException,
1038                            com.liferay.portal.kernel.exception.SystemException {
1039                    return _groupLocalService.loadGetGroup(companyId, name);
1040            }
1041    
1042            /**
1043            * Returns an ordered range of all the company's groups, optionally
1044            * including the user's inherited organization groups and user groups.
1045            * System and staged groups are not included.
1046            *
1047            * <p>
1048            * Useful when paginating results. Returns a maximum of <code>end -
1049            * start</code> instances. <code>start</code> and <code>end</code> are not
1050            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1051            * refers to the first result in the set. Setting both <code>start</code>
1052            * and <code>end</code> to {@link
1053            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1054            * result set.
1055            * </p>
1056            *
1057            * @param companyId the primary key of the company
1058            * @param params the finder params (optionally <code>null</code>). To
1059            include a user's organizations, inherited organizations, and user
1060            groups in the search, add an entry with key
1061            &quot;usersGroups&quot; mapped to the user's ID and an entry with
1062            key &quot;inherit&quot; mapped to a non-<code>null</code> object.
1063            For more information see {@link
1064            com.liferay.portal.service.persistence.GroupFinder}
1065            * @param start the lower bound of the range of groups to return
1066            * @param end the upper bound of the range of groups to return (not
1067            inclusive)
1068            * @return the matching groups ordered by name
1069            * @throws SystemException if a system exception occurred
1070            */
1071            public java.util.List<com.liferay.portal.model.Group> search(
1072                    long companyId,
1073                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1074                    int start, int end)
1075                    throws com.liferay.portal.kernel.exception.SystemException {
1076                    return _groupLocalService.search(companyId, params, start, end);
1077            }
1078    
1079            /**
1080            * Returns an ordered range of all the groups belonging to the parent group
1081            * that match the keywords, optionally including the user's inherited
1082            * organization groups and user groups. System and staged groups are not
1083            * included.
1084            *
1085            * <p>
1086            * Useful when paginating results. Returns a maximum of <code>end -
1087            * start</code> instances. <code>start</code> and <code>end</code> are not
1088            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1089            * refers to the first result in the set. Setting both <code>start</code>
1090            * and <code>end</code> to {@link
1091            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1092            * result set.
1093            * </p>
1094            *
1095            * @param companyId the primary key of the company
1096            * @param parentGroupId the primary key of the parent group
1097            * @param keywords the keywords (space separated), which may occur in the
1098            sites's name, or description (optionally <code>null</code>)
1099            * @param params the finder params (optionally <code>null</code>). To
1100            include the user's inherited organizations and user groups in the
1101            search, add entries having &quot;usersGroups&quot; and
1102            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1103            information see {@link
1104            com.liferay.portal.service.persistence.GroupFinder}
1105            * @param start the lower bound of the range of groups to return
1106            * @param end the upper bound of the range of groups to return (not
1107            inclusive)
1108            * @return the matching groups ordered by name
1109            * @throws SystemException if a system exception occurred
1110            */
1111            public java.util.List<com.liferay.portal.model.Group> search(
1112                    long companyId, long parentGroupId, java.lang.String keywords,
1113                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1114                    int start, int end)
1115                    throws com.liferay.portal.kernel.exception.SystemException {
1116                    return _groupLocalService.search(companyId, parentGroupId, keywords,
1117                            params, start, end);
1118            }
1119    
1120            /**
1121            * Returns an ordered range of all the groups belonging to the parent group
1122            * that match the keywords, optionally including the user's inherited
1123            * organization groups and user groups. System and staged groups are not
1124            * included.
1125            *
1126            * <p>
1127            * Useful when paginating results. Returns a maximum of <code>end -
1128            * start</code> instances. <code>start</code> and <code>end</code> are not
1129            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1130            * refers to the first result in the set. Setting both <code>start</code>
1131            * and <code>end</code> to {@link
1132            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1133            * result set.
1134            * </p>
1135            *
1136            * @param companyId the primary key of the company
1137            * @param parentGroupId the primary key of the parent group
1138            * @param keywords the keywords (space separated), which may occur in the
1139            sites's name, or description (optionally <code>null</code>)
1140            * @param params the finder params (optionally <code>null</code>). To
1141            include the user's inherited organizations and user groups in the
1142            search, add entries having &quot;usersGroups&quot; and
1143            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1144            information see {@link
1145            com.liferay.portal.service.persistence.GroupFinder}
1146            * @param start the lower bound of the range of groups to return
1147            * @param end the upper bound of the range of groups to return (not
1148            inclusive)
1149            * @param obc the comparator to order the groups (optionally
1150            <code>null</code>)
1151            * @return the matching groups ordered by comparator <code>obc</code>
1152            * @throws SystemException if a system exception occurred
1153            */
1154            public java.util.List<com.liferay.portal.model.Group> search(
1155                    long companyId, long parentGroupId, java.lang.String keywords,
1156                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1157                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
1158                    throws com.liferay.portal.kernel.exception.SystemException {
1159                    return _groupLocalService.search(companyId, parentGroupId, keywords,
1160                            params, start, end, obc);
1161            }
1162    
1163            /**
1164            * Returns an ordered range of all the site groups belonging to the parent
1165            * group and organization groups that match the name and description,
1166            * optionally including the user's inherited organization groups and user
1167            * groups. System and staged groups are not included.
1168            *
1169            * <p>
1170            * Useful when paginating results. Returns a maximum of <code>end -
1171            * start</code> instances. <code>start</code> and <code>end</code> are not
1172            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1173            * refers to the first result in the set. Setting both <code>start</code>
1174            * and <code>end</code> to {@link
1175            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1176            * result set.
1177            * </p>
1178            *
1179            * @param companyId the primary key of the company
1180            * @param parentGroupId the primary key of the parent group
1181            * @param name the group's name (optionally <code>null</code>)
1182            * @param description the group's description (optionally
1183            <code>null</code>)
1184            * @param params the finder params (optionally <code>null</code>). To
1185            include the user's inherited organizations and user groups in the
1186            search, add entries having &quot;usersGroups&quot; and
1187            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1188            information see {@link
1189            com.liferay.portal.service.persistence.GroupFinder}
1190            * @param andOperator whether every field must match its keywords, or just
1191            one field.
1192            * @param start the lower bound of the range of groups to return
1193            * @param end the upper bound of the range of groups to return (not
1194            inclusive)
1195            * @return the matching groups ordered by name
1196            * @throws SystemException if a system exception occurred
1197            */
1198            public java.util.List<com.liferay.portal.model.Group> search(
1199                    long companyId, long parentGroupId, java.lang.String name,
1200                    java.lang.String description,
1201                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1202                    boolean andOperator, int start, int end)
1203                    throws com.liferay.portal.kernel.exception.SystemException {
1204                    return _groupLocalService.search(companyId, parentGroupId, name,
1205                            description, params, andOperator, start, end);
1206            }
1207    
1208            /**
1209            * Returns an ordered range of all the site groups belonging to the parent
1210            * group and organization groups that match the name and description,
1211            * optionally including the user's inherited organization groups and user
1212            * groups. System and staged groups are not included.
1213            *
1214            * <p>
1215            * Useful when paginating results. Returns a maximum of <code>end -
1216            * start</code> instances. <code>start</code> and <code>end</code> are not
1217            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1218            * refers to the first result in the set. Setting both <code>start</code>
1219            * and <code>end</code> to {@link
1220            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1221            * result set.
1222            * </p>
1223            *
1224            * @param companyId the primary key of the company
1225            * @param parentGroupId the primary key of the parent group
1226            * @param name the group's name (optionally <code>null</code>)
1227            * @param description the group's description (optionally
1228            <code>null</code>)
1229            * @param params the finder params (optionally <code>null</code>). To
1230            include the user's inherited organizations and user groups in the
1231            search, add entries having &quot;usersGroups&quot; and
1232            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1233            information see {@link
1234            com.liferay.portal.service.persistence.GroupFinder}
1235            * @param andOperator whether every field must match its keywords, or just
1236            one field.
1237            * @param start the lower bound of the range of groups to return
1238            * @param end the upper bound of the range of groups to return (not
1239            inclusive)
1240            * @param obc the comparator to order the groups (optionally
1241            <code>null</code>)
1242            * @return the matching groups ordered by comparator <code>obc</code>
1243            * @throws SystemException if a system exception occurred
1244            */
1245            public java.util.List<com.liferay.portal.model.Group> search(
1246                    long companyId, long parentGroupId, java.lang.String name,
1247                    java.lang.String description,
1248                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1249                    boolean andOperator, int start, int end,
1250                    com.liferay.portal.kernel.util.OrderByComparator obc)
1251                    throws com.liferay.portal.kernel.exception.SystemException {
1252                    return _groupLocalService.search(companyId, parentGroupId, name,
1253                            description, params, andOperator, start, end, obc);
1254            }
1255    
1256            /**
1257            * Returns an ordered range of all the groups belonging to the parent group
1258            * that match the class name IDs and keywords, optionally including the
1259            * user's inherited organization groups and user groups. System and staged
1260            * groups are not included.
1261            *
1262            * <p>
1263            * Useful when paginating results. Returns a maximum of <code>end -
1264            * start</code> instances. <code>start</code> and <code>end</code> are not
1265            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1266            * refers to the first result in the set. Setting both <code>start</code>
1267            * and <code>end</code> to {@link
1268            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1269            * result set.
1270            * </p>
1271            *
1272            * @param companyId the primary key of the company
1273            * @param classNameIds the class names of entities to include in the search
1274            (optionally <code>null</code>)
1275            * @param parentGroupId the primary key of the parent group
1276            * @param keywords the keywords (space separated), which may occur in the
1277            sites's name, or description (optionally <code>null</code>)
1278            * @param params the finder params (optionally <code>null</code>). To
1279            include a user's organizations, inherited organizations, and user
1280            groups in the search, add an entry with key
1281            &quot;usersGroups&quot; mapped to the user's ID and an entry with
1282            key &quot;inherit&quot; mapped to a non-<code>null</code> object.
1283            For more information see {@link
1284            com.liferay.portal.service.persistence.GroupFinder}
1285            * @param start the lower bound of the range of groups to return
1286            * @param end the upper bound of the range of groups to return (not
1287            inclusive)
1288            * @return the matching groups ordered by name
1289            * @throws SystemException if a system exception occurred
1290            */
1291            public java.util.List<com.liferay.portal.model.Group> search(
1292                    long companyId, long[] classNameIds, long parentGroupId,
1293                    java.lang.String keywords,
1294                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1295                    int start, int end)
1296                    throws com.liferay.portal.kernel.exception.SystemException {
1297                    return _groupLocalService.search(companyId, classNameIds,
1298                            parentGroupId, keywords, params, start, end);
1299            }
1300    
1301            /**
1302            * Returns an ordered range of all the groups belonging to the parent group
1303            * that match the class name IDs and keywords, optionally including the
1304            * user's inherited organization groups and user groups. System and staged
1305            * groups are not included.
1306            *
1307            * <p>
1308            * Useful when paginating results. Returns a maximum of <code>end -
1309            * start</code> instances. <code>start</code> and <code>end</code> are not
1310            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1311            * refers to the first result in the set. Setting both <code>start</code>
1312            * and <code>end</code> to {@link
1313            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1314            * result set.
1315            * </p>
1316            *
1317            * @param companyId the primary key of the company
1318            * @param classNameIds the group's class name IDs (optionally
1319            <code>null</code>)
1320            * @param parentGroupId the primary key of the parent group
1321            * @param keywords the keywords (space separated), which may occur in the
1322            sites's name, or description (optionally <code>null</code>)
1323            * @param params the finder params (optionally <code>null</code>). To
1324            include a user's organizations, inherited organizations, and user
1325            groups in the search, add an entry with key
1326            &quot;usersGroups&quot; mapped to the user's ID and an entry with
1327            key &quot;inherit&quot; mapped to a non-<code>null</code> object.
1328            For more information see {@link
1329            com.liferay.portal.service.persistence.GroupFinder}
1330            * @param start the lower bound of the range of groups to return
1331            * @param end the upper bound of the range of groups to return (not
1332            inclusive)
1333            * @param obc the comparator to order the groups (optionally
1334            <code>null</code>)
1335            * @return the matching groups ordered by comparator <code>obc</code>
1336            * @throws SystemException if a system exception occurred
1337            */
1338            public java.util.List<com.liferay.portal.model.Group> search(
1339                    long companyId, long[] classNameIds, long parentGroupId,
1340                    java.lang.String keywords,
1341                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1342                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
1343                    throws com.liferay.portal.kernel.exception.SystemException {
1344                    return _groupLocalService.search(companyId, classNameIds,
1345                            parentGroupId, keywords, params, start, end, obc);
1346            }
1347    
1348            /**
1349            * Returns an ordered range of all the groups belonging to the parent group
1350            * that match the class name IDs, name, and description, optionally
1351            * including the user's inherited organization groups and user groups.
1352            * System and staged groups are not included.
1353            *
1354            * <p>
1355            * Useful when paginating results. Returns a maximum of <code>end -
1356            * start</code> instances. <code>start</code> and <code>end</code> are not
1357            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1358            * refers to the first result in the set. Setting both <code>start</code>
1359            * and <code>end</code> to {@link
1360            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1361            * result set.
1362            * </p>
1363            *
1364            * @param companyId the primary key of the company
1365            * @param classNameIds the class names of entities to include in the search
1366            (optionally <code>null</code>)
1367            * @param parentGroupId the primary key of the parent group
1368            * @param name the group's name (optionally <code>null</code>)
1369            * @param description the group's description (optionally
1370            <code>null</code>)
1371            * @param params the finder params (optionally <code>null</code>). To
1372            include a user's organizations, inherited organizations, and user
1373            groups in the search, add an entry with key
1374            &quot;usersGroups&quot; mapped to the user's ID and an entry with
1375            key &quot;inherit&quot; mapped to a non-<code>null</code> object.
1376            For more information see {@link
1377            com.liferay.portal.service.persistence.GroupFinder}
1378            * @param andOperator whether every field must match its keywords, or just
1379            one field.
1380            * @param start the lower bound of the range of groups to return
1381            * @param end the upper bound of the range of groups to return (not
1382            inclusive)
1383            * @return the matching groups ordered by name
1384            * @throws SystemException if a system exception occurred
1385            */
1386            public java.util.List<com.liferay.portal.model.Group> search(
1387                    long companyId, long[] classNameIds, long parentGroupId,
1388                    java.lang.String name, java.lang.String description,
1389                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1390                    boolean andOperator, int start, int end)
1391                    throws com.liferay.portal.kernel.exception.SystemException {
1392                    return _groupLocalService.search(companyId, classNameIds,
1393                            parentGroupId, name, description, params, andOperator, start, end);
1394            }
1395    
1396            /**
1397            * Returns an ordered range of all the groups belonging to the parent group
1398            * that match the class name IDs, name, and description, optionally
1399            * including the user's inherited organization groups and user groups.
1400            * System and staged groups are not included.
1401            *
1402            * <p>
1403            * Useful when paginating results. Returns a maximum of <code>end -
1404            * start</code> instances. <code>start</code> and <code>end</code> are not
1405            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1406            * refers to the first result in the set. Setting both <code>start</code>
1407            * and <code>end</code> to {@link
1408            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1409            * result set.
1410            * </p>
1411            *
1412            * @param companyId the primary key of the company
1413            * @param classNameIds the group's class name IDs (optionally
1414            <code>null</code>)
1415            * @param parentGroupId the primary key of the parent group
1416            * @param name the group's name (optionally <code>null</code>)
1417            * @param description the group's description (optionally
1418            <code>null</code>)
1419            * @param params the finder params (optionally <code>null</code>). To
1420            include a user's organizations, inherited organizations, and user
1421            groups in the search, add an entry with key
1422            &quot;usersGroups&quot; mapped to the user's ID and an entry with
1423            key &quot;inherit&quot; mapped to a non-<code>null</code> object.
1424            For more information see {@link
1425            com.liferay.portal.service.persistence.GroupFinder}
1426            * @param andOperator whether every field must match its keywords, or just
1427            one field.
1428            * @param start the lower bound of the range of groups to return
1429            * @param end the upper bound of the range of groups to return (not
1430            inclusive)
1431            * @param obc the comparator to order the groups (optionally
1432            <code>null</code>)
1433            * @return the matching groups ordered by comparator <code>obc</code>
1434            * @throws SystemException if a system exception occurred
1435            */
1436            public java.util.List<com.liferay.portal.model.Group> search(
1437                    long companyId, long[] classNameIds, long parentGroupId,
1438                    java.lang.String name, java.lang.String description,
1439                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1440                    boolean andOperator, int start, int end,
1441                    com.liferay.portal.kernel.util.OrderByComparator obc)
1442                    throws com.liferay.portal.kernel.exception.SystemException {
1443                    return _groupLocalService.search(companyId, classNameIds,
1444                            parentGroupId, name, description, params, andOperator, start, end,
1445                            obc);
1446            }
1447    
1448            /**
1449            * Returns an ordered range of all the groups that match the class name IDs
1450            * and keywords, optionally including the user's inherited organization
1451            * groups and user groups. System and staged groups are not included.
1452            *
1453            * <p>
1454            * Useful when paginating results. Returns a maximum of <code>end -
1455            * start</code> instances. <code>start</code> and <code>end</code> are not
1456            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1457            * refers to the first result in the set. Setting both <code>start</code>
1458            * and <code>end</code> to {@link
1459            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1460            * result set.
1461            * </p>
1462            *
1463            * @param companyId the primary key of the company
1464            * @param classNameIds the class names of entities to include in the search
1465            (optionally <code>null</code>)
1466            * @param keywords the keywords (space separated), which may occur in the
1467            sites's name, or description (optionally <code>null</code>)
1468            * @param params the finder params (optionally <code>null</code>). To
1469            include a user's organizations, inherited organizations, and user
1470            groups in the search, add an entry with key
1471            &quot;usersGroups&quot; mapped to the user's ID and an entry with
1472            key &quot;inherit&quot; mapped to a non-<code>null</code> object.
1473            For more information see {@link
1474            com.liferay.portal.service.persistence.GroupFinder}
1475            * @param start the lower bound of the range of groups to return
1476            * @param end the upper bound of the range of groups to return (not
1477            inclusive)
1478            * @return the matching groups ordered by name
1479            * @throws SystemException if a system exception occurred
1480            */
1481            public java.util.List<com.liferay.portal.model.Group> search(
1482                    long companyId, long[] classNameIds, java.lang.String keywords,
1483                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1484                    int start, int end)
1485                    throws com.liferay.portal.kernel.exception.SystemException {
1486                    return _groupLocalService.search(companyId, classNameIds, keywords,
1487                            params, start, end);
1488            }
1489    
1490            /**
1491            * Returns an ordered range of all the groups that match the class name IDs
1492            * and keywords, optionally including the user's inherited organization
1493            * groups and user groups. System and staged groups are not included.
1494            *
1495            * <p>
1496            * Useful when paginating results. Returns a maximum of <code>end -
1497            * start</code> instances. <code>start</code> and <code>end</code> are not
1498            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1499            * refers to the first result in the set. Setting both <code>start</code>
1500            * and <code>end</code> to {@link
1501            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1502            * result set.
1503            * </p>
1504            *
1505            * @param companyId the primary key of the company
1506            * @param classNameIds the group's class name IDs (optionally
1507            <code>null</code>)
1508            * @param keywords the keywords (space separated), which may occur in the
1509            sites's name, or description (optionally <code>null</code>)
1510            * @param params the finder params (optionally <code>null</code>). To
1511            include a user's organizations, inherited organizations, and user
1512            groups in the search, add an entry with key
1513            &quot;usersGroups&quot; mapped to the user's ID and an entry with
1514            key &quot;inherit&quot; mapped to a non-<code>null</code> object.
1515            For more information see {@link
1516            com.liferay.portal.service.persistence.GroupFinder}
1517            * @param start the lower bound of the range of groups to return
1518            * @param end the upper bound of the range of groups to return (not
1519            inclusive)
1520            * @param obc the comparator to order the groups (optionally
1521            <code>null</code>)
1522            * @return the matching groups ordered by comparator <code>obc</code>
1523            * @throws SystemException if a system exception occurred
1524            */
1525            public java.util.List<com.liferay.portal.model.Group> search(
1526                    long companyId, long[] classNameIds, java.lang.String keywords,
1527                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1528                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
1529                    throws com.liferay.portal.kernel.exception.SystemException {
1530                    return _groupLocalService.search(companyId, classNameIds, keywords,
1531                            params, start, end, obc);
1532            }
1533    
1534            /**
1535            * Returns an ordered range of all the groups that match the class name IDs,
1536            * name, and description, optionally including the user's inherited
1537            * organization groups and user groups. System and staged groups are not
1538            * included.
1539            *
1540            * <p>
1541            * Useful when paginating results. Returns a maximum of <code>end -
1542            * start</code> instances. <code>start</code> and <code>end</code> are not
1543            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1544            * refers to the first result in the set. Setting both <code>start</code>
1545            * and <code>end</code> to {@link
1546            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1547            * result set.
1548            * </p>
1549            *
1550            * @param companyId the primary key of the company
1551            * @param classNameIds the class names of entities to include in the search
1552            (optionally <code>null</code>)
1553            * @param name the group's name (optionally <code>null</code>)
1554            * @param description the group's description (optionally
1555            <code>null</code>)
1556            * @param params the finder params (optionally <code>null</code>). To
1557            include a user's organizations, inherited organizations, and user
1558            groups in the search, add an entry with key
1559            &quot;usersGroups&quot; mapped to the user's ID and an entry with
1560            key &quot;inherit&quot; mapped to a non-<code>null</code> object.
1561            For more information see {@link
1562            com.liferay.portal.service.persistence.GroupFinder}
1563            * @param andOperator whether every field must match its keywords, or just
1564            one field.
1565            * @param start the lower bound of the range of groups to return
1566            * @param end the upper bound of the range of groups to return (not
1567            inclusive)
1568            * @return the matching groups ordered by name
1569            * @throws SystemException if a system exception occurred
1570            */
1571            public java.util.List<com.liferay.portal.model.Group> search(
1572                    long companyId, long[] classNameIds, java.lang.String name,
1573                    java.lang.String description,
1574                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1575                    boolean andOperator, int start, int end)
1576                    throws com.liferay.portal.kernel.exception.SystemException {
1577                    return _groupLocalService.search(companyId, classNameIds, name,
1578                            description, params, andOperator, start, end);
1579            }
1580    
1581            /**
1582            * Returns an ordered range of all the groups that match the class name IDs,
1583            * name, and description, optionally including the user's inherited
1584            * organization groups and user groups. System and staged groups are not
1585            * included.
1586            *
1587            * <p>
1588            * Useful when paginating results. Returns a maximum of <code>end -
1589            * start</code> instances. <code>start</code> and <code>end</code> are not
1590            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1591            * refers to the first result in the set. Setting both <code>start</code>
1592            * and <code>end</code> to {@link
1593            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1594            * result set.
1595            * </p>
1596            *
1597            * @param companyId the primary key of the company
1598            * @param classNameIds the group's class name IDs (optionally
1599            <code>null</code>)
1600            * @param name the group's name (optionally <code>null</code>)
1601            * @param description the group's description (optionally
1602            <code>null</code>)
1603            * @param params the finder params (optionally <code>null</code>). To
1604            include a user's organizations, inherited organizations, and user
1605            groups in the search, add an entry with key
1606            &quot;usersGroups&quot; mapped to the user's ID and an entry with
1607            key &quot;inherit&quot; mapped to a non-<code>null</code> object.
1608            For more information see {@link
1609            com.liferay.portal.service.persistence.GroupFinder}
1610            * @param andOperator whether every field must match its keywords, or just
1611            one field.
1612            * @param start the lower bound of the range of groups to return
1613            * @param end the upper bound of the range of groups to return (not
1614            inclusive)
1615            * @param obc the comparator to order the groups (optionally
1616            <code>null</code>)
1617            * @return the matching groups ordered by comparator <code>obc</code>
1618            * @throws SystemException if a system exception occurred
1619            */
1620            public java.util.List<com.liferay.portal.model.Group> search(
1621                    long companyId, long[] classNameIds, java.lang.String name,
1622                    java.lang.String description,
1623                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1624                    boolean andOperator, int start, int end,
1625                    com.liferay.portal.kernel.util.OrderByComparator obc)
1626                    throws com.liferay.portal.kernel.exception.SystemException {
1627                    return _groupLocalService.search(companyId, classNameIds, name,
1628                            description, params, andOperator, start, end, obc);
1629            }
1630    
1631            /**
1632            * Returns an ordered range of all the groups that match the keywords,
1633            * optionally including the user's inherited organization groups and user
1634            * groups. System and staged groups are not included.
1635            *
1636            * <p>
1637            * Useful when paginating results. Returns a maximum of <code>end -
1638            * start</code> instances. <code>start</code> and <code>end</code> are not
1639            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1640            * refers to the first result in the set. Setting both <code>start</code>
1641            * and <code>end</code> to {@link
1642            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1643            * result set.
1644            * </p>
1645            *
1646            * @param companyId the primary key of the company
1647            * @param keywords the keywords (space separated), which may occur in the
1648            sites's name, or description (optionally <code>null</code>)
1649            * @param params the finder params (optionally <code>null</code>). To
1650            include the user's inherited organizations and user groups in the
1651            search, add entries having &quot;usersGroups&quot; and
1652            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1653            information see {@link
1654            com.liferay.portal.service.persistence.GroupFinder}
1655            * @param start the lower bound of the range of groups to return
1656            * @param end the upper bound of the range of groups to return (not
1657            inclusive)
1658            * @return the matching groups ordered by name
1659            * @throws SystemException if a system exception occurred
1660            */
1661            public java.util.List<com.liferay.portal.model.Group> search(
1662                    long companyId, java.lang.String keywords,
1663                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1664                    int start, int end)
1665                    throws com.liferay.portal.kernel.exception.SystemException {
1666                    return _groupLocalService.search(companyId, keywords, params, start, end);
1667            }
1668    
1669            /**
1670            * Returns an ordered range of all the groups that match the keywords,
1671            * optionally including the user's inherited organization groups and user
1672            * groups. System and staged groups are not included.
1673            *
1674            * <p>
1675            * Useful when paginating results. Returns a maximum of <code>end -
1676            * start</code> instances. <code>start</code> and <code>end</code> are not
1677            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1678            * refers to the first result in the set. Setting both <code>start</code>
1679            * and <code>end</code> to {@link
1680            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1681            * result set.
1682            * </p>
1683            *
1684            * @param companyId the primary key of the company
1685            * @param keywords the keywords (space separated), which may occur in the
1686            sites's name, or description (optionally <code>null</code>)
1687            * @param params the finder params (optionally <code>null</code>). To
1688            include the user's inherited organizations and user groups in the
1689            search, add entries having &quot;usersGroups&quot; and
1690            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1691            information see {@link
1692            com.liferay.portal.service.persistence.GroupFinder}
1693            * @param start the lower bound of the range of groups to return
1694            * @param end the upper bound of the range of groups to return (not
1695            inclusive)
1696            * @param obc the comparator to order the groups (optionally
1697            <code>null</code>)
1698            * @return the matching groups ordered by comparator <code>obc</code>
1699            * @throws SystemException if a system exception occurred
1700            */
1701            public java.util.List<com.liferay.portal.model.Group> search(
1702                    long companyId, java.lang.String keywords,
1703                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1704                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
1705                    throws com.liferay.portal.kernel.exception.SystemException {
1706                    return _groupLocalService.search(companyId, keywords, params, start,
1707                            end, obc);
1708            }
1709    
1710            /**
1711            * Returns an ordered range of all the site groups and organization groups
1712            * that match the name and description, optionally including the user's
1713            * inherited organization groups and user groups. System and staged groups
1714            * are not included.
1715            *
1716            * <p>
1717            * Useful when paginating results. Returns a maximum of <code>end -
1718            * start</code> instances. <code>start</code> and <code>end</code> are not
1719            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1720            * refers to the first result in the set. Setting both <code>start</code>
1721            * and <code>end</code> to {@link
1722            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1723            * result set.
1724            * </p>
1725            *
1726            * @param companyId the primary key of the company
1727            * @param name the group's name (optionally <code>null</code>)
1728            * @param description the group's description (optionally
1729            <code>null</code>)
1730            * @param params the finder params (optionally <code>null</code>). To
1731            include the user's inherited organizations and user groups in the
1732            search, add entries having &quot;usersGroups&quot; and
1733            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1734            information see {@link
1735            com.liferay.portal.service.persistence.GroupFinder}
1736            * @param andOperator whether every field must match its keywords, or just
1737            one field.
1738            * @param start the lower bound of the range of groups to return
1739            * @param end the upper bound of the range of groups to return (not
1740            inclusive)
1741            * @return the matching groups ordered by name
1742            * @throws SystemException if a system exception occurred
1743            */
1744            public java.util.List<com.liferay.portal.model.Group> search(
1745                    long companyId, java.lang.String name, java.lang.String description,
1746                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1747                    boolean andOperator, int start, int end)
1748                    throws com.liferay.portal.kernel.exception.SystemException {
1749                    return _groupLocalService.search(companyId, name, description, params,
1750                            andOperator, start, end);
1751            }
1752    
1753            /**
1754            * Returns an ordered range of all the site groups and organization groups
1755            * that match the name and description, optionally including the user's
1756            * inherited organization groups and user groups. System and staged groups
1757            * are not included.
1758            *
1759            * <p>
1760            * Useful when paginating results. Returns a maximum of <code>end -
1761            * start</code> instances. <code>start</code> and <code>end</code> are not
1762            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1763            * refers to the first result in the set. Setting both <code>start</code>
1764            * and <code>end</code> to {@link
1765            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1766            * result set.
1767            * </p>
1768            *
1769            * @param companyId the primary key of the company
1770            * @param name the group's name (optionally <code>null</code>)
1771            * @param description the group's description (optionally
1772            <code>null</code>)
1773            * @param params the finder params (optionally <code>null</code>). To
1774            include the user's inherited organizations and user groups in the
1775            search, add entries having &quot;usersGroups&quot; and
1776            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1777            information see {@link
1778            com.liferay.portal.service.persistence.GroupFinder}
1779            * @param andOperator whether every field must match its keywords, or just
1780            one field.
1781            * @param start the lower bound of the range of groups to return
1782            * @param end the upper bound of the range of groups to return (not
1783            inclusive)
1784            * @param obc the comparator to order the groups (optionally
1785            <code>null</code>)
1786            * @return the matching groups ordered by comparator <code>obc</code>
1787            * @throws SystemException if a system exception occurred
1788            */
1789            public java.util.List<com.liferay.portal.model.Group> search(
1790                    long companyId, java.lang.String name, java.lang.String description,
1791                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1792                    boolean andOperator, int start, int end,
1793                    com.liferay.portal.kernel.util.OrderByComparator obc)
1794                    throws com.liferay.portal.kernel.exception.SystemException {
1795                    return _groupLocalService.search(companyId, name, description, params,
1796                            andOperator, start, end, obc);
1797            }
1798    
1799            /**
1800            * Returns the number of groups belonging to the parent group that match the
1801            * keywords, optionally including the user's inherited organization groups
1802            * and user groups. System and staged groups are not included.
1803            *
1804            * @param companyId the primary key of the company
1805            * @param parentGroupId the primary key of the parent group
1806            * @param keywords the keywords (space separated), which may occur in the
1807            sites's name, or description (optionally <code>null</code>)
1808            * @param params the finder params (optionally <code>null</code>). To
1809            include the user's inherited organization groups and user groups
1810            in the search, add entries having &quot;usersGroups&quot; and
1811            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1812            information see {@link
1813            com.liferay.portal.service.persistence.GroupFinder}
1814            * @return the number of matching groups
1815            * @throws SystemException if a system exception occurred
1816            */
1817            public int searchCount(long companyId, long parentGroupId,
1818                    java.lang.String keywords,
1819                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params)
1820                    throws com.liferay.portal.kernel.exception.SystemException {
1821                    return _groupLocalService.searchCount(companyId, parentGroupId,
1822                            keywords, params);
1823            }
1824    
1825            /**
1826            * Returns the number of groups belonging to the parent group and immediate
1827            * organization groups that match the name and description, optionally
1828            * including the user's inherited organization groups and user groups.
1829            * System and staged groups are not included.
1830            *
1831            * @param companyId the primary key of the company
1832            * @param parentGroupId the primary key of the parent group
1833            * @param name the group's name (optionally <code>null</code>)
1834            * @param description the group's description (optionally
1835            <code>null</code>)
1836            * @param params the finder params (optionally <code>null</code>). To
1837            include the user's inherited organization groups and user groups
1838            in the search, add entries having &quot;usersGroups&quot; and
1839            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1840            information see {@link
1841            com.liferay.portal.service.persistence.GroupFinder}
1842            * @param andOperator whether every field must match its keywords, or just
1843            one field.
1844            * @return the number of matching groups
1845            * @throws SystemException if a system exception occurred
1846            */
1847            public int searchCount(long companyId, long parentGroupId,
1848                    java.lang.String name, java.lang.String description,
1849                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1850                    boolean andOperator)
1851                    throws com.liferay.portal.kernel.exception.SystemException {
1852                    return _groupLocalService.searchCount(companyId, parentGroupId, name,
1853                            description, params, andOperator);
1854            }
1855    
1856            /**
1857            * Returns the number of groups belonging to the parent group that match the
1858            * class name IDs, and keywords, optionally including the user's inherited
1859            * organization groups and user groups. System and staged groups are not
1860            * included.
1861            *
1862            * @param companyId the primary key of the company
1863            * @param classNameIds the class names of entities to include in the search
1864            (optionally <code>null</code>)
1865            * @param parentGroupId the primary key of the parent group
1866            * @param keywords the keywords (space separated), which may occur in the
1867            sites's name, or description (optionally <code>null</code>)
1868            * @param params the finder params (optionally <code>null</code>). To
1869            include the user's inherited organization groups and user groups
1870            in the search, add entries having &quot;usersGroups&quot; and
1871            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1872            information see {@link
1873            com.liferay.portal.service.persistence.GroupFinder}
1874            * @return the number of matching groups
1875            * @throws SystemException if a system exception occurred
1876            */
1877            public int searchCount(long companyId, long[] classNameIds,
1878                    long parentGroupId, java.lang.String keywords,
1879                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params)
1880                    throws com.liferay.portal.kernel.exception.SystemException {
1881                    return _groupLocalService.searchCount(companyId, classNameIds,
1882                            parentGroupId, keywords, params);
1883            }
1884    
1885            /**
1886            * Returns the number of groups belonging to the parent group that match the
1887            * class name IDs, name, and description, optionally including the user's
1888            * inherited organization groups and user groups. System and staged groups
1889            * are not included.
1890            *
1891            * @param companyId the primary key of the company
1892            * @param classNameIds the class names of entities to include in the search
1893            (optionally <code>null</code>)
1894            * @param parentGroupId the primary key of the parent group
1895            * @param name the group's name (optionally <code>null</code>)
1896            * @param description the group's description (optionally
1897            <code>null</code>)
1898            * @param params the finder params (optionally <code>null</code>). To
1899            include the user's inherited organization groups and user groups
1900            in the search, add entries having &quot;usersGroups&quot; and
1901            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1902            information see {@link
1903            com.liferay.portal.service.persistence.GroupFinder}
1904            * @param andOperator whether every field must match its keywords, or just
1905            one field.
1906            * @return the number of matching groups
1907            * @throws SystemException if a system exception occurred
1908            */
1909            public int searchCount(long companyId, long[] classNameIds,
1910                    long parentGroupId, java.lang.String name,
1911                    java.lang.String description,
1912                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1913                    boolean andOperator)
1914                    throws com.liferay.portal.kernel.exception.SystemException {
1915                    return _groupLocalService.searchCount(companyId, classNameIds,
1916                            parentGroupId, name, description, params, andOperator);
1917            }
1918    
1919            /**
1920            * Returns the number of groups that match the class name IDs, and keywords,
1921            * optionally including the user's inherited organization groups and user
1922            * groups. System and staged groups are not included.
1923            *
1924            * @param companyId the primary key of the company
1925            * @param classNameIds the class names of entities to include in the search
1926            (optionally <code>null</code>)
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                    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                            keywords, params);
1944            }
1945    
1946            /**
1947            * Returns the number of groups that match the class name IDs, name, and
1948            * description, optionally including the user's inherited organization
1949            * groups and user groups. System and staged groups are not included.
1950            *
1951            * @param companyId the primary key of the company
1952            * @param classNameIds the class names of entities to include in the search
1953            (optionally <code>null</code>)
1954            * @param name the group's name (optionally <code>null</code>)
1955            * @param description the group's description (optionally
1956            <code>null</code>)
1957            * @param params the finder params (optionally <code>null</code>). To
1958            include the user's inherited organization groups and user groups
1959            in the search, add entries having &quot;usersGroups&quot; and
1960            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1961            information see {@link
1962            com.liferay.portal.service.persistence.GroupFinder}
1963            * @param andOperator whether every field must match its keywords, or just
1964            one field.
1965            * @return the number of matching groups
1966            * @throws SystemException if a system exception occurred
1967            */
1968            public int searchCount(long companyId, long[] classNameIds,
1969                    java.lang.String name, java.lang.String description,
1970                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
1971                    boolean andOperator)
1972                    throws com.liferay.portal.kernel.exception.SystemException {
1973                    return _groupLocalService.searchCount(companyId, classNameIds, name,
1974                            description, params, andOperator);
1975            }
1976    
1977            /**
1978            * Returns the number of groups that match the keywords, optionally
1979            * including the user's inherited organization groups and user groups.
1980            * System and staged groups are not included.
1981            *
1982            * @param companyId the primary key of the company
1983            * @param keywords the keywords (space separated), which may occur in the
1984            sites's name, or description (optionally <code>null</code>)
1985            * @param params the finder params (optionally <code>null</code>). To
1986            include the user's inherited organization groups and user groups
1987            in the search, add entries having &quot;usersGroups&quot; and
1988            &quot;inherit&quot; as keys mapped to the the user's ID. For more
1989            information see {@link
1990            com.liferay.portal.service.persistence.GroupFinder}
1991            * @return the number of matching groups
1992            * @throws SystemException if a system exception occurred
1993            */
1994            public int searchCount(long companyId, java.lang.String keywords,
1995                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params)
1996                    throws com.liferay.portal.kernel.exception.SystemException {
1997                    return _groupLocalService.searchCount(companyId, keywords, params);
1998            }
1999    
2000            /**
2001            * Returns the number of groups and immediate organization groups that match
2002            * the name and description, optionally including the user's inherited
2003            * organization groups and user groups. System and staged groups are not
2004            * included.
2005            *
2006            * @param companyId the primary key of the company
2007            * @param name the group's name (optionally <code>null</code>)
2008            * @param description the group's description (optionally
2009            <code>null</code>)
2010            * @param params the finder params (optionally <code>null</code>). To
2011            include the user's inherited organization groups and user groups
2012            in the search, add entries having &quot;usersGroups&quot; and
2013            &quot;inherit&quot; as keys mapped to the the user's ID. For more
2014            information see {@link
2015            com.liferay.portal.service.persistence.GroupFinder}
2016            * @param andOperator whether every field must match its keywords, or just
2017            one field.
2018            * @return the number of matching groups
2019            * @throws SystemException if a system exception occurred
2020            */
2021            public int searchCount(long companyId, java.lang.String name,
2022                    java.lang.String description,
2023                    java.util.LinkedHashMap<java.lang.String, java.lang.Object> params,
2024                    boolean andOperator)
2025                    throws com.liferay.portal.kernel.exception.SystemException {
2026                    return _groupLocalService.searchCount(companyId, name, description,
2027                            params, andOperator);
2028            }
2029    
2030            /**
2031            * Sets the groups associated with the role, removing and adding
2032            * associations as necessary.
2033            *
2034            * @param roleId the primary key of the role
2035            * @param groupIds the primary keys of the groups
2036            * @throws SystemException if a system exception occurred
2037            */
2038            public void setRoleGroups(long roleId, long[] groupIds)
2039                    throws com.liferay.portal.kernel.exception.SystemException {
2040                    _groupLocalService.setRoleGroups(roleId, groupIds);
2041            }
2042    
2043            /**
2044            * Removes the groups from the role.
2045            *
2046            * @param roleId the primary key of the role
2047            * @param groupIds the primary keys of the groups
2048            * @throws SystemException if a system exception occurred
2049            */
2050            public void unsetRoleGroups(long roleId, long[] groupIds)
2051                    throws com.liferay.portal.kernel.exception.SystemException {
2052                    _groupLocalService.unsetRoleGroups(roleId, groupIds);
2053            }
2054    
2055            /**
2056            * Removes the user from the groups.
2057            *
2058            * @param userId the primary key of the user
2059            * @param groupIds the primary keys of the groups
2060            * @throws SystemException if a system exception occurred
2061            */
2062            public void unsetUserGroups(long userId, long[] groupIds)
2063                    throws com.liferay.portal.kernel.exception.SystemException {
2064                    _groupLocalService.unsetUserGroups(userId, groupIds);
2065            }
2066    
2067            /**
2068            * Updates the group's asset replacing categories and tag names.
2069            *
2070            * @param userId the primary key of the user
2071            * @param group the group
2072            * @param assetCategoryIds the primary keys of the asset categories
2073            (optionally <code>null</code>)
2074            * @param assetTagNames the asset tag names (optionally <code>null</code>)
2075            * @throws PortalException if a user with the primary key could not be found
2076            * @throws SystemException if a system exception occurred
2077            */
2078            public void updateAsset(long userId, com.liferay.portal.model.Group group,
2079                    long[] assetCategoryIds, java.lang.String[] assetTagNames)
2080                    throws com.liferay.portal.kernel.exception.PortalException,
2081                            com.liferay.portal.kernel.exception.SystemException {
2082                    _groupLocalService.updateAsset(userId, group, assetCategoryIds,
2083                            assetTagNames);
2084            }
2085    
2086            /**
2087            * Updates the group's friendly URL.
2088            *
2089            * @param groupId the primary key of the group
2090            * @param friendlyURL the group's new friendlyURL (optionally
2091            <code>null</code>)
2092            * @return the group
2093            * @throws PortalException if a group with the primary key could not be
2094            found or if a valid friendly URL could not be created for the
2095            group
2096            * @throws SystemException if a system exception occurred
2097            */
2098            public com.liferay.portal.model.Group updateFriendlyURL(long groupId,
2099                    java.lang.String friendlyURL)
2100                    throws com.liferay.portal.kernel.exception.PortalException,
2101                            com.liferay.portal.kernel.exception.SystemException {
2102                    return _groupLocalService.updateFriendlyURL(groupId, friendlyURL);
2103            }
2104    
2105            /**
2106            * Updates the group.
2107            *
2108            * @param groupId the primary key of the group
2109            * @param parentGroupId the primary key of the parent group
2110            * @param name the group's new name
2111            * @param description the group's new description (optionally
2112            <code>null</code>)
2113            * @param type the group's new type. For more information see {@link
2114            com.liferay.portal.model.GroupConstants}
2115            * @param friendlyURL the group's new friendlyURL (optionally
2116            <code>null</code>)
2117            * @param active whether the group is active
2118            * @param serviceContext the service context to be applied (optionally
2119            <code>null</code>). Can set asset category IDs and asset tag
2120            names for the group.
2121            * @return the group
2122            * @throws PortalException if a group with the primary key could not be
2123            found or if the friendly URL was invalid or could one not be
2124            created
2125            * @throws SystemException if a system exception occurred
2126            */
2127            public com.liferay.portal.model.Group updateGroup(long groupId,
2128                    long parentGroupId, java.lang.String name,
2129                    java.lang.String description, int type, java.lang.String friendlyURL,
2130                    boolean active, com.liferay.portal.service.ServiceContext serviceContext)
2131                    throws com.liferay.portal.kernel.exception.PortalException,
2132                            com.liferay.portal.kernel.exception.SystemException {
2133                    return _groupLocalService.updateGroup(groupId, parentGroupId, name,
2134                            description, type, friendlyURL, active, serviceContext);
2135            }
2136    
2137            /**
2138            * Updates the group's type settings.
2139            *
2140            * @param groupId the primary key of the group
2141            * @param typeSettings the group's new type settings (optionally
2142            <code>null</code>)
2143            * @return the group
2144            * @throws PortalException if a group with the primary key could not be
2145            found
2146            * @throws SystemException if a system exception occurred
2147            */
2148            public com.liferay.portal.model.Group updateGroup(long groupId,
2149                    java.lang.String typeSettings)
2150                    throws com.liferay.portal.kernel.exception.PortalException,
2151                            com.liferay.portal.kernel.exception.SystemException {
2152                    return _groupLocalService.updateGroup(groupId, typeSettings);
2153            }
2154    
2155            /**
2156            * Associates the group with a main site if the group is an organization.
2157            *
2158            * @param groupId the primary key of the group
2159            * @param site whether the group is to be associated with a main site
2160            * @return the group
2161            * @throws PortalException if a group with the primary key could not be
2162            found
2163            * @throws SystemException if a system exception occurred
2164            */
2165            public com.liferay.portal.model.Group updateSite(long groupId, boolean site)
2166                    throws com.liferay.portal.kernel.exception.PortalException,
2167                            com.liferay.portal.kernel.exception.SystemException {
2168                    return _groupLocalService.updateSite(groupId, site);
2169            }
2170    
2171            /**
2172             * @deprecated Renamed to {@link #getWrappedService}
2173             */
2174            public GroupLocalService getWrappedGroupLocalService() {
2175                    return _groupLocalService;
2176            }
2177    
2178            /**
2179             * @deprecated Renamed to {@link #setWrappedService}
2180             */
2181            public void setWrappedGroupLocalService(GroupLocalService groupLocalService) {
2182                    _groupLocalService = groupLocalService;
2183            }
2184    
2185            public GroupLocalService getWrappedService() {
2186                    return _groupLocalService;
2187            }
2188    
2189            public void setWrappedService(GroupLocalService groupLocalService) {
2190                    _groupLocalService = groupLocalService;
2191            }
2192    
2193            private GroupLocalService _groupLocalService;
2194    }