GroupLocalServiceWrapper

java.lang.Object
- com.liferay.portal.service.GroupLocalServiceWrapper

All Implemented Interfaces:

BaseLocalService, GroupLocalService, PersistedModelLocalService, ServiceWrapper<GroupLocalService>
```
@ProviderType
public class GroupLocalServiceWrapper
extends java.lang.Object
implements GroupLocalService, ServiceWrapper<GroupLocalService>
```
Provides a wrapper for GroupLocalService.

Author:

Brian Wing Shun Chan

See Also:
GroupLocalService
Generated:

Constructor Summary

Constructors
Constructor and Description

GroupLocalServiceWrapper(GroupLocalService groupLocalService)

Constructors
Constructor and Description
`GroupLocalServiceWrapper(GroupLocalService groupLocalService)`

Method Summary

Methods
Modifier and Type	Method and Description
`Group`	`addGroup(Group group)` Adds the group to the database.
`Group`	`addGroup(long userId, long parentGroupId, java.lang.String className, long classPK, long liveGroupId, java.lang.String name, java.lang.String description, int type, boolean manualMembership, int membershipRestriction, java.lang.String friendlyURL, boolean site, boolean active, ServiceContext serviceContext)` Adds a group.
`Group`	`addGroup(long userId, long parentGroupId, java.lang.String className, long classPK, java.lang.String name, java.lang.String description, int type, java.lang.String friendlyURL, boolean site, boolean active, ServiceContext serviceContext)` Deprecated. As of 6.2.0, replaced by `addGroup(long, long, String, long, long, String, String, int, boolean, int, String, boolean, boolean, ServiceContext)`
`Group`	`addGroup(long userId, java.lang.String className, long classPK, long liveGroupId, java.lang.String name, java.lang.String description, int type, java.lang.String friendlyURL, boolean site, boolean active, ServiceContext serviceContext)` Deprecated. As of 6.2.0, replaced by `addGroup(long, long, String, long, long, String, String, int, boolean, int, String, boolean, boolean, ServiceContext)`
`Group`	`addGroup(long userId, java.lang.String className, long classPK, java.lang.String name, java.lang.String description, int type, java.lang.String friendlyURL, boolean site, boolean active, ServiceContext serviceContext)` Deprecated. As of 6.2.0, replaced by `addGroup(long, long, String, long, long, String, String, int, boolean, int, String, boolean, boolean, ServiceContext)`
`void`	`addOrganizationGroup(long organizationId, Group group)`
`void`	`addOrganizationGroup(long organizationId, long groupId)`
`void`	`addOrganizationGroups(long organizationId, java.util.List<Group> Groups)`
`void`	`addOrganizationGroups(long organizationId, long[] groupIds)`
`void`	`addRoleGroup(long roleId, Group group)`
`void`	`addRoleGroup(long roleId, long groupId)`
`void`	`addRoleGroups(long roleId, java.util.List<Group> Groups)`
`void`	`addRoleGroups(long roleId, long[] groupIds)`
`void`	`addUserGroup(long userId, Group group)`
`void`	`addUserGroup(long userId, long groupId)`
`void`	`addUserGroupGroup(long userGroupId, Group group)`
`void`	`addUserGroupGroup(long userGroupId, long groupId)`
`void`	`addUserGroupGroups(long userGroupId, java.util.List<Group> Groups)`
`void`	`addUserGroupGroups(long userGroupId, long[] groupIds)`
`void`	`addUserGroups(long userId, java.util.List<Group> Groups)`
`void`	`addUserGroups(long userId, long[] groupIds)`
`void`	`checkCompanyGroup(long companyId)` Adds a company group if it does not exist.
`void`	`checkSystemGroups(long companyId)` Creates systems groups and other related data needed by the system on the very first startup.
`void`	`clearOrganizationGroups(long organizationId)`
`void`	`clearRoleGroups(long roleId)`
`void`	`clearUserGroupGroups(long userGroupId)`
`void`	`clearUserGroups(long userId)`
`Group`	`createGroup(long groupId)` Creates a new group with the primary key.
`Group`	`deleteGroup(Group group)` Deletes the group from the database.
`Group`	`deleteGroup(long groupId)` Deletes the group with the primary key from the database.
`void`	`deleteOrganizationGroup(long organizationId, Group group)`
`void`	`deleteOrganizationGroup(long organizationId, long groupId)`
`void`	`deleteOrganizationGroups(long organizationId, java.util.List<Group> Groups)`
`void`	`deleteOrganizationGroups(long organizationId, long[] groupIds)`
`void`	`deleteRoleGroup(long roleId, Group group)`
`void`	`deleteRoleGroup(long roleId, long groupId)`
`void`	`deleteRoleGroups(long roleId, java.util.List<Group> Groups)`
`void`	`deleteRoleGroups(long roleId, long[] groupIds)`
`void`	`deleteUserGroup(long userId, Group group)`
`void`	`deleteUserGroup(long userId, long groupId)`
`void`	`deleteUserGroupGroup(long userGroupId, Group group)`
`void`	`deleteUserGroupGroup(long userGroupId, long groupId)`
`void`	`deleteUserGroupGroups(long userGroupId, java.util.List<Group> Groups)`
`void`	`deleteUserGroupGroups(long userGroupId, long[] groupIds)`
`void`	`deleteUserGroups(long userId, java.util.List<Group> Groups)`
`void`	`deleteUserGroups(long userId, long[] groupIds)`
`void`	`disableStaging(long groupId)`
`DynamicQuery`	`dynamicQuery()`
`java.util.List`	`dynamicQuery(DynamicQuery dynamicQuery)` Performs a dynamic query on the database and returns the matching rows.
`java.util.List`	`dynamicQuery(DynamicQuery dynamicQuery, int start, int end)` Performs a dynamic query on the database and returns a range of the matching rows.
`java.util.List`	`dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)` Performs a dynamic query on the database and returns an ordered range of the matching rows.
`long`	`dynamicQueryCount(DynamicQuery dynamicQuery)` Returns the number of rows that match the dynamic query.
`long`	`dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)` Returns the number of rows that match the dynamic query.
`void`	`enableStaging(long groupId)`
`Group`	`fetchFriendlyURLGroup(long companyId, java.lang.String friendlyURL)` Returns the group with the matching friendly URL.
`Group`	`fetchGroup(long groupId)`
`Group`	`fetchGroup(long companyId, java.lang.String name)` Returns the group with the matching group name by first searching the system groups and then using the finder cache.
`Group`	`fetchGroupByUuidAndCompanyId(java.lang.String uuid, long companyId)` Returns the group with the matching UUID and company.
`java.lang.String`	`getBeanIdentifier()` Returns the Spring bean ID for this bean.
`Group`	`getCompanyGroup(long companyId)` Returns the company group.
`java.util.List<Group>`	`getCompanyGroups(long companyId, int start, int end)` Returns a range of all the groups associated with the company.
`int`	`getCompanyGroupsCount(long companyId)` Returns the number of groups associated with the company.
`Group`	`getFriendlyURLGroup(long companyId, java.lang.String friendlyURL)` Returns the group with the matching friendly URL.
`Group`	`getGroup(long groupId)` Returns the group with the primary key.
`Group`	`getGroup(long companyId, java.lang.String name)` Returns the group with the matching group name.
`Group`	`getGroupByUuidAndCompanyId(java.lang.String uuid, long companyId)` Returns the group with the matching UUID and company.
`java.lang.String`	`getGroupDescriptiveName(Group group, java.util.Locale locale)`
`java.lang.String`	`getGroupDescriptiveName(long groupId, java.util.Locale locale)`
`java.util.List<Group>`	`getGroups(int start, int end)` Returns a range of all the groups.
`java.util.List<Group>`	`getGroups(long[] groupIds)` Returns the groups with the matching primary keys.
`java.util.List<Group>`	`getGroups(long companyId, long parentGroupId, boolean site)` Returns all the groups that are direct children of the parent group.
`java.util.List<Group>`	`getGroups(long companyId, java.lang.String className, long parentGroupId)` Returns all the groups that are direct children of the parent group with the matching className.
`java.util.List<Group>`	`getGroups(long companyId, java.lang.String className, long parentGroupId, int start, int end)` Returns a range of all the groups that are direct children of the parent group with the matching className.
`int`	`getGroupsCount()` Returns the number of groups.
`int`	`getGroupsCount(long companyId, long parentGroupId, boolean site)` Returns the number of groups that are direct children of the parent group.
`int`	`getGroupsCount(long companyId, java.lang.String className, long parentGroupId)` Returns the number of groups that are direct children of the parent group with the matching className.
`Group`	`getLayoutGroup(long companyId, long plid)` Returns the group associated with the layout.
`Group`	`getLayoutPrototypeGroup(long companyId, long layoutPrototypeId)` Returns the group associated with the layout prototype.
`Group`	`getLayoutSetPrototypeGroup(long companyId, long layoutSetPrototypeId)` Returns the group associated with the layout set prototype.
`java.util.List<Group>`	`getLayoutsGroups(long companyId, long parentGroupId, boolean site, int start, int end)` Returns a range of all groups that are children of the parent group and that have at least one layout.
`int`	`getLayoutsGroupsCount(long companyId, long parentGroupId, boolean site)` Returns the number of groups that are children or the parent group and that have at least one layout
`java.util.List<Group>`	`getLiveGroups()` Returns all live groups.
`java.util.List<Group>`	`getNoLayoutsGroups(java.lang.String className, boolean privateLayout, int start, int end)` Returns a range of all non-system groups of a specified type (className) that have no layouts.
`java.util.List<Group>`	`getNullFriendlyURLGroups()` Returns all non-system groups having `null` or empty friendly URLs.
`Group`	`getOrganizationGroup(long companyId, long organizationId)` Returns the specified organization group.
`java.util.List<Group>`	`getOrganizationGroups(long organizationId)`
`java.util.List<Group>`	`getOrganizationGroups(long organizationId, int start, int end)`
`java.util.List<Group>`	`getOrganizationGroups(long organizationId, int start, int end, OrderByComparator orderByComparator)`
`int`	`getOrganizationGroupsCount(long organizationId)`
`java.util.List<Group>`	`getOrganizationsGroups(java.util.List<Organization> organizations)` Returns the specified organization groups.
`java.util.List<Group>`	`getOrganizationsRelatedGroups(java.util.List<Organization> organizations)` Returns all the groups related to the organizations.
`java.util.List<Group>`	`getParentGroups(long groupId)` Returns the group followed by all its parent groups ordered by closest ancestor.
`PersistedModel`	`getPersistedModel(java.io.Serializable primaryKeyObj)`
`java.util.List<Group>`	`getRoleGroups(long roleId)`
`java.util.List<Group>`	`getRoleGroups(long roleId, int start, int end)`
`java.util.List<Group>`	`getRoleGroups(long roleId, int start, int end, OrderByComparator orderByComparator)`
`int`	`getRoleGroupsCount(long roleId)`
`Group`	`getStagingGroup(long liveGroupId)` Returns the staging group.
`Group`	`getUserGroup(long companyId, long userId)` Returns the group associated with the user.
`Group`	`getUserGroupGroup(long companyId, long userGroupId)` Returns the specified "user group" group.
`java.util.List<Group>`	`getUserGroupGroups(long userGroupId)`
`java.util.List<Group>`	`getUserGroupGroups(long userGroupId, int start, int end)`
`java.util.List<Group>`	`getUserGroupGroups(long userGroupId, int start, int end, OrderByComparator orderByComparator)`
`int`	`getUserGroupGroupsCount(long userGroupId)`
`java.util.List<Group>`	`getUserGroups(long userId)`
`java.util.List<Group>`	`getUserGroups(long userId, boolean inherit)` Returns all the user's site groups and immediate organization groups, optionally including the user's inherited organization groups and user groups.
`java.util.List<Group>`	`getUserGroups(long userId, boolean inherit, int start, int end)` Returns an ordered range of all the user's site groups and immediate organization groups, optionally including the user's inherited organization groups and user groups.
`java.util.List<Group>`	`getUserGroups(long userId, int start, int end)`
`java.util.List<Group>`	`getUserGroups(long userId, int start, int end, OrderByComparator orderByComparator)`
`int`	`getUserGroupsCount(long userId)`
`java.util.List<Group>`	`getUserGroupsGroups(java.util.List<UserGroup> userGroups)` Returns the groups associated with the user groups.
`java.util.List<Group>`	`getUserGroupsRelatedGroups(java.util.List<UserGroup> userGroups)` Returns all the groups related to the user groups.
`java.util.List<Group>`	`getUserOrganizationsGroups(long userId, int start, int end)` Returns the range of all groups associated with the user's organization groups, including the ancestors of the organization groups, unless portal property `organizations.membership.strict` is set to `true`.
`Group`	`getUserPersonalSiteGroup(long companyId)`
`java.util.List<Group>`	`getUserSitesGroups(long userId)`
`java.util.List<Group>`	`getUserSitesGroups(long userId, boolean includeAdministrative)`
`GroupLocalService`	`getWrappedGroupLocalService()` Deprecated. As of 6.1.0, replaced by `getWrappedService()`
`GroupLocalService`	`getWrappedService()`
`boolean`	`hasOrganizationGroup(long organizationId, long groupId)`
`boolean`	`hasOrganizationGroups(long organizationId)`
`boolean`	`hasRoleGroup(long roleId, long groupId)`
`boolean`	`hasRoleGroups(long roleId)`
`boolean`	`hasStagingGroup(long liveGroupId)` Returns `true` if the live group has a staging group.
`boolean`	`hasUserGroup(long userId, long groupId)`
`boolean`	`hasUserGroup(long userId, long groupId, boolean inherit)` Returns `true` if the user is immediately associated with the group, or optionally if the user is associated with the group via the user's organizations, inherited organizations, or user groups.
`boolean`	`hasUserGroupGroup(long userGroupId, long groupId)`
`boolean`	`hasUserGroupGroups(long userGroupId)`
`boolean`	`hasUserGroups(long userId)`
`Group`	`loadFetchGroup(long companyId, java.lang.String name)` Returns the group with the matching group name by first searching the system groups and then using the finder cache.
`Group`	`loadGetGroup(long companyId, java.lang.String name)` Returns the group with the matching group name.
`void`	`rebuildTree(long companyId)` Rebuilds the group tree.
`java.util.List<Group>`	`search(long companyId, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end)` Returns an ordered range of all the company's groups, optionally including the user's inherited organization groups and user groups.
`java.util.List<Group>`	`search(long companyId, long[] classNameIds, long parentGroupId, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end)` Returns an ordered range of all the groups belonging to the parent group that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups.
`java.util.List<Group>`	`search(long companyId, long[] classNameIds, long parentGroupId, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, OrderByComparator obc)` Returns an ordered range of all the groups belonging to the parent group that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups.
`java.util.List<Group>`	`search(long companyId, long[] classNameIds, long parentGroupId, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator, int start, int end)` Returns an ordered range of all the groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.
`java.util.List<Group>`	`search(long companyId, long[] classNameIds, long parentGroupId, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator, int start, int end, OrderByComparator obc)` Returns an ordered range of all the groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.
`java.util.List<Group>`	`search(long companyId, long[] classNameIds, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end)` Returns an ordered range of all the groups that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups.
`java.util.List<Group>`	`search(long companyId, long[] classNameIds, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, OrderByComparator obc)` Returns an ordered range of all the groups that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups.
`java.util.List<Group>`	`search(long companyId, long[] classNameIds, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator, int start, int end)` Returns an ordered range of all the groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.
`java.util.List<Group>`	`search(long companyId, long[] classNameIds, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator, int start, int end, OrderByComparator obc)` Returns an ordered range of all the groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.
`java.util.List<Group>`	`search(long companyId, long parentGroupId, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end)` Returns an ordered range of all the groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups.
`java.util.List<Group>`	`search(long companyId, long parentGroupId, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, OrderByComparator obc)` Returns an ordered range of all the groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups.
`java.util.List<Group>`	`search(long companyId, long parentGroupId, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator, int start, int end)` Returns an ordered range of all the site groups belonging to the parent group and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.
`java.util.List<Group>`	`search(long companyId, long parentGroupId, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator, int start, int end, OrderByComparator obc)` Returns an ordered range of all the site groups belonging to the parent group and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.
`java.util.List<Group>`	`search(long companyId, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end)` Returns an ordered range of all the groups that match the keywords, optionally including the user's inherited organization groups and user groups.
`java.util.List<Group>`	`search(long companyId, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, OrderByComparator obc)` Returns an ordered range of all the groups that match the keywords, optionally including the user's inherited organization groups and user groups.
`java.util.List<Group>`	`search(long companyId, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator, int start, int end)` Returns an ordered range of all the site groups and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.
`java.util.List<Group>`	`search(long companyId, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator, int start, int end, OrderByComparator obc)` Returns an ordered range of all the site groups and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.
`int`	`searchCount(long companyId, long[] classNameIds, long parentGroupId, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)` Returns the number of groups belonging to the parent group that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups.
`int`	`searchCount(long companyId, long[] classNameIds, long parentGroupId, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator)` Returns the number of groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.
`int`	`searchCount(long companyId, long[] classNameIds, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)` Returns the number of groups that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups.
`int`	`searchCount(long companyId, long[] classNameIds, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator)` Returns the number of groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.
`int`	`searchCount(long companyId, long parentGroupId, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)` Returns the number of groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups.
`int`	`searchCount(long companyId, long parentGroupId, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator)` Returns the number of groups belonging to the parent group and immediate organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.
`int`	`searchCount(long companyId, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)` Returns the number of groups that match the keywords, optionally including the user's inherited organization groups and user groups.
`int`	`searchCount(long companyId, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator)` Returns the number of groups and immediate organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.
`void`	`setBeanIdentifier(java.lang.String beanIdentifier)` Sets the Spring bean ID for this bean.
`void`	`setOrganizationGroups(long organizationId, long[] groupIds)`
`void`	`setRoleGroups(long roleId, long[] groupIds)`
`void`	`setUserGroupGroups(long userGroupId, long[] groupIds)`
`void`	`setUserGroups(long userId, long[] groupIds)`
`void`	`setWrappedGroupLocalService(GroupLocalService groupLocalService)` Deprecated. As of 6.1.0, replaced by `setWrappedService(com.liferay.portal.service.GroupLocalService)`
`void`	`setWrappedService(GroupLocalService groupLocalService)`
`void`	`unsetRoleGroups(long roleId, long[] groupIds)` Removes the groups from the role.
`void`	`unsetUserGroups(long userId, long[] groupIds)` Removes the user from the groups.
`void`	`updateAsset(long userId, Group group, long[] assetCategoryIds, java.lang.String[] assetTagNames)` Updates the group's asset replacing categories and tag names.
`Group`	`updateFriendlyURL(long groupId, java.lang.String friendlyURL)` Updates the group's friendly URL.
`Group`	`updateGroup(Group group)` Updates the group in the database or adds it if it does not yet exist.
`Group`	`updateGroup(long groupId, long parentGroupId, java.lang.String name, java.lang.String description, int type, boolean manualMembership, int membershipRestriction, java.lang.String friendlyURL, boolean active, ServiceContext serviceContext)` Updates the group.
`Group`	`updateGroup(long groupId, java.lang.String typeSettings)` Updates the group's type settings.
`Group`	`updateSite(long groupId, boolean site)` Associates the group with a main site if the group is an organization.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GroupLocalServiceWrapper
```
public GroupLocalServiceWrapper(GroupLocalService groupLocalService)
```
- Method Detail
  - addGroup
```
public Group addGroup(Group group)
               throws SystemException
```
    Adds the group to the database. Also notifies the appropriate model listeners.
    
    Specified by:
    
    addGroup in interface GroupLocalService
    
    Parameters:
    group - the group
    
    Returns:
    the group that was added
    
    Throws:
    
    SystemException - if a system exception occurred
  - createGroup
```
public Group createGroup(long groupId)
```
    Creates a new group with the primary key. Does not add the group to the database.
    
    Specified by:
    
    createGroup in interface GroupLocalService
    
    Parameters:
    groupId - the primary key for the new group
    
    Returns:
    the new group
  - deleteGroup
```
public Group deleteGroup(long groupId)
                  throws PortalException,
                         SystemException
```
    Deletes the group with the primary key from the database. Also notifies the appropriate model listeners.
    
    Specified by:
    
    deleteGroup in interface GroupLocalService
    
    Parameters:
    groupId - the primary key of the group
    
    Returns:
    the group that was removed
    
    Throws:
    
    PortalException - if a group with the primary key could not be found
    
    SystemException - if a system exception occurred
  - deleteGroup
```
public Group deleteGroup(Group group)
                  throws PortalException,
                         SystemException
```
    Deletes the group from the database. Also notifies the appropriate model listeners.
    
    Specified by:
    
    deleteGroup in interface GroupLocalService
    
    Parameters:
    group - the group
    
    Returns:
    the group that was removed
    
    Throws:
    
    PortalException
    
    SystemException - if a system exception occurred
  - dynamicQuery
```
public DynamicQuery dynamicQuery()
```
    Specified by:
    
    dynamicQuery in interface GroupLocalService
  - dynamicQuery
```
public java.util.List dynamicQuery(DynamicQuery dynamicQuery)
                            throws SystemException
```
    Performs a dynamic query on the database and returns the matching rows.
    
    Specified by:
    
    dynamicQuery in interface GroupLocalService
    
    Parameters:
    dynamicQuery - the dynamic query
    
    Returns:
    the matching rows
    
    Throws:
    
    SystemException - if a system exception occurred
  - dynamicQuery
```
public java.util.List dynamicQuery(DynamicQuery dynamicQuery,
                          int start,
                          int end)
                            throws SystemException
```
    Performs a dynamic query on the database and returns a range of the matching rows.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from GroupModelImpl. If both orderByComparator 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.
    
    Specified by:
    
    dynamicQuery in interface GroupLocalService
    
    Parameters:
    dynamicQuery - the dynamic query
    start - the lower bound of the range of model instances
    end - the upper bound of the range of model instances (not inclusive)
    
    Returns:
    the range of matching rows
    
    Throws:
    
    SystemException - if a system exception occurred
  - dynamicQuery
```
public java.util.List dynamicQuery(DynamicQuery dynamicQuery,
                          int start,
                          int end,
                          OrderByComparator orderByComparator)
                            throws SystemException
```
    Performs a dynamic query on the database and returns an ordered range of the matching rows.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from GroupModelImpl. If both orderByComparator 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.
    
    Specified by:
    
    dynamicQuery in interface GroupLocalService
    
    Parameters:
    dynamicQuery - the dynamic query
    start - the lower bound of the range of model instances
    end - the upper bound of the range of model instances (not inclusive)
    orderByComparator - the comparator to order the results by (optionally null)
    
    Returns:
    the ordered range of matching rows
    
    Throws:
    
    SystemException - if a system exception occurred
  - dynamicQueryCount
```
public long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
```
    Returns the number of rows that match the dynamic query.
    
    Specified by:
    
    dynamicQueryCount in interface GroupLocalService
    
    Parameters:
    dynamicQuery - the dynamic query
    
    Returns:
    the number of rows that match the dynamic query
    
    Throws:
    
    SystemException - if a system exception occurred
  - dynamicQueryCount
```
public long dynamicQueryCount(DynamicQuery dynamicQuery,
                     Projection projection)
                       throws SystemException
```
    Returns the number of rows that match the dynamic query.
    
    Specified by:
    
    dynamicQueryCount in interface GroupLocalService
    
    Parameters:
    dynamicQuery - the dynamic query
    projection - the projection to apply to the query
    
    Returns:
    the number of rows that match the dynamic query
    
    Throws:
    
    SystemException - if a system exception occurred
  - fetchGroup
```
public Group fetchGroup(long groupId)
                 throws SystemException
```
    Specified by:
    
    fetchGroup in interface GroupLocalService
    
    Throws:
    
    SystemException
  - fetchGroupByUuidAndCompanyId
```
public Group fetchGroupByUuidAndCompanyId(java.lang.String uuid,
                                 long companyId)
                                   throws SystemException
```
    Returns the group with the matching UUID and company.
    
    Specified by:
    
    fetchGroupByUuidAndCompanyId in interface GroupLocalService
    
    Parameters:
    uuid - the group's UUID
    companyId - the primary key of the company
    
    Returns:
    the matching group, or null if a matching group could not be found
    
    Throws:
    
    SystemException - if a system exception occurred
  - getGroup
```
public Group getGroup(long groupId)
               throws PortalException,
                      SystemException
```
    Returns the group with the primary key.
    
    Specified by:
    
    getGroup in interface GroupLocalService
    
    Parameters:
    groupId - the primary key of the group
    
    Returns:
    the group
    
    Throws:
    
    PortalException - if a group with the primary key could not be found
    
    SystemException - if a system exception occurred
  - getPersistedModel
```
public PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
```
    Specified by:
    
    getPersistedModel in interface GroupLocalService
    
    Specified by:
    
    getPersistedModel in interface PersistedModelLocalService
    
    Throws:
    
    PortalException
    
    SystemException
  - getGroupByUuidAndCompanyId
```
public Group getGroupByUuidAndCompanyId(java.lang.String uuid,
                               long companyId)
                                 throws PortalException,
                                        SystemException
```
    Returns the group with the matching UUID and company.
    
    Specified by:
    
    getGroupByUuidAndCompanyId in interface GroupLocalService
    
    Parameters:
    uuid - the group's UUID
    companyId - the primary key of the company
    
    Returns:
    the matching group
    
    Throws:
    
    PortalException - if a matching group could not be found
    
    SystemException - if a system exception occurred
  - getGroups
```
public java.util.List<Group> getGroups(int start,
                              int end)
                                throws SystemException
```
    Returns a range of all the groups.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from GroupModelImpl. If both orderByComparator 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.
    
    Specified by:
    
    getGroups in interface GroupLocalService
    
    Parameters:
    start - the lower bound of the range of groups
    end - the upper bound of the range of groups (not inclusive)
    
    Returns:
    the range of groups
    
    Throws:
    
    SystemException - if a system exception occurred
  - getGroupsCount
```
public int getGroupsCount()
                   throws SystemException
```
    Returns the number of groups.
    
    Specified by:
    
    getGroupsCount in interface GroupLocalService
    
    Returns:
    the number of groups
    
    Throws:
    
    SystemException - if a system exception occurred
  - updateGroup
```
public Group updateGroup(Group group)
                  throws SystemException
```
    Updates the group in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
    
    Specified by:
    
    updateGroup in interface GroupLocalService
    
    Parameters:
    group - the group
    
    Returns:
    the group that was updated
    
    Throws:
    
    SystemException - if a system exception occurred
  - addOrganizationGroup
```
public void addOrganizationGroup(long organizationId,
                        long groupId)
                          throws SystemException
```
    Specified by:
    
    addOrganizationGroup in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - addOrganizationGroup
```
public void addOrganizationGroup(long organizationId,
                        Group group)
                          throws SystemException
```
    Specified by:
    
    addOrganizationGroup in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - addOrganizationGroups
```
public void addOrganizationGroups(long organizationId,
                         long[] groupIds)
                           throws SystemException
```
    Specified by:
    
    addOrganizationGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - addOrganizationGroups
```
public void addOrganizationGroups(long organizationId,
                         java.util.List<Group> Groups)
                           throws SystemException
```
    Specified by:
    
    addOrganizationGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - clearOrganizationGroups
```
public void clearOrganizationGroups(long organizationId)
                             throws SystemException
```
    Specified by:
    
    clearOrganizationGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - deleteOrganizationGroup
```
public void deleteOrganizationGroup(long organizationId,
                           long groupId)
                             throws SystemException
```
    Specified by:
    
    deleteOrganizationGroup in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - deleteOrganizationGroup
```
public void deleteOrganizationGroup(long organizationId,
                           Group group)
                             throws SystemException
```
    Specified by:
    
    deleteOrganizationGroup in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - deleteOrganizationGroups
```
public void deleteOrganizationGroups(long organizationId,
                            long[] groupIds)
                              throws SystemException
```
    Specified by:
    
    deleteOrganizationGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - deleteOrganizationGroups
```
public void deleteOrganizationGroups(long organizationId,
                            java.util.List<Group> Groups)
                              throws SystemException
```
    Specified by:
    
    deleteOrganizationGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - getOrganizationGroups
```
public java.util.List<Group> getOrganizationGroups(long organizationId)
                                            throws SystemException
```
    Specified by:
    
    getOrganizationGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - getOrganizationGroups
```
public java.util.List<Group> getOrganizationGroups(long organizationId,
                                          int start,
                                          int end)
                                            throws SystemException
```
    Specified by:
    
    getOrganizationGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - getOrganizationGroups
```
public java.util.List<Group> getOrganizationGroups(long organizationId,
                                          int start,
                                          int end,
                                          OrderByComparator orderByComparator)
                                            throws SystemException
```
    Specified by:
    
    getOrganizationGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - getOrganizationGroupsCount
```
public int getOrganizationGroupsCount(long organizationId)
                               throws SystemException
```
    Specified by:
    
    getOrganizationGroupsCount in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - hasOrganizationGroup
```
public boolean hasOrganizationGroup(long organizationId,
                           long groupId)
                             throws SystemException
```
    Specified by:
    
    hasOrganizationGroup in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - hasOrganizationGroups
```
public boolean hasOrganizationGroups(long organizationId)
                              throws SystemException
```
    Specified by:
    
    hasOrganizationGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - setOrganizationGroups
```
public void setOrganizationGroups(long organizationId,
                         long[] groupIds)
                           throws SystemException
```
    Specified by:
    
    setOrganizationGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - addRoleGroup
```
public void addRoleGroup(long roleId,
                long groupId)
                  throws SystemException
```
    Specified by:
    
    addRoleGroup in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - addRoleGroup
```
public void addRoleGroup(long roleId,
                Group group)
                  throws SystemException
```
    Specified by:
    
    addRoleGroup in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - addRoleGroups
```
public void addRoleGroups(long roleId,
                 long[] groupIds)
                   throws SystemException
```
    Specified by:
    
    addRoleGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - addRoleGroups
```
public void addRoleGroups(long roleId,
                 java.util.List<Group> Groups)
                   throws SystemException
```
    Specified by:
    
    addRoleGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - clearRoleGroups
```
public void clearRoleGroups(long roleId)
                     throws SystemException
```
    Specified by:
    
    clearRoleGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - deleteRoleGroup
```
public void deleteRoleGroup(long roleId,
                   long groupId)
                     throws SystemException
```
    Specified by:
    
    deleteRoleGroup in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - deleteRoleGroup
```
public void deleteRoleGroup(long roleId,
                   Group group)
                     throws SystemException
```
    Specified by:
    
    deleteRoleGroup in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - deleteRoleGroups
```
public void deleteRoleGroups(long roleId,
                    long[] groupIds)
                      throws SystemException
```
    Specified by:
    
    deleteRoleGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - deleteRoleGroups
```
public void deleteRoleGroups(long roleId,
                    java.util.List<Group> Groups)
                      throws SystemException
```
    Specified by:
    
    deleteRoleGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - getRoleGroups
```
public java.util.List<Group> getRoleGroups(long roleId)
                                    throws SystemException
```
    Specified by:
    
    getRoleGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - getRoleGroups
```
public java.util.List<Group> getRoleGroups(long roleId,
                                  int start,
                                  int end)
                                    throws SystemException
```
    Specified by:
    
    getRoleGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - getRoleGroups
```
public java.util.List<Group> getRoleGroups(long roleId,
                                  int start,
                                  int end,
                                  OrderByComparator orderByComparator)
                                    throws SystemException
```
    Specified by:
    
    getRoleGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - getRoleGroupsCount
```
public int getRoleGroupsCount(long roleId)
                       throws SystemException
```
    Specified by:
    
    getRoleGroupsCount in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - hasRoleGroup
```
public boolean hasRoleGroup(long roleId,
                   long groupId)
                     throws SystemException
```
    Specified by:
    
    hasRoleGroup in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - hasRoleGroups
```
public boolean hasRoleGroups(long roleId)
                      throws SystemException
```
    Specified by:
    
    hasRoleGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - setRoleGroups
```
public void setRoleGroups(long roleId,
                 long[] groupIds)
                   throws SystemException
```
    Specified by:
    
    setRoleGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - addUserGroupGroup
```
public void addUserGroupGroup(long userGroupId,
                     long groupId)
                       throws SystemException
```
    Specified by:
    
    addUserGroupGroup in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - addUserGroupGroup
```
public void addUserGroupGroup(long userGroupId,
                     Group group)
                       throws SystemException
```
    Specified by:
    
    addUserGroupGroup in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - addUserGroupGroups
```
public void addUserGroupGroups(long userGroupId,
                      long[] groupIds)
                        throws SystemException
```
    Specified by:
    
    addUserGroupGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - addUserGroupGroups
```
public void addUserGroupGroups(long userGroupId,
                      java.util.List<Group> Groups)
                        throws SystemException
```
    Specified by:
    
    addUserGroupGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - clearUserGroupGroups
```
public void clearUserGroupGroups(long userGroupId)
                          throws SystemException
```
    Specified by:
    
    clearUserGroupGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - deleteUserGroupGroup
```
public void deleteUserGroupGroup(long userGroupId,
                        long groupId)
                          throws SystemException
```
    Specified by:
    
    deleteUserGroupGroup in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - deleteUserGroupGroup
```
public void deleteUserGroupGroup(long userGroupId,
                        Group group)
                          throws SystemException
```
    Specified by:
    
    deleteUserGroupGroup in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - deleteUserGroupGroups
```
public void deleteUserGroupGroups(long userGroupId,
                         long[] groupIds)
                           throws SystemException
```
    Specified by:
    
    deleteUserGroupGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - deleteUserGroupGroups
```
public void deleteUserGroupGroups(long userGroupId,
                         java.util.List<Group> Groups)
                           throws SystemException
```
    Specified by:
    
    deleteUserGroupGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - getUserGroupGroups
```
public java.util.List<Group> getUserGroupGroups(long userGroupId)
                                         throws SystemException
```
    Specified by:
    
    getUserGroupGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - getUserGroupGroups
```
public java.util.List<Group> getUserGroupGroups(long userGroupId,
                                       int start,
                                       int end)
                                         throws SystemException
```
    Specified by:
    
    getUserGroupGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - getUserGroupGroups
```
public java.util.List<Group> getUserGroupGroups(long userGroupId,
                                       int start,
                                       int end,
                                       OrderByComparator orderByComparator)
                                         throws SystemException
```
    Specified by:
    
    getUserGroupGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - getUserGroupGroupsCount
```
public int getUserGroupGroupsCount(long userGroupId)
                            throws SystemException
```
    Specified by:
    
    getUserGroupGroupsCount in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - hasUserGroupGroup
```
public boolean hasUserGroupGroup(long userGroupId,
                        long groupId)
                          throws SystemException
```
    Specified by:
    
    hasUserGroupGroup in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - hasUserGroupGroups
```
public boolean hasUserGroupGroups(long userGroupId)
                           throws SystemException
```
    Specified by:
    
    hasUserGroupGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - setUserGroupGroups
```
public void setUserGroupGroups(long userGroupId,
                      long[] groupIds)
                        throws SystemException
```
    Specified by:
    
    setUserGroupGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - addUserGroup
```
public void addUserGroup(long userId,
                long groupId)
                  throws SystemException
```
    Specified by:
    
    addUserGroup in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - addUserGroup
```
public void addUserGroup(long userId,
                Group group)
                  throws SystemException
```
    Specified by:
    
    addUserGroup in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - addUserGroups
```
public void addUserGroups(long userId,
                 long[] groupIds)
                   throws SystemException
```
    Specified by:
    
    addUserGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - addUserGroups
```
public void addUserGroups(long userId,
                 java.util.List<Group> Groups)
                   throws SystemException
```
    Specified by:
    
    addUserGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - clearUserGroups
```
public void clearUserGroups(long userId)
                     throws SystemException
```
    Specified by:
    
    clearUserGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - deleteUserGroup
```
public void deleteUserGroup(long userId,
                   long groupId)
                     throws SystemException
```
    Specified by:
    
    deleteUserGroup in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - deleteUserGroup
```
public void deleteUserGroup(long userId,
                   Group group)
                     throws SystemException
```
    Specified by:
    
    deleteUserGroup in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - deleteUserGroups
```
public void deleteUserGroups(long userId,
                    long[] groupIds)
                      throws SystemException
```
    Specified by:
    
    deleteUserGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - deleteUserGroups
```
public void deleteUserGroups(long userId,
                    java.util.List<Group> Groups)
                      throws SystemException
```
    Specified by:
    
    deleteUserGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - getUserGroups
```
public java.util.List<Group> getUserGroups(long userId)
                                    throws SystemException
```
    Specified by:
    
    getUserGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - getUserGroups
```
public java.util.List<Group> getUserGroups(long userId,
                                  int start,
                                  int end)
                                    throws SystemException
```
    Specified by:
    
    getUserGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - getUserGroups
```
public java.util.List<Group> getUserGroups(long userId,
                                  int start,
                                  int end,
                                  OrderByComparator orderByComparator)
                                    throws PortalException,
                                           SystemException
```
    Specified by:
    
    getUserGroups in interface GroupLocalService
    
    Throws:
    
    PortalException
    
    SystemException - if a system exception occurred
  - getUserGroupsCount
```
public int getUserGroupsCount(long userId)
                       throws SystemException
```
    Specified by:
    
    getUserGroupsCount in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - hasUserGroup
```
public boolean hasUserGroup(long userId,
                   long groupId)
                     throws SystemException
```
    Specified by:
    
    hasUserGroup in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - hasUserGroups
```
public boolean hasUserGroups(long userId)
                      throws SystemException
```
    Specified by:
    
    hasUserGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - setUserGroups
```
public void setUserGroups(long userId,
                 long[] groupIds)
                   throws SystemException
```
    Specified by:
    
    setUserGroups in interface GroupLocalService
    
    Throws:
    
    SystemException - if a system exception occurred
  - getBeanIdentifier
```
public java.lang.String getBeanIdentifier()
```
    Returns the Spring bean ID for this bean.
    
    Specified by:
    
    getBeanIdentifier in interface GroupLocalService
    
    Returns:
    the Spring bean ID for this bean
  - setBeanIdentifier
```
public void setBeanIdentifier(java.lang.String beanIdentifier)
```
    Sets the Spring bean ID for this bean.
    
    Specified by:
    
    setBeanIdentifier in interface GroupLocalService
    
    Parameters:
    beanIdentifier - the Spring bean ID for this bean
  - addGroup
```
public Group addGroup(long userId,
             long parentGroupId,
             java.lang.String className,
             long classPK,
             long liveGroupId,
             java.lang.String name,
             java.lang.String description,
             int type,
             boolean manualMembership,
             int membershipRestriction,
             java.lang.String friendlyURL,
             boolean site,
             boolean active,
             ServiceContext serviceContext)
               throws PortalException,
                      SystemException
```
    Adds a group.
    
    Specified by:
    
    addGroup in interface GroupLocalService
    
    Parameters:
    userId - the primary key of the group's creator/owner
    parentGroupId - the primary key of the parent group
    className - the entity's class name
    classPK - the primary key of the entity's instance
    liveGroupId - the primary key of the live group
    name - the entity's name
    description - the group's description (optionally null)
    type - the group's type. For more information see GroupConstants
    friendlyURL - the group's friendlyURL (optionally null)
    site - whether the group is to be associated with a main site
    active - whether the group is active
    serviceContext - the service context to be applied (optionally null). Can set asset category IDs and asset tag names for the group, and whether the group is for staging.
    
    Returns:
    the group
    
    Throws:
    
    PortalException - if a creator could not be found, if the group's information was invalid, if a layout could not be found, or if a valid friendly URL could not be created for the group
    
    SystemException - if a system exception occurred
  - addGroup
```
public Group addGroup(long userId,
             long parentGroupId,
             java.lang.String className,
             long classPK,
             java.lang.String name,
             java.lang.String description,
             int type,
             java.lang.String friendlyURL,
             boolean site,
             boolean active,
             ServiceContext serviceContext)
               throws PortalException,
                      SystemException
```
    Deprecated. As of 6.2.0, replaced by addGroup(long, long, String, long, long, String, String, int, boolean, int, String, boolean, boolean, ServiceContext)
    
    Adds the group using the default live group.
    
    Specified by:
    
    addGroup in interface GroupLocalService
    
    Parameters:
    userId - the primary key of the group's creator/owner
    parentGroupId - the primary key of the parent group
    className - the entity's class name
    classPK - the primary key of the entity's instance
    name - the entity's name
    description - the group's description (optionally null)
    type - the group's type. For more information see GroupConstants
    friendlyURL - the group's friendlyURL
    site - whether the group is to be associated with a main site
    active - whether the group is active
    serviceContext - the service context to be applied (optionally null). Can set asset category IDs and asset tag names for the group, and whether the group is for staging.
    
    Returns:
    the group
    
    Throws:
    
    PortalException - if a creator could not be found, if the group's information was invalid, if a layout could not be found, or if a valid friendly URL could not be created for the group
    
    SystemException - if a system exception occurred
  - addGroup
```
public Group addGroup(long userId,
             java.lang.String className,
             long classPK,
             long liveGroupId,
             java.lang.String name,
             java.lang.String description,
             int type,
             java.lang.String friendlyURL,
             boolean site,
             boolean active,
             ServiceContext serviceContext)
               throws PortalException,
                      SystemException
```
    Deprecated. As of 6.2.0, replaced by addGroup(long, long, String, long, long, String, String, int, boolean, int, String, boolean, boolean, ServiceContext)
    
    Adds a group.
    
    Specified by:
    
    addGroup in interface GroupLocalService
    
    Parameters:
    userId - the primary key of the group's creator/owner
    className - the entity's class name
    classPK - the primary key of the entity's instance
    liveGroupId - the primary key of the live group
    name - the entity's name
    description - the group's description (optionally null)
    type - the group's type. For more information see GroupConstants
    friendlyURL - the group's friendlyURL (optionally null)
    site - whether the group is to be associated with a main site
    active - whether the group is active
    serviceContext - the service context to be applied (optionally null). Can set asset category IDs and asset tag names for the group, and whether the group is for staging.
    
    Returns:
    the group
    
    Throws:
    
    PortalException - if a creator could not be found, if the group's information was invalid, if a layout could not be found, or if a valid friendly URL could not be created for the group
    
    SystemException - if a system exception occurred
  - addGroup
```
public Group addGroup(long userId,
             java.lang.String className,
             long classPK,
             java.lang.String name,
             java.lang.String description,
             int type,
             java.lang.String friendlyURL,
             boolean site,
             boolean active,
             ServiceContext serviceContext)
               throws PortalException,
                      SystemException
```
    Deprecated. As of 6.2.0, replaced by addGroup(long, long, String, long, long, String, String, int, boolean, int, String, boolean, boolean, ServiceContext)
    
    Adds the group using the default live group.
    
    Specified by:
    
    addGroup in interface GroupLocalService
    
    Parameters:
    userId - the primary key of the group's creator/owner
    className - the entity's class name
    classPK - the primary key of the entity's instance
    name - the entity's name
    description - the group's description (optionally null)
    type - the group's type. For more information see GroupConstants
    friendlyURL - the group's friendlyURL
    site - whether the group is to be associated with a main site
    active - whether the group is active
    serviceContext - the service context to be applied (optionally null). Can set asset category IDs and asset tag names for the group, and whether the group is for staging.
    
    Returns:
    the group
    
    Throws:
    
    PortalException - if a creator could not be found, if the group's information was invalid, if a layout could not be found, or if a valid friendly URL could not be created for the group
    
    SystemException - if a system exception occurred
  - checkCompanyGroup
```
public void checkCompanyGroup(long companyId)
                       throws PortalException,
                              SystemException
```
    Adds a company group if it does not exist. This method is typically used when a virtual host is added.
    
    Specified by:
    
    checkCompanyGroup in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    
    Throws:
    
    PortalException - if a default user for the company could not be found, if the group's information was invalid, if a layout could not be found, or if a valid friendly URL could not be created for the group
    
    SystemException - if a system exception occurred
  - checkSystemGroups
```
public void checkSystemGroups(long companyId)
                       throws PortalException,
                              SystemException
```
    Creates systems groups and other related data needed by the system on the very first startup. Also takes care of creating the Control Panel groups and layouts.
    
    Specified by:
    
    checkSystemGroups in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    
    Throws:
    
    PortalException - if a new system group could not be created
    
    SystemException - if a system exception occurred
  - disableStaging
```
public void disableStaging(long groupId)
                    throws PortalException,
                           SystemException
```
    Specified by:
    
    disableStaging in interface GroupLocalService
    
    Throws:
    
    PortalException
    
    SystemException
  - enableStaging
```
public void enableStaging(long groupId)
                   throws PortalException,
                          SystemException
```
    Specified by:
    
    enableStaging in interface GroupLocalService
    
    Throws:
    
    PortalException
    
    SystemException
  - fetchFriendlyURLGroup
```
public Group fetchFriendlyURLGroup(long companyId,
                          java.lang.String friendlyURL)
                            throws SystemException
```
    Returns the group with the matching friendly URL.
    
    Specified by:
    
    fetchFriendlyURLGroup in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    friendlyURL - the friendly URL
    
    Returns:
    the group with the friendly URL, or null if a matching group could not be found
    
    Throws:
    
    SystemException - if a system exception occurred
  - fetchGroup
```
public Group fetchGroup(long companyId,
               java.lang.String name)
                 throws SystemException
```
    Returns the group with the matching group name by first searching the system groups and then using the finder cache.
    
    Specified by:
    
    fetchGroup in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    name - the group's name
    
    Returns:
    the group with the name and associated company, or null if a matching group could not be found
    
    Throws:
    
    SystemException - if a system exception occurred
  - getCompanyGroup
```
public Group getCompanyGroup(long companyId)
                      throws PortalException,
                             SystemException
```
    Returns the company group.
    
    Specified by:
    
    getCompanyGroup in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    
    Returns:
    the group associated with the company
    
    Throws:
    
    PortalException - if a matching group could not be found
    
    SystemException - if a system exception occurred
  - getCompanyGroups
```
public java.util.List<Group> getCompanyGroups(long companyId,
                                     int start,
                                     int end)
                                       throws SystemException
```
    Returns a range of all the groups associated with the company.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Specified by:
    
    getCompanyGroups in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    start - the lower bound of the range of groups to return
    end - the upper bound of the range of groups to return (not inclusive)
    
    Returns:
    the range of groups associated with the company
    
    Throws:
    
    SystemException - if a system exception occurred
  - getCompanyGroupsCount
```
public int getCompanyGroupsCount(long companyId)
                          throws SystemException
```
    Returns the number of groups associated with the company.
    
    Specified by:
    
    getCompanyGroupsCount in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    
    Returns:
    the number of groups associated with the company
    
    Throws:
    
    SystemException - if a system exception occurred
  - getFriendlyURLGroup
```
public Group getFriendlyURLGroup(long companyId,
                        java.lang.String friendlyURL)
                          throws PortalException,
                                 SystemException
```
    Returns the group with the matching friendly URL.
    
    Specified by:
    
    getFriendlyURLGroup in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    friendlyURL - the group's friendlyURL
    
    Returns:
    the group with the friendly URL
    
    Throws:
    
    PortalException - if a matching group could not be found, or if the friendly URL was invalid
    
    SystemException - if a system exception occurred
  - getGroup
```
public Group getGroup(long companyId,
             java.lang.String name)
               throws PortalException,
                      SystemException
```
    Returns the group with the matching group name.
    
    Specified by:
    
    getGroup in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    name - the group's name
    
    Returns:
    the group with the name
    
    Throws:
    
    PortalException - if a matching group could not be found
    
    SystemException - if a system exception occurred
  - getGroupDescriptiveName
```
public java.lang.String getGroupDescriptiveName(Group group,
                                       java.util.Locale locale)
                                         throws PortalException,
                                                SystemException
```
    Specified by:
    
    getGroupDescriptiveName in interface GroupLocalService
    
    Throws:
    
    PortalException
    
    SystemException
  - getGroupDescriptiveName
```
public java.lang.String getGroupDescriptiveName(long groupId,
                                       java.util.Locale locale)
                                         throws PortalException,
                                                SystemException
```
    Specified by:
    
    getGroupDescriptiveName in interface GroupLocalService
    
    Throws:
    
    PortalException
    
    SystemException
  - getGroups
```
public java.util.List<Group> getGroups(long companyId,
                              long parentGroupId,
                              boolean site)
                                throws SystemException
```
    Returns all the groups that are direct children of the parent group.
    
    Specified by:
    
    getGroups in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    parentGroupId - the primary key of the parent group
    site - whether the group is to be associated with a main site
    
    Returns:
    the matching groups, or null if no matches were found
    
    Throws:
    
    SystemException - if a system exception occurred
  - getGroups
```
public java.util.List<Group> getGroups(long companyId,
                              java.lang.String className,
                              long parentGroupId)
                                throws SystemException
```
    Returns all the groups that are direct children of the parent group with the matching className.
    
    Specified by:
    
    getGroups in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    className - the class name of the group
    parentGroupId - the primary key of the parent group
    
    Returns:
    the matching groups, or null if no matches were found
    
    Throws:
    
    SystemException - if a system exception occurred
  - getGroups
```
public java.util.List<Group> getGroups(long companyId,
                              java.lang.String className,
                              long parentGroupId,
                              int start,
                              int end)
                                throws SystemException
```
    Returns a range of all the groups that are direct children of the parent group with the matching className.
    
    Specified by:
    
    getGroups in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    className - the class name of the group
    parentGroupId - the primary key of the parent group
    start - the lower bound of the range of results
    end - the upper bound of the range of results (not inclusive)
    
    Returns:
    the range of matching groups
    
    Throws:
    
    SystemException - if a system exception occurred
  - getGroups
```
public java.util.List<Group> getGroups(long[] groupIds)
                                throws PortalException,
                                       SystemException
```
    Returns the groups with the matching primary keys.
    
    Specified by:
    
    getGroups in interface GroupLocalService
    
    Parameters:
    groupIds - the primary keys of the groups
    
    Returns:
    the groups with the primary keys
    
    Throws:
    
    PortalException - if any one of the groups could not be found
    
    SystemException - if a system exception occurred
  - getGroupsCount
```
public int getGroupsCount(long companyId,
                 long parentGroupId,
                 boolean site)
                   throws SystemException
```
    Returns the number of groups that are direct children of the parent group.
    
    Specified by:
    
    getGroupsCount in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    parentGroupId - the primary key of the parent group
    site - whether the group is to be associated with a main site
    
    Returns:
    the number of matching groups
    
    Throws:
    
    SystemException - if a system exception occurred
  - getGroupsCount
```
public int getGroupsCount(long companyId,
                 java.lang.String className,
                 long parentGroupId)
                   throws SystemException
```
    Returns the number of groups that are direct children of the parent group with the matching className.
    
    Specified by:
    
    getGroupsCount in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    className - the class name of the group
    parentGroupId - the primary key of the parent group
    
    Returns:
    the number of matching groups
    
    Throws:
    
    SystemException - if a system exception occurred
  - getLayoutGroup
```
public Group getLayoutGroup(long companyId,
                   long plid)
                     throws PortalException,
                            SystemException
```
    Returns the group associated with the layout.
    
    Specified by:
    
    getLayoutGroup in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    plid - the primary key of the layout
    
    Returns:
    the group associated with the layout
    
    Throws:
    
    PortalException - if a matching group could not be found
    
    SystemException - if a system exception occurred
  - getLayoutPrototypeGroup
```
public Group getLayoutPrototypeGroup(long companyId,
                            long layoutPrototypeId)
                              throws PortalException,
                                     SystemException
```
    Returns the group associated with the layout prototype.
    
    Specified by:
    
    getLayoutPrototypeGroup in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    layoutPrototypeId - the primary key of the layout prototype
    
    Returns:
    the group associated with the layout prototype
    
    Throws:
    
    PortalException - if a matching group could not be found
    
    SystemException - if a system exception occurred
  - getLayoutSetPrototypeGroup
```
public Group getLayoutSetPrototypeGroup(long companyId,
                               long layoutSetPrototypeId)
                                 throws PortalException,
                                        SystemException
```
    Returns the group associated with the layout set prototype.
    
    Specified by:
    
    getLayoutSetPrototypeGroup in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    layoutSetPrototypeId - the primary key of the layout set prototype
    
    Returns:
    the group associated with the layout set prototype
    
    Throws:
    
    PortalException - if a matching group could not be found
    
    SystemException - if a system exception occurred
  - getLayoutsGroups
```
public java.util.List<Group> getLayoutsGroups(long companyId,
                                     long parentGroupId,
                                     boolean site,
                                     int start,
                                     int end)
                                       throws SystemException
```
    Returns a range of all groups that are children of the parent group and that have at least one layout.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Specified by:
    
    getLayoutsGroups in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    parentGroupId - the primary key of the parent group
    site - whether the group is to be associated with a main site
    start - the lower bound of the range of groups to return
    end - the upper bound of the range of groups to return (not inclusive)
    
    Returns:
    the range of matching groups
    
    Throws:
    
    SystemException - if a system exception occurred
  - getLayoutsGroupsCount
```
public int getLayoutsGroupsCount(long companyId,
                        long parentGroupId,
                        boolean site)
                          throws SystemException
```
    Returns the number of groups that are children or the parent group and that have at least one layout
    
    Specified by:
    
    getLayoutsGroupsCount in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    parentGroupId - the primary key of the parent group
    site - whether the group is to be associated with a main site
    
    Returns:
    the number of matching groups
    
    Throws:
    
    SystemException - if a system exception occurred
  - getLiveGroups
```
public java.util.List<Group> getLiveGroups()
                                    throws SystemException
```
    Returns all live groups.
    
    Specified by:
    
    getLiveGroups in interface GroupLocalService
    
    Returns:
    all live groups
    
    Throws:
    
    SystemException - if a system exception occurred
  - getNoLayoutsGroups
```
public java.util.List<Group> getNoLayoutsGroups(java.lang.String className,
                                       boolean privateLayout,
                                       int start,
                                       int end)
                                         throws SystemException
```
    Returns a range of all non-system groups of a specified type (className) that have no layouts.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Specified by:
    
    getNoLayoutsGroups in interface GroupLocalService
    
    Parameters:
    className - the entity's class name
    privateLayout - whether to include groups with private layout sets or non-private layout sets
    start - the lower bound of the range of groups to return
    end - the upper bound of the range of groups to return (not inclusive)
    
    Returns:
    the range of matching groups
    
    Throws:
    
    SystemException - if a system exception occurred
  - getNullFriendlyURLGroups
```
public java.util.List<Group> getNullFriendlyURLGroups()
                                               throws SystemException
```
    Returns all non-system groups having null or empty friendly URLs.
    
    Specified by:
    
    getNullFriendlyURLGroups in interface GroupLocalService
    
    Returns:
    the non-system groups having null or empty friendly URLs
    
    Throws:
    
    SystemException - if a system exception occurred
  - getOrganizationGroup
```
public Group getOrganizationGroup(long companyId,
                         long organizationId)
                           throws PortalException,
                                  SystemException
```
    Returns the specified organization group.
    
    Specified by:
    
    getOrganizationGroup in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    organizationId - the primary key of the organization
    
    Returns:
    the group associated with the organization
    
    Throws:
    
    PortalException - if a matching group could not be found
    
    SystemException - if a system exception occurred
  - getOrganizationsGroups
```
public java.util.List<Group> getOrganizationsGroups(java.util.List<Organization> organizations)
```
    Returns the specified organization groups.
    
    Specified by:
    
    getOrganizationsGroups in interface GroupLocalService
    
    Parameters:
    organizations - the organizations
    
    Returns:
    the groups associated with the organizations
  - getOrganizationsRelatedGroups
```
public java.util.List<Group> getOrganizationsRelatedGroups(java.util.List<Organization> organizations)
                                                    throws SystemException
```
    Returns all the groups related to the organizations.
    
    Specified by:
    
    getOrganizationsRelatedGroups in interface GroupLocalService
    
    Parameters:
    organizations - the organizations
    
    Returns:
    the groups related to the organizations
    
    Throws:
    
    SystemException - if a system exception occurred
  - getParentGroups
```
public java.util.List<Group> getParentGroups(long groupId)
                                      throws PortalException,
                                             SystemException
```
    Returns the group followed by all its parent groups ordered by closest ancestor.
    
    Specified by:
    
    getParentGroups in interface GroupLocalService
    
    Parameters:
    groupId - the primary key of the group
    
    Returns:
    the group followed by all its parent groups ordered by closest ancestor
    
    Throws:
    
    PortalException - if a group with the primary key could not be found
    
    SystemException - if a system exception occurred
  - getStagingGroup
```
public Group getStagingGroup(long liveGroupId)
                      throws PortalException,
                             SystemException
```
    Returns the staging group.
    
    Specified by:
    
    getStagingGroup in interface GroupLocalService
    
    Parameters:
    liveGroupId - the primary key of the live group
    
    Returns:
    the staging group
    
    Throws:
    
    PortalException - if a matching staging group could not be found
    
    SystemException - if a system exception occurred
  - getUserGroup
```
public Group getUserGroup(long companyId,
                 long userId)
                   throws PortalException,
                          SystemException
```
    Returns the group associated with the user.
    
    Specified by:
    
    getUserGroup in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    userId - the primary key of the user
    
    Returns:
    the group associated with the user
    
    Throws:
    
    PortalException - if a matching group could not be found
    
    SystemException - if a system exception occurred
  - getUserGroupGroup
```
public Group getUserGroupGroup(long companyId,
                      long userGroupId)
                        throws PortalException,
                               SystemException
```
    Returns the specified "user group" group. That is, the group that represents the UserGroup entity.
    
    Specified by:
    
    getUserGroupGroup in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    userGroupId - the primary key of the user group
    
    Returns:
    the group associated with the user group
    
    Throws:
    
    PortalException - if a matching group could not be found
    
    SystemException - if a system exception occurred
  - getUserGroups
```
public java.util.List<Group> getUserGroups(long userId,
                                  boolean inherit)
                                    throws PortalException,
                                           SystemException
```
    Returns all the user's site groups and immediate organization groups, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    
    Specified by:
    
    getUserGroups in interface GroupLocalService
    
    Parameters:
    userId - the primary key of the user
    inherit - whether to include the user's inherited organization groups and user groups
    
    Returns:
    the user's groups and immediate organization groups
    
    Throws:
    
    PortalException - if a user with the primary key could not be found
    
    SystemException - if a system exception occurred
  - getUserGroups
```
public java.util.List<Group> getUserGroups(long userId,
                                  boolean inherit,
                                  int start,
                                  int end)
                                    throws PortalException,
                                           SystemException
```
    Returns an ordered range of all the user's site groups and immediate organization groups, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Specified by:
    
    getUserGroups in interface GroupLocalService
    
    Parameters:
    userId - the primary key of the user
    inherit - whether to include the user's inherited organization groups and user groups
    start - the lower bound of the range of groups to return
    end - the upper bound of the range of groups to return (not inclusive)
    
    Returns:
    the range of the user's groups and immediate organization groups ordered by name
    
    Throws:
    
    PortalException - if a user with the primary key could not be found
    
    SystemException - if a system exception occurred
  - getUserGroupsGroups
```
public java.util.List<Group> getUserGroupsGroups(java.util.List<UserGroup> userGroups)
                                          throws PortalException,
                                                 SystemException
```
    Returns the groups associated with the user groups.
    
    Specified by:
    
    getUserGroupsGroups in interface GroupLocalService
    
    Parameters:
    userGroups - the user groups
    
    Returns:
    the groups associated with the user groups
    
    Throws:
    
    PortalException - if any one of the user group's group could not be found
    
    SystemException - if a system exception occurred
  - getUserGroupsRelatedGroups
```
public java.util.List<Group> getUserGroupsRelatedGroups(java.util.List<UserGroup> userGroups)
                                                 throws SystemException
```
    Returns all the groups related to the user groups.
    
    Specified by:
    
    getUserGroupsRelatedGroups in interface GroupLocalService
    
    Parameters:
    userGroups - the user groups
    
    Returns:
    the groups related to the user groups
    
    Throws:
    
    SystemException - if a system exception occurred
  - getUserOrganizationsGroups
```
public java.util.List<Group> getUserOrganizationsGroups(long userId,
                                               int start,
                                               int end)
                                                 throws PortalException,
                                                        SystemException
```
    Returns the range of all groups associated with the user's organization groups, including the ancestors of the organization groups, unless portal property organizations.membership.strict is set to true.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Specified by:
    
    getUserOrganizationsGroups in interface GroupLocalService
    
    Parameters:
    userId - the primary key of the user
    start - the lower bound of the range of groups to consider
    end - the upper bound of the range of groups to consider (not inclusive)
    
    Returns:
    the range of groups associated with the user's organization groups
    
    Throws:
    
    PortalException - if a user with the primary key could not be found or if another portal exception occurred
    
    SystemException - if a system exception occurred
  - getUserPersonalSiteGroup
```
public Group getUserPersonalSiteGroup(long companyId)
                               throws PortalException,
                                      SystemException
```
    Specified by:
    
    getUserPersonalSiteGroup in interface GroupLocalService
    
    Throws:
    
    PortalException
    
    SystemException
  - getUserSitesGroups
```
public java.util.List<Group> getUserSitesGroups(long userId)
                                         throws PortalException,
                                                SystemException
```
    Specified by:
    
    getUserSitesGroups in interface GroupLocalService
    
    Throws:
    
    PortalException
    
    SystemException
  - getUserSitesGroups
```
public java.util.List<Group> getUserSitesGroups(long userId,
                                       boolean includeAdministrative)
                                         throws PortalException,
                                                SystemException
```
    Specified by:
    
    getUserSitesGroups in interface GroupLocalService
    
    Throws:
    
    PortalException
    
    SystemException
  - hasStagingGroup
```
public boolean hasStagingGroup(long liveGroupId)
                        throws SystemException
```
    Returns true if the live group has a staging group.
    
    Specified by:
    
    hasStagingGroup in interface GroupLocalService
    
    Parameters:
    liveGroupId - the primary key of the live group
    
    Returns:
    true if the live group has a staging group; false otherwise
    
    Throws:
    
    SystemException - if a system exception occurred
  - hasUserGroup
```
public boolean hasUserGroup(long userId,
                   long groupId,
                   boolean inherit)
                     throws SystemException
```
    Returns true if the user is immediately associated with the group, or optionally if the user is associated with the group via the user's organizations, inherited organizations, or user groups.
    
    Specified by:
    
    hasUserGroup in interface GroupLocalService
    
    Parameters:
    userId - the primary key of the user
    groupId - the primary key of the group
    inherit - whether to include organization groups and user groups to which the user belongs in the determination
    
    Returns:
    true if the user is associated with the group; false otherwise
    
    Throws:
    
    SystemException - if a system exception occurred
  - loadFetchGroup
```
public Group loadFetchGroup(long companyId,
                   java.lang.String name)
                     throws SystemException
```
    Returns the group with the matching group name by first searching the system groups and then using the finder cache.
    
    Specified by:
    
    loadFetchGroup in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    name - the group's name
    
    Returns:
    the group with the name and associated company, or null if a matching group could not be found
    
    Throws:
    
    SystemException - if a system exception occurred
  - loadGetGroup
```
public Group loadGetGroup(long companyId,
                 java.lang.String name)
                   throws PortalException,
                          SystemException
```
    Returns the group with the matching group name.
    
    Specified by:
    
    loadGetGroup in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    name - the group's name
    
    Returns:
    the group with the name and associated company
    
    Throws:
    
    PortalException - if a matching group could not be found
    
    SystemException - if a system exception occurred
  - rebuildTree
```
public void rebuildTree(long companyId)
                 throws PortalException,
                        SystemException
```
    Rebuilds the group tree.
    Only call this method if the tree has become stale through operations other than normal CRUD. Under normal circumstances the tree is automatically rebuilt whenever necessary.
    
    Specified by:
    
    rebuildTree in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the group's company
    
    Throws:
    
    PortalException - if a group with the primary key could not be found
    
    SystemException - if a system exception occurred
  - search
```
public java.util.List<Group> search(long companyId,
                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                           int start,
                           int end)
                             throws SystemException
```
    Returns an ordered range of all the company's groups, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Specified by:
    
    search in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    params - the finder params (optionally null). To include a user's organizations, inherited organizations, and user groups in the search, add an entry with key "usersGroups" mapped to the user's ID and an entry with key "inherit" mapped to a non-null object. For more information see GroupFinder
    start - the lower bound of the range of groups to return
    end - the upper bound of the range of groups to return (not inclusive)
    
    Returns:
    the matching groups ordered by name
    
    Throws:
    
    SystemException - if a system exception occurred
  - search
```
public java.util.List<Group> search(long companyId,
                           long parentGroupId,
                           java.lang.String keywords,
                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                           int start,
                           int end)
                             throws SystemException
```
    Returns an ordered range of all the groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Specified by:
    
    search in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    parentGroupId - the primary key of the parent group
    keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null)
    params - the finder params (optionally null). To include the user's inherited organizations and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder
    start - the lower bound of the range of groups to return
    end - the upper bound of the range of groups to return (not inclusive)
    
    Returns:
    the matching groups ordered by name
    
    Throws:
    
    SystemException - if a system exception occurred
  - search
```
public java.util.List<Group> search(long companyId,
                           long parentGroupId,
                           java.lang.String keywords,
                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                           int start,
                           int end,
                           OrderByComparator obc)
                             throws SystemException
```
    Returns an ordered range of all the groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Specified by:
    
    search in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    parentGroupId - the primary key of the parent group
    keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null)
    params - the finder params (optionally null). To include the user's inherited organizations and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder
    start - the lower bound of the range of groups to return
    end - the upper bound of the range of groups to return (not inclusive)
    obc - the comparator to order the groups (optionally null)
    
    Returns:
    the matching groups ordered by comparator obc
    
    Throws:
    
    SystemException - if a system exception occurred
  - search
```
public java.util.List<Group> search(long companyId,
                           long parentGroupId,
                           java.lang.String name,
                           java.lang.String description,
                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                           boolean andOperator,
                           int start,
                           int end)
                             throws SystemException
```
    Returns an ordered range of all the site groups belonging to the parent group and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Specified by:
    
    search in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    parentGroupId - the primary key of the parent group
    name - the group's name (optionally null)
    description - the group's description (optionally null)
    params - the finder params (optionally null). To include the user's inherited organizations and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder
    andOperator - whether every field must match its keywords, or just one field.
    start - the lower bound of the range of groups to return
    end - the upper bound of the range of groups to return (not inclusive)
    
    Returns:
    the matching groups ordered by name
    
    Throws:
    
    SystemException - if a system exception occurred
  - search
```
public java.util.List<Group> search(long companyId,
                           long parentGroupId,
                           java.lang.String name,
                           java.lang.String description,
                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                           boolean andOperator,
                           int start,
                           int end,
                           OrderByComparator obc)
                             throws SystemException
```
    Returns an ordered range of all the site groups belonging to the parent group and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Specified by:
    
    search in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    parentGroupId - the primary key of the parent group
    name - the group's name (optionally null)
    description - the group's description (optionally null)
    params - the finder params (optionally null). To include the user's inherited organizations and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder
    andOperator - whether every field must match its keywords, or just one field.
    start - the lower bound of the range of groups to return
    end - the upper bound of the range of groups to return (not inclusive)
    obc - the comparator to order the groups (optionally null)
    
    Returns:
    the matching groups ordered by comparator obc
    
    Throws:
    
    SystemException - if a system exception occurred
  - search
```
public java.util.List<Group> search(long companyId,
                           long[] classNameIds,
                           long parentGroupId,
                           java.lang.String keywords,
                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                           int start,
                           int end)
                             throws SystemException
```
    Returns an ordered range of all the groups belonging to the parent group that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Specified by:
    
    search in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null)
    parentGroupId - the primary key of the parent group
    keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null)
    params - the finder params (optionally null). To include a user's organizations, inherited organizations, and user groups in the search, add an entry with key "usersGroups" mapped to the user's ID and an entry with key "inherit" mapped to a non-null object. For more information see GroupFinder
    start - the lower bound of the range of groups to return
    end - the upper bound of the range of groups to return (not inclusive)
    
    Returns:
    the matching groups ordered by name
    
    Throws:
    
    SystemException - if a system exception occurred
  - search
```
public java.util.List<Group> search(long companyId,
                           long[] classNameIds,
                           long parentGroupId,
                           java.lang.String keywords,
                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                           int start,
                           int end,
                           OrderByComparator obc)
                             throws SystemException
```
    Returns an ordered range of all the groups belonging to the parent group that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Specified by:
    
    search in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null)
    parentGroupId - the primary key of the parent group
    keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null)
    params - the finder params (optionally null). To include a user's organizations, inherited organizations, and user groups in the search, add an entry with key "usersGroups" mapped to the user's ID and an entry with key "inherit" mapped to a non-null object. For more information see GroupFinder
    start - the lower bound of the range of groups to return
    end - the upper bound of the range of groups to return (not inclusive)
    obc - the comparator to order the groups (optionally null)
    
    Returns:
    the matching groups ordered by comparator obc
    
    Throws:
    
    SystemException - if a system exception occurred
  - search
```
public java.util.List<Group> search(long companyId,
                           long[] classNameIds,
                           long parentGroupId,
                           java.lang.String name,
                           java.lang.String description,
                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                           boolean andOperator,
                           int start,
                           int end)
                             throws SystemException
```
    Returns an ordered range of all the groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Specified by:
    
    search in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null)
    parentGroupId - the primary key of the parent group
    name - the group's name (optionally null)
    description - the group's description (optionally null)
    params - the finder params (optionally null). To include a user's organizations, inherited organizations, and user groups in the search, add an entry with key "usersGroups" mapped to the user's ID and an entry with key "inherit" mapped to a non-null object. For more information see GroupFinder
    andOperator - whether every field must match its keywords, or just one field.
    start - the lower bound of the range of groups to return
    end - the upper bound of the range of groups to return (not inclusive)
    
    Returns:
    the matching groups ordered by name
    
    Throws:
    
    SystemException - if a system exception occurred
  - search
```
public java.util.List<Group> search(long companyId,
                           long[] classNameIds,
                           long parentGroupId,
                           java.lang.String name,
                           java.lang.String description,
                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                           boolean andOperator,
                           int start,
                           int end,
                           OrderByComparator obc)
                             throws SystemException
```
    Returns an ordered range of all the groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Specified by:
    
    search in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null)
    parentGroupId - the primary key of the parent group
    name - the group's name (optionally null)
    description - the group's description (optionally null)
    params - the finder params (optionally null). To include a user's organizations, inherited organizations, and user groups in the search, add an entry with key "usersGroups" mapped to the user's ID and an entry with key "inherit" mapped to a non-null object. For more information see GroupFinder
    andOperator - whether every field must match its keywords, or just one field.
    start - the lower bound of the range of groups to return
    end - the upper bound of the range of groups to return (not inclusive)
    obc - the comparator to order the groups (optionally null)
    
    Returns:
    the matching groups ordered by comparator obc
    
    Throws:
    
    SystemException - if a system exception occurred
  - search
```
public java.util.List<Group> search(long companyId,
                           long[] classNameIds,
                           java.lang.String keywords,
                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                           int start,
                           int end)
                             throws SystemException
```
    Returns an ordered range of all the groups that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Specified by:
    
    search in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null)
    keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null)
    params - the finder params (optionally null). To include a user's organizations, inherited organizations, and user groups in the search, add an entry with key "usersGroups" mapped to the user's ID and an entry with key "inherit" mapped to a non-null object. For more information see GroupFinder
    start - the lower bound of the range of groups to return
    end - the upper bound of the range of groups to return (not inclusive)
    
    Returns:
    the matching groups ordered by name
    
    Throws:
    
    SystemException - if a system exception occurred
  - search
```
public java.util.List<Group> search(long companyId,
                           long[] classNameIds,
                           java.lang.String keywords,
                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                           int start,
                           int end,
                           OrderByComparator obc)
                             throws SystemException
```
    Returns an ordered range of all the groups that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Specified by:
    
    search in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null)
    keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null)
    params - the finder params (optionally null). To include a user's organizations, inherited organizations, and user groups in the search, add an entry with key "usersGroups" mapped to the user's ID and an entry with key "inherit" mapped to a non-null object. For more information see GroupFinder
    start - the lower bound of the range of groups to return
    end - the upper bound of the range of groups to return (not inclusive)
    obc - the comparator to order the groups (optionally null)
    
    Returns:
    the matching groups ordered by comparator obc
    
    Throws:
    
    SystemException - if a system exception occurred
  - search
```
public java.util.List<Group> search(long companyId,
                           long[] classNameIds,
                           java.lang.String name,
                           java.lang.String description,
                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                           boolean andOperator,
                           int start,
                           int end)
                             throws SystemException
```
    Returns an ordered range of all the groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Specified by:
    
    search in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null)
    name - the group's name (optionally null)
    description - the group's description (optionally null)
    params - the finder params (optionally null). To include a user's organizations, inherited organizations, and user groups in the search, add an entry with key "usersGroups" mapped to the user's ID and an entry with key "inherit" mapped to a non-null object. For more information see GroupFinder
    andOperator - whether every field must match its keywords, or just one field.
    start - the lower bound of the range of groups to return
    end - the upper bound of the range of groups to return (not inclusive)
    
    Returns:
    the matching groups ordered by name
    
    Throws:
    
    SystemException - if a system exception occurred
  - search
```
public java.util.List<Group> search(long companyId,
                           long[] classNameIds,
                           java.lang.String name,
                           java.lang.String description,
                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                           boolean andOperator,
                           int start,
                           int end,
                           OrderByComparator obc)
                             throws SystemException
```
    Returns an ordered range of all the groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Specified by:
    
    search in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null)
    name - the group's name (optionally null)
    description - the group's description (optionally null)
    params - the finder params (optionally null). To include a user's organizations, inherited organizations, and user groups in the search, add an entry with key "usersGroups" mapped to the user's ID and an entry with key "inherit" mapped to a non-null object. For more information see GroupFinder
    andOperator - whether every field must match its keywords, or just one field.
    start - the lower bound of the range of groups to return
    end - the upper bound of the range of groups to return (not inclusive)
    obc - the comparator to order the groups (optionally null)
    
    Returns:
    the matching groups ordered by comparator obc
    
    Throws:
    
    SystemException - if a system exception occurred
  - search
```
public java.util.List<Group> search(long companyId,
                           java.lang.String keywords,
                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                           int start,
                           int end)
                             throws SystemException
```
    Returns an ordered range of all the groups that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Specified by:
    
    search in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null)
    params - the finder params (optionally null). To include the user's inherited organizations and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder
    start - the lower bound of the range of groups to return
    end - the upper bound of the range of groups to return (not inclusive)
    
    Returns:
    the matching groups ordered by name
    
    Throws:
    
    SystemException - if a system exception occurred
  - search
```
public java.util.List<Group> search(long companyId,
                           java.lang.String keywords,
                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                           int start,
                           int end,
                           OrderByComparator obc)
                             throws SystemException
```
    Returns an ordered range of all the groups that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Specified by:
    
    search in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null)
    params - the finder params (optionally null). To include the user's inherited organizations and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder
    start - the lower bound of the range of groups to return
    end - the upper bound of the range of groups to return (not inclusive)
    obc - the comparator to order the groups (optionally null)
    
    Returns:
    the matching groups ordered by comparator obc
    
    Throws:
    
    SystemException - if a system exception occurred
  - search
```
public java.util.List<Group> search(long companyId,
                           java.lang.String name,
                           java.lang.String description,
                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                           boolean andOperator,
                           int start,
                           int end)
                             throws SystemException
```
    Returns an ordered range of all the site groups and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Specified by:
    
    search in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    name - the group's name (optionally null)
    description - the group's description (optionally null)
    params - the finder params (optionally null). To include the user's inherited organizations and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder
    andOperator - whether every field must match its keywords, or just one field.
    start - the lower bound of the range of groups to return
    end - the upper bound of the range of groups to return (not inclusive)
    
    Returns:
    the matching groups ordered by name
    
    Throws:
    
    SystemException - if a system exception occurred
  - search
```
public java.util.List<Group> search(long companyId,
                           java.lang.String name,
                           java.lang.String description,
                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                           boolean andOperator,
                           int start,
                           int end,
                           OrderByComparator obc)
                             throws SystemException
```
    Returns an ordered range of all the site groups and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.
    
    Specified by:
    
    search in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    name - the group's name (optionally null)
    description - the group's description (optionally null)
    params - the finder params (optionally null). To include the user's inherited organizations and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder
    andOperator - whether every field must match its keywords, or just one field.
    start - the lower bound of the range of groups to return
    end - the upper bound of the range of groups to return (not inclusive)
    obc - the comparator to order the groups (optionally null)
    
    Returns:
    the matching groups ordered by comparator obc
    
    Throws:
    
    SystemException - if a system exception occurred
  - searchCount
```
public int searchCount(long companyId,
              long parentGroupId,
              java.lang.String keywords,
              java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
                throws SystemException
```
    Returns the number of groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    
    Specified by:
    
    searchCount in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    parentGroupId - the primary key of the parent group
    keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null)
    params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder
    
    Returns:
    the number of matching groups
    
    Throws:
    
    SystemException - if a system exception occurred
  - searchCount
```
public int searchCount(long companyId,
              long parentGroupId,
              java.lang.String name,
              java.lang.String description,
              java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
              boolean andOperator)
                throws SystemException
```
    Returns the number of groups belonging to the parent group and immediate organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    
    Specified by:
    
    searchCount in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    parentGroupId - the primary key of the parent group
    name - the group's name (optionally null)
    description - the group's description (optionally null)
    params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder
    andOperator - whether every field must match its keywords, or just one field.
    
    Returns:
    the number of matching groups
    
    Throws:
    
    SystemException - if a system exception occurred
  - searchCount
```
public int searchCount(long companyId,
              long[] classNameIds,
              long parentGroupId,
              java.lang.String keywords,
              java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
                throws SystemException
```
    Returns the number of groups belonging to the parent group that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    
    Specified by:
    
    searchCount in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null)
    parentGroupId - the primary key of the parent group
    keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null)
    params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder
    
    Returns:
    the number of matching groups
    
    Throws:
    
    SystemException - if a system exception occurred
  - searchCount
```
public int searchCount(long companyId,
              long[] classNameIds,
              long parentGroupId,
              java.lang.String name,
              java.lang.String description,
              java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
              boolean andOperator)
                throws SystemException
```
    Returns the number of groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    
    Specified by:
    
    searchCount in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null)
    parentGroupId - the primary key of the parent group
    name - the group's name (optionally null)
    description - the group's description (optionally null)
    params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder
    andOperator - whether every field must match its keywords, or just one field.
    
    Returns:
    the number of matching groups
    
    Throws:
    
    SystemException - if a system exception occurred
  - searchCount
```
public int searchCount(long companyId,
              long[] classNameIds,
              java.lang.String keywords,
              java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
                throws SystemException
```
    Returns the number of groups that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    
    Specified by:
    
    searchCount in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null)
    keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null)
    params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder
    
    Returns:
    the number of matching groups
    
    Throws:
    
    SystemException - if a system exception occurred
  - searchCount
```
public int searchCount(long companyId,
              long[] classNameIds,
              java.lang.String name,
              java.lang.String description,
              java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
              boolean andOperator)
                throws SystemException
```
    Returns the number of groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    
    Specified by:
    
    searchCount in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null)
    name - the group's name (optionally null)
    description - the group's description (optionally null)
    params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder
    andOperator - whether every field must match its keywords, or just one field.
    
    Returns:
    the number of matching groups
    
    Throws:
    
    SystemException - if a system exception occurred
  - searchCount
```
public int searchCount(long companyId,
              java.lang.String keywords,
              java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
                throws SystemException
```
    Returns the number of groups that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    
    Specified by:
    
    searchCount in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null)
    params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder
    
    Returns:
    the number of matching groups
    
    Throws:
    
    SystemException - if a system exception occurred
  - searchCount
```
public int searchCount(long companyId,
              java.lang.String name,
              java.lang.String description,
              java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
              boolean andOperator)
                throws SystemException
```
    Returns the number of groups and immediate organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    
    Specified by:
    
    searchCount in interface GroupLocalService
    
    Parameters:
    companyId - the primary key of the company
    name - the group's name (optionally null)
    description - the group's description (optionally null)
    params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder
    andOperator - whether every field must match its keywords, or just one field.
    
    Returns:
    the number of matching groups
    
    Throws:
    
    SystemException - if a system exception occurred
  - unsetRoleGroups
```
public void unsetRoleGroups(long roleId,
                   long[] groupIds)
                     throws SystemException
```
    Removes the groups from the role.
    
    Specified by:
    
    unsetRoleGroups in interface GroupLocalService
    
    Parameters:
    roleId - the primary key of the role
    groupIds - the primary keys of the groups
    
    Throws:
    
    SystemException - if a system exception occurred
  - unsetUserGroups
```
public void unsetUserGroups(long userId,
                   long[] groupIds)
                     throws SystemException
```
    Removes the user from the groups.
    
    Specified by:
    
    unsetUserGroups in interface GroupLocalService
    
    Parameters:
    userId - the primary key of the user
    groupIds - the primary keys of the groups
    
    Throws:
    
    SystemException - if a system exception occurred
  - updateAsset
```
public void updateAsset(long userId,
               Group group,
               long[] assetCategoryIds,
               java.lang.String[] assetTagNames)
                 throws PortalException,
                        SystemException
```
    Updates the group's asset replacing categories and tag names.
    
    Specified by:
    
    updateAsset in interface GroupLocalService
    
    Parameters:
    userId - the primary key of the user
    group - the group
    assetCategoryIds - the primary keys of the asset categories (optionally null)
    assetTagNames - the asset tag names (optionally null)
    
    Throws:
    
    PortalException - if a user with the primary key could not be found
    
    SystemException - if a system exception occurred
  - updateFriendlyURL
```
public Group updateFriendlyURL(long groupId,
                      java.lang.String friendlyURL)
                        throws PortalException,
                               SystemException
```
    Updates the group's friendly URL.
    
    Specified by:
    
    updateFriendlyURL in interface GroupLocalService
    
    Parameters:
    groupId - the primary key of the group
    friendlyURL - the group's new friendlyURL (optionally null)
    
    Returns:
    the group
    
    Throws:
    
    PortalException - if a group with the primary key could not be found or if a valid friendly URL could not be created for the group
    
    SystemException - if a system exception occurred
  - updateGroup
```
public Group updateGroup(long groupId,
                long parentGroupId,
                java.lang.String name,
                java.lang.String description,
                int type,
                boolean manualMembership,
                int membershipRestriction,
                java.lang.String friendlyURL,
                boolean active,
                ServiceContext serviceContext)
                  throws PortalException,
                         SystemException
```
    Updates the group.
    
    Specified by:
    
    updateGroup in interface GroupLocalService
    
    Parameters:
    groupId - the primary key of the group
    parentGroupId - the primary key of the parent group
    name - the group's new name
    description - the group's new description (optionally null)
    type - the group's new type. For more information see GroupConstants
    friendlyURL - the group's new friendlyURL (optionally null)
    active - whether the group is active
    serviceContext - the service context to be applied (optionally null). Can set asset category IDs and asset tag names for the group.
    
    Returns:
    the group
    
    Throws:
    
    PortalException - if a group with the primary key could not be found or if the friendly URL was invalid or could one not be created
    
    SystemException - if a system exception occurred
  - updateGroup
```
public Group updateGroup(long groupId,
                java.lang.String typeSettings)
                  throws PortalException,
                         SystemException
```
    Updates the group's type settings.
    
    Specified by:
    
    updateGroup in interface GroupLocalService
    
    Parameters:
    groupId - the primary key of the group
    typeSettings - the group's new type settings (optionally null)
    
    Returns:
    the group
    
    Throws:
    
    PortalException - if a group with the primary key could not be found
    
    SystemException - if a system exception occurred
  - updateSite
```
public Group updateSite(long groupId,
               boolean site)
                 throws PortalException,
                        SystemException
```
    Associates the group with a main site if the group is an organization.
    
    Specified by:
    
    updateSite in interface GroupLocalService
    
    Parameters:
    groupId - the primary key of the group
    site - whether the group is to be associated with a main site
    
    Returns:
    the group
    
    Throws:
    
    PortalException - if a group with the primary key could not be found
    
    SystemException - if a system exception occurred
  - getWrappedGroupLocalService
```
public GroupLocalService getWrappedGroupLocalService()
```
    Deprecated. As of 6.1.0, replaced by getWrappedService()
  - setWrappedGroupLocalService
```
public void setWrappedGroupLocalService(GroupLocalService groupLocalService)
```
    Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portal.service.GroupLocalService)
  - getWrappedService
```
public GroupLocalService getWrappedService()
```
    Specified by:
    
    getWrappedService in interface ServiceWrapper<GroupLocalService>
  - setWrappedService
```
public void setWrappedService(GroupLocalService groupLocalService)
```
    Specified by:
    
    setWrappedService in interface ServiceWrapper<GroupLocalService>

Class GroupLocalServiceWrapper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GroupLocalServiceWrapper

Method Detail

addGroup

createGroup

deleteGroup

deleteGroup

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQueryCount

dynamicQueryCount

fetchGroup

fetchGroupByUuidAndCompanyId

getGroup

getPersistedModel

getGroupByUuidAndCompanyId

getGroups

getGroupsCount

updateGroup

addOrganizationGroup

addOrganizationGroup

addOrganizationGroups

addOrganizationGroups

clearOrganizationGroups

deleteOrganizationGroup

deleteOrganizationGroup

deleteOrganizationGroups

deleteOrganizationGroups

getOrganizationGroups

getOrganizationGroups

getOrganizationGroups

getOrganizationGroupsCount

hasOrganizationGroup

hasOrganizationGroups

setOrganizationGroups

addRoleGroup

addRoleGroup

addRoleGroups

addRoleGroups

clearRoleGroups

deleteRoleGroup

deleteRoleGroup

deleteRoleGroups

deleteRoleGroups

getRoleGroups

getRoleGroups

getRoleGroups

getRoleGroupsCount

hasRoleGroup

hasRoleGroups

setRoleGroups

addUserGroupGroup

addUserGroupGroup

addUserGroupGroups

addUserGroupGroups

clearUserGroupGroups

deleteUserGroupGroup

deleteUserGroupGroup

deleteUserGroupGroups

deleteUserGroupGroups

getUserGroupGroups

getUserGroupGroups

getUserGroupGroups

getUserGroupGroupsCount

hasUserGroupGroup

hasUserGroupGroups

setUserGroupGroups

addUserGroup

addUserGroup

addUserGroups

addUserGroups

clearUserGroups

deleteUserGroup

deleteUserGroup