GroupLocalServiceWrapper (Liferay 7.1.10 portal-kernel API)

Object
- com.liferay.portal.kernel.service.GroupLocalServiceWrapper

All Implemented Interfaces:

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

Author:

Brian Wing Shun Chan

See Also:

GroupLocalService

{$generated.description}

Constructor Summary

Constructors
Constructor and Description

GroupLocalServiceWrapper(GroupLocalService groupLocalService)

Constructors
Constructor and Description
`GroupLocalServiceWrapper(GroupLocalService groupLocalService)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Group`	`addGroup(Group group)` Adds the group to the database.
`Group`	`addGroup(long userId, long parentGroupId, String className, long classPK, long liveGroupId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean site, boolean inheritContent, boolean active, ServiceContext serviceContext)`
`Group`	`addGroup(long userId, long parentGroupId, String className, long classPK, long liveGroupId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean site, boolean active, ServiceContext serviceContext)`
`Group`	`addGroup(long userId, long parentGroupId, String className, long classPK, long liveGroupId, String name, String description, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean site, boolean active, ServiceContext serviceContext)` Deprecated. As of Wilberforce (7.0.x), replaced by `addGroup(long, long, String, long, long, Map, Map, int, boolean, int, String, boolean, boolean, ServiceContext)`
`void`	`addOrganizationGroup(long organizationId, Group group)`
`void`	`addOrganizationGroup(long organizationId, long groupId)`
`void`	`addOrganizationGroups(long organizationId, 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, 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, List<Group> groups)`
`void`	`addUserGroupGroups(long userGroupId, long[] groupIds)`
`void`	`addUserGroups(long userId, List<Group> groups)`
`void`	`addUserGroups(long userId, long[] groupIds)`
`void`	`checkCompanyGroup(long companyId)` Adds a company group if it does not exist.
`Group`	`checkScopeGroup(Layout layout, long userId)`
`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, List<Group> groups)`
`void`	`deleteOrganizationGroups(long organizationId, long[] groupIds)`
`PersistedModel`	`deletePersistedModel(PersistedModel persistedModel)`
`void`	`deleteRoleGroup(long roleId, Group group)`
`void`	`deleteRoleGroup(long roleId, long groupId)`
`void`	`deleteRoleGroups(long roleId, 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, List<Group> groups)`
`void`	`deleteUserGroupGroups(long userGroupId, long[] groupIds)`
`void`	`deleteUserGroups(long userId, List<Group> groups)`
`void`	`deleteUserGroups(long userId, long[] groupIds)`
`void`	`disableStaging(long groupId)`
`DynamicQuery`	`dynamicQuery()`
`<T> List<T>`	`dynamicQuery(DynamicQuery dynamicQuery)` Performs a dynamic query on the database and returns the matching rows.
`<T> List<T>`	`dynamicQuery(DynamicQuery dynamicQuery, int start, int end)` Performs a dynamic query on the database and returns a range of the matching rows.
`<T> List<T>`	`dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> 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 matching the dynamic query.
`long`	`dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)` Returns the number of rows matching the dynamic query.
`void`	`enableStaging(long groupId)`
`Group`	`fetchCompanyGroup(long companyId)` Returns the company's group.
`Group`	`fetchFriendlyURLGroup(long companyId, String friendlyURL)` Returns the group with the matching friendly URL.
`Group`	`fetchGroup(long groupId)`
`Group`	`fetchGroup(long companyId, String groupKey)` Returns the group with the matching group key by first searching the system groups and then using the finder cache.
`Group`	`fetchGroupByUuidAndCompanyId(String uuid, long companyId)` Returns the group with the matching UUID and company.
`Group`	`fetchStagingGroup(long liveGroupId)`
`Group`	`fetchUserGroup(long companyId, long userId)`
`Group`	`fetchUserPersonalSiteGroup(long companyId)` Returns the default user's personal site group.
`ActionableDynamicQuery`	`getActionableDynamicQuery()`
`List<Long>`	`getActiveGroupIds(long userId)`
`List<Group>`	`getActiveGroups(long companyId, boolean active)` Returns all the active or inactive groups associated with the company.
`List<Group>`	`getActiveGroups(long companyId, boolean site, boolean active, int start, int end, OrderByComparator<Group> obc)` Returns the active or inactive groups associated with the company and, optionally, the main site.
`List<Group>`	`getActiveGroups(long companyId, boolean active, int start, int end, OrderByComparator<Group> obc)` Returns the active or inactive groups associated with the company.
`int`	`getActiveGroupsCount(long companyId, boolean active)` Returns the number of active or inactive groups associated with the company.
`int`	`getActiveGroupsCount(long companyId, boolean active, boolean site)` Returns the number of active or inactive groups associated with the company.
`Group`	`getCompanyGroup(long companyId)` Returns the company group.
`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, 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, String groupKey)` Returns the group with the matching group key.
`Group`	`getGroupByUuidAndCompanyId(String uuid, long companyId)` Returns the group with the matching UUID and company.
`String`	`getGroupDescriptiveName(Group group, Locale locale)` Deprecated. As of Wilberforce (7.0.x), replaced by `Group#getDescriptiveName(Locale)`
`String`	`getGroupDescriptiveName(long groupId, Locale locale)` Deprecated. As of Wilberforce (7.0.x), replaced by `Group#getDescriptiveName(Locale)`
`List<Group>`	`getGroups(int start, int end)` Returns a range of all the groups.
`List<Group>`	`getGroups(long[] groupIds)` Returns the groups with the matching primary keys.
`List<Group>`	`getGroups(long companyId, long parentGroupId, boolean site)` Returns all the groups that are direct children of the parent group.
`List<Group>`	`getGroups(long companyId, long parentGroupId, boolean site, boolean inheritContent)`
`List<Group>`	`getGroups(long companyId, long parentGroupId, boolean site, int start, int end)`
`List<Group>`	`getGroups(long companyId, long parentGroupId, String name, boolean site, int start, int end)`
`List<Group>`	`getGroups(long companyId, String treePath, boolean site)`
`List<Group>`	`getGroups(long companyId, String className, long parentGroupId)` Returns all the groups that are direct children of the parent group with the matching className.
`List<Group>`	`getGroups(long companyId, 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, long parentGroupId, String name, boolean site)`
`int`	`getGroupsCount(long companyId, String className, long parentGroupId)` Returns the number of groups that are direct children of the parent group with the matching className.
`IndexableActionableDynamicQuery`	`getIndexableActionableDynamicQuery()`
`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.
`List<Group>`	`getLayoutsGroups(long companyId, long parentGroupId, boolean site, boolean active, int start, int end, OrderByComparator<Group> obc)` Returns a range of all groups that are children of the parent group and that have at least one layout.
`List<Group>`	`getLayoutsGroups(long companyId, long parentGroupId, boolean site, int start, int end, OrderByComparator<Group> obc)` 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
`int`	`getLayoutsGroupsCount(long companyId, long parentGroupId, boolean site, boolean active)` Returns the number of groups that are children or the parent group and that have at least one layout
`List<Group>`	`getLiveGroups()` Returns all live groups.
`List<Group>`	`getNoLayoutsGroups(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.
`List<Group>`	`getNullFriendlyURLGroups()` Deprecated. As of Judson (7.1.x), with no direct replacement
`Group`	`getOrganizationGroup(long companyId, long organizationId)` Returns the specified organization group.
`List<Group>`	`getOrganizationGroups(long organizationId)`
`List<Group>`	`getOrganizationGroups(long organizationId, int start, int end)`
`List<Group>`	`getOrganizationGroups(long organizationId, int start, int end, OrderByComparator<Group> orderByComparator)`
`int`	`getOrganizationGroupsCount(long organizationId)`
`long[]`	`getOrganizationPrimaryKeys(long groupId)` Returns the organizationIds of the organizations associated with the group.
`List<Group>`	`getOrganizationsGroups(List<Organization> organizations)` Returns the specified organization groups.
`List<Group>`	`getOrganizationsRelatedGroups(List<Organization> organizations)` Returns all the groups related to the organizations.
`String`	`getOSGiServiceIdentifier()` Returns the OSGi service identifier.
`List<Group>`	`getParentGroups(long groupId)` Returns the group followed by all its parent groups ordered by closest ancestor.
`PersistedModel`	`getPersistedModel(Serializable primaryKeyObj)`
`List<Group>`	`getRoleGroups(long roleId)`
`List<Group>`	`getRoleGroups(long roleId, int start, int end)`
`List<Group>`	`getRoleGroups(long roleId, int start, int end, OrderByComparator<Group> orderByComparator)`
`int`	`getRoleGroupsCount(long roleId)`
`long[]`	`getRolePrimaryKeys(long groupId)` Returns the roleIds of the roles associated with the group.
`List<Group>`	`getStagedSites()`
`Group`	`getStagingGroup(long liveGroupId)` Returns the staging group.
`Group`	`getUserGroup(long companyId, long userId)` Returns the group directly associated with the user.
`Group`	`getUserGroupGroup(long companyId, long userGroupId)` Returns the specified "user group" group.
`List<Group>`	`getUserGroupGroups(long userGroupId)`
`List<Group>`	`getUserGroupGroups(long userGroupId, int start, int end)`
`List<Group>`	`getUserGroupGroups(long userGroupId, int start, int end, OrderByComparator<Group> orderByComparator)`
`int`	`getUserGroupGroupsCount(long userGroupId)`
`long[]`	`getUserGroupPrimaryKeys(long groupId)` Returns the userGroupIds of the user groups associated with the group.
`List<Group>`	`getUserGroups(long userId)`
`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.
`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.
`List<Group>`	`getUserGroups(long userId, int start, int end)`
`List<Group>`	`getUserGroups(long userId, int start, int end, OrderByComparator<Group> orderByComparator)`
`int`	`getUserGroupsCount(long userId)`
`List<Group>`	`getUserGroupsGroups(List<UserGroup> userGroups)` Returns the groups associated with the user groups.
`List<Group>`	`getUserGroupsRelatedGroups(List<UserGroup> userGroups)` Returns all the groups related to the user groups.
`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)` Returns the default user's personal site group.
`long[]`	`getUserPrimaryKeys(long groupId)` Returns the userIds of the users associated with the group.
`List<Group>`	`getUserSitesGroups(long userId)`
`List<Group>`	`getUserSitesGroups(long userId, boolean includeAdministrative)`
`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)`
`boolean`	`isLiveGroupActive(Group group)`
`Group`	`loadFetchGroup(long companyId, String groupKey)` Returns the group with the matching group key by first searching the system groups and then using the finder cache.
`Group`	`loadGetGroup(long companyId, String groupKey)` Returns the group with the matching group key.
`void`	`rebuildTree(long companyId)` Rebuilds the group tree.
`List<Group>`	`search(long companyId, LinkedHashMap<String,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.
`List<Group>`	`search(long companyId, long[] classNameIds, long parentGroupId, String keywords, LinkedHashMap<String,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.
`List<Group>`	`search(long companyId, long[] classNameIds, long parentGroupId, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Group> 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.
`List<Group>`	`search(long companyId, long[] classNameIds, long parentGroupId, String name, String description, LinkedHashMap<String,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.
`List<Group>`	`search(long companyId, long[] classNameIds, long parentGroupId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> 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.
`List<Group>`	`search(long companyId, long[] classNameIds, String keywords, LinkedHashMap<String,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.
`List<Group>`	`search(long companyId, long[] classNameIds, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Group> 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.
`List<Group>`	`search(long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String,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.
`List<Group>`	`search(long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> 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.
`List<Group>`	`search(long companyId, long parentGroupId, String keywords, LinkedHashMap<String,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.
`List<Group>`	`search(long companyId, long parentGroupId, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Group> 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.
`List<Group>`	`search(long companyId, long parentGroupId, String name, String description, LinkedHashMap<String,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.
`List<Group>`	`search(long companyId, long parentGroupId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> 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.
`List<Group>`	`search(long companyId, String keywords, LinkedHashMap<String,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.
`List<Group>`	`search(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Group> obc)` Returns an ordered range of all the groups that match the keywords, optionally including the user's inherited organization groups and user groups.
`List<Group>`	`search(long companyId, String name, String description, LinkedHashMap<String,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.
`List<Group>`	`search(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> 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, String keywords, LinkedHashMap<String,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, String name, String description, LinkedHashMap<String,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, String keywords, LinkedHashMap<String,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, String name, String description, LinkedHashMap<String,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, String keywords, LinkedHashMap<String,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, String name, String description, LinkedHashMap<String,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, String keywords, LinkedHashMap<String,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, String name, String description, LinkedHashMap<String,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`	`setOrganizationGroups(long organizationId, long[] groupIds)`
`void`	`setRoleGroups(long roleId, long[] groupIds)`
`void`	`setUserGroupGroups(long userGroupId, long[] groupIds)`
`void`	`setUserGroups(long userId, long[] groupIds)`
`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, String[] assetTagNames)` Updates the group's asset replacing categories and tag names.
`Group`	`updateFriendlyURL(long groupId, 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, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean inheritContent, boolean active, ServiceContext serviceContext)`
`Group`	`updateGroup(long groupId, long parentGroupId, String name, String description, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean inheritContent, boolean active, ServiceContext serviceContext)` Deprecated. As of Wilberforce (7.0.x), replaced by `updateGroup(long, long, Map, Map, int, boolean, int, String, boolean, boolean, ServiceContext)`
`Group`	`updateGroup(long groupId, 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.
`void`	`validateRemote(long groupId, String remoteAddress, int remotePort, String remotePathContext, boolean secureConnection, long remoteGroupId)`

Methods inherited from class 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)
```
    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
  - addGroup
```
public Group addGroup(long userId,
                      long parentGroupId,
                      String className,
                      long classPK,
                      long liveGroupId,
                      Map<Locale,String> nameMap,
                      Map<Locale,String> descriptionMap,
                      int type,
                      boolean manualMembership,
                      int membershipRestriction,
                      String friendlyURL,
                      boolean site,
                      boolean inheritContent,
                      boolean active,
                      ServiceContext serviceContext)
               throws PortalException
```
    Specified by:
    
    addGroup in interface GroupLocalService
    
    Throws:
    
    PortalException
  - addGroup
```
public Group addGroup(long userId,
                      long parentGroupId,
                      String className,
                      long classPK,
                      long liveGroupId,
                      Map<Locale,String> nameMap,
                      Map<Locale,String> descriptionMap,
                      int type,
                      boolean manualMembership,
                      int membershipRestriction,
                      String friendlyURL,
                      boolean site,
                      boolean active,
                      ServiceContext serviceContext)
               throws PortalException
```
    Specified by:
    
    addGroup in interface GroupLocalService
    
    Throws:
    
    PortalException
  - addGroup
```
@Deprecated
public Group addGroup(long userId,
                                  long parentGroupId,
                                  String className,
                                  long classPK,
                                  long liveGroupId,
                                  String name,
                                  String description,
                                  int type,
                                  boolean manualMembership,
                                  int membershipRestriction,
                                  String friendlyURL,
                                  boolean site,
                                  boolean active,
                                  ServiceContext serviceContext)
                           throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), replaced by addGroup(long, long, String, long, long, Map, Map, 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
    
    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.
    
    manualMembership - whether manual membership is allowed for the group
    
    membershipRestriction - the group's membership restriction. 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 portal exception occured
  - addOrganizationGroup
```
public void addOrganizationGroup(long organizationId,
                                 Group group)
```
    Specified by:
    
    addOrganizationGroup in interface GroupLocalService
  - addOrganizationGroup
```
public void addOrganizationGroup(long organizationId,
                                 long groupId)
```
    Specified by:
    
    addOrganizationGroup in interface GroupLocalService
  - addOrganizationGroups
```
public void addOrganizationGroups(long organizationId,
                                  List<Group> groups)
```
    Specified by:
    
    addOrganizationGroups in interface GroupLocalService
  - addOrganizationGroups
```
public void addOrganizationGroups(long organizationId,
                                  long[] groupIds)
```
    Specified by:
    
    addOrganizationGroups in interface GroupLocalService
  - addRoleGroup
```
public void addRoleGroup(long roleId,
                         Group group)
```
    Specified by:
    
    addRoleGroup in interface GroupLocalService
  - addRoleGroup
```
public void addRoleGroup(long roleId,
                         long groupId)
```
    Specified by:
    
    addRoleGroup in interface GroupLocalService
  - addRoleGroups
```
public void addRoleGroups(long roleId,
                          List<Group> groups)
```
    Specified by:
    
    addRoleGroups in interface GroupLocalService
  - addRoleGroups
```
public void addRoleGroups(long roleId,
                          long[] groupIds)
```
    Specified by:
    
    addRoleGroups in interface GroupLocalService
  - addUserGroup
```
public void addUserGroup(long userId,
                         Group group)
```
    Specified by:
    
    addUserGroup in interface GroupLocalService
  - addUserGroup
```
public void addUserGroup(long userId,
                         long groupId)
```
    Specified by:
    
    addUserGroup in interface GroupLocalService
  - addUserGroupGroup
```
public void addUserGroupGroup(long userGroupId,
                              Group group)
```
    Specified by:
    
    addUserGroupGroup in interface GroupLocalService
  - addUserGroupGroup
```
public void addUserGroupGroup(long userGroupId,
                              long groupId)
```
    Specified by:
    
    addUserGroupGroup in interface GroupLocalService
  - addUserGroupGroups
```
public void addUserGroupGroups(long userGroupId,
                               List<Group> groups)
```
    Specified by:
    
    addUserGroupGroups in interface GroupLocalService
  - addUserGroupGroups
```
public void addUserGroupGroups(long userGroupId,
                               long[] groupIds)
```
    Specified by:
    
    addUserGroupGroups in interface GroupLocalService
  - addUserGroups
```
public void addUserGroups(long userId,
                          List<Group> groups)
```
    Specified by:
    
    addUserGroups in interface GroupLocalService
  - addUserGroups
```
public void addUserGroups(long userId,
                          long[] groupIds)
```
    Specified by:
    
    addUserGroups in interface GroupLocalService
  - checkCompanyGroup
```
public void checkCompanyGroup(long companyId)
                       throws PortalException
```
    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 portal exception occurred
  - checkScopeGroup
```
public Group checkScopeGroup(Layout layout,
                             long userId)
                      throws PortalException
```
    Specified by:
    
    checkScopeGroup in interface GroupLocalService
    
    Throws:
    
    PortalException
  - checkSystemGroups
```
public void checkSystemGroups(long companyId)
                       throws PortalException
```
    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 portal exception occurred
  - clearOrganizationGroups
```
public void clearOrganizationGroups(long organizationId)
```
    Specified by:
    
    clearOrganizationGroups in interface GroupLocalService
  - clearRoleGroups
```
public void clearRoleGroups(long roleId)
```
    Specified by:
    
    clearRoleGroups in interface GroupLocalService
  - clearUserGroupGroups
```
public void clearUserGroupGroups(long userGroupId)
```
    Specified by:
    
    clearUserGroupGroups in interface GroupLocalService
  - clearUserGroups
```
public void clearUserGroups(long userId)
```
    Specified by:
    
    clearUserGroups in interface GroupLocalService
  - 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(Group group)
                  throws PortalException
```
    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
  - deleteGroup
```
public Group deleteGroup(long groupId)
                  throws PortalException
```
    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
  - deleteOrganizationGroup
```
public void deleteOrganizationGroup(long organizationId,
                                    Group group)
```
    Specified by:
    
    deleteOrganizationGroup in interface GroupLocalService
  - deleteOrganizationGroup
```
public void deleteOrganizationGroup(long organizationId,
                                    long groupId)
```
    Specified by:
    
    deleteOrganizationGroup in interface GroupLocalService
  - deleteOrganizationGroups
```
public void deleteOrganizationGroups(long organizationId,
                                     List<Group> groups)
```
    Specified by:
    
    deleteOrganizationGroups in interface GroupLocalService
  - deleteOrganizationGroups
```
public void deleteOrganizationGroups(long organizationId,
                                     long[] groupIds)
```
    Specified by:
    
    deleteOrganizationGroups in interface GroupLocalService
  - deletePersistedModel
```
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException
```
    Specified by:
    
    deletePersistedModel in interface GroupLocalService
    
    Specified by:
    
    deletePersistedModel in interface PersistedModelLocalService
    
    Throws:
    
    PortalException
  - deleteRoleGroup
```
public void deleteRoleGroup(long roleId,
                            Group group)
```
    Specified by:
    
    deleteRoleGroup in interface GroupLocalService
  - deleteRoleGroup
```
public void deleteRoleGroup(long roleId,
                            long groupId)
```
    Specified by:
    
    deleteRoleGroup in interface GroupLocalService
  - deleteRoleGroups
```
public void deleteRoleGroups(long roleId,
                             List<Group> groups)
```
    Specified by:
    
    deleteRoleGroups in interface GroupLocalService
  - deleteRoleGroups
```
public void deleteRoleGroups(long roleId,
                             long[] groupIds)
```
    Specified by:
    
    deleteRoleGroups in interface GroupLocalService
  - deleteUserGroup
```
public void deleteUserGroup(long userId,
                            Group group)
```
    Specified by:
    
    deleteUserGroup in interface GroupLocalService
  - deleteUserGroup
```
public void deleteUserGroup(long userId,
                            long groupId)
```
    Specified by:
    
    deleteUserGroup in interface GroupLocalService
  - deleteUserGroupGroup
```
public void deleteUserGroupGroup(long userGroupId,
                                 Group group)
```
    Specified by:
    
    deleteUserGroupGroup in interface GroupLocalService
  - deleteUserGroupGroup
```
public void deleteUserGroupGroup(long userGroupId,
                                 long groupId)
```
    Specified by:
    
    deleteUserGroupGroup in interface GroupLocalService
  - deleteUserGroupGroups
```
public void deleteUserGroupGroups(long userGroupId,
                                  List<Group> groups)
```
    Specified by:
    
    deleteUserGroupGroups in interface GroupLocalService
  - deleteUserGroupGroups
```
public void deleteUserGroupGroups(long userGroupId,
                                  long[] groupIds)
```
    Specified by:
    
    deleteUserGroupGroups in interface GroupLocalService
  - deleteUserGroups
```
public void deleteUserGroups(long userId,
                             List<Group> groups)
```
    Specified by:
    
    deleteUserGroups in interface GroupLocalService
  - deleteUserGroups
```
public void deleteUserGroups(long userId,
                             long[] groupIds)
```
    Specified by:
    
    deleteUserGroups in interface GroupLocalService
  - disableStaging
```
public void disableStaging(long groupId)
                    throws PortalException
```
    Specified by:
    
    disableStaging in interface GroupLocalService
    
    Throws:
    
    PortalException
  - dynamicQuery
```
public DynamicQuery dynamicQuery()
```
    Specified by:
    
    dynamicQuery in interface GroupLocalService
  - dynamicQuery
```
public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
```
    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
  - dynamicQuery
```
public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
```
    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
  - dynamicQuery
```
public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator<T> orderByComparator)
```
    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
  - dynamicQueryCount
```
public long dynamicQueryCount(DynamicQuery dynamicQuery)
```
    Returns the number of rows matching the dynamic query.
    
    Specified by:
    
    dynamicQueryCount in interface GroupLocalService
    
    Parameters:
    
    dynamicQuery - the dynamic query
    
    Returns:
    
    the number of rows matching the dynamic query
  - dynamicQueryCount
```
public long dynamicQueryCount(DynamicQuery dynamicQuery,
                              Projection projection)
```
    Returns the number of rows matching 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 matching the dynamic query
  - enableStaging
```
public void enableStaging(long groupId)
                   throws PortalException
```
    Specified by:
    
    enableStaging in interface GroupLocalService
    
    Throws:
    
    PortalException
  - fetchCompanyGroup
```
public Group fetchCompanyGroup(long companyId)
```
    Returns the company's group.
    
    Specified by:
    
    fetchCompanyGroup in interface GroupLocalService
    
    Parameters:
    
    companyId - the primary key of the company
    
    Returns:
    
    the company's group, or null if a matching group could not be found
  - fetchFriendlyURLGroup
```
public Group fetchFriendlyURLGroup(long companyId,
                                   String friendlyURL)
```
    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
  - fetchGroup
```
public Group fetchGroup(long groupId)
```
    Specified by:
    
    fetchGroup in interface GroupLocalService
  - fetchGroup
```
public Group fetchGroup(long companyId,
                        String groupKey)
```
    Returns the group with the matching group key 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
    
    groupKey - the group key
    
    Returns:
    
    the group with the group key and associated company, or null if a matching group could not be found
  - fetchGroupByUuidAndCompanyId
```
public Group fetchGroupByUuidAndCompanyId(String uuid,
                                          long companyId)
```
    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
  - fetchStagingGroup
```
public Group fetchStagingGroup(long liveGroupId)
```
    Specified by:
    
    fetchStagingGroup in interface GroupLocalService
  - fetchUserGroup
```
public Group fetchUserGroup(long companyId,
                            long userId)
```
    Specified by:
    
    fetchUserGroup in interface GroupLocalService
  - fetchUserPersonalSiteGroup
```
public Group fetchUserPersonalSiteGroup(long companyId)
                                 throws PortalException
```
    Returns the default user's personal site group.
    
    Specified by:
    
    fetchUserPersonalSiteGroup in interface GroupLocalService
    
    Parameters:
    
    companyId - the primary key of the company
    
    Returns:
    
    the default user's personal site group, or null if a matching group could not be found
    
    Throws:
    
    PortalException - if a portal exception occurred
  - getActionableDynamicQuery
```
public ActionableDynamicQuery getActionableDynamicQuery()
```
    Specified by:
    
    getActionableDynamicQuery in interface GroupLocalService
  - getActiveGroupIds
```
public List<Long> getActiveGroupIds(long userId)
```
    Specified by:
    
    getActiveGroupIds in interface GroupLocalService
  - getActiveGroups
```
public List<Group> getActiveGroups(long companyId,
                                   boolean active)
```
    Returns all the active or inactive groups associated with the company.
    
    Specified by:
    
    getActiveGroups in interface GroupLocalService
    
    Parameters:
    
    companyId - the primary key of the company
    
    active - whether to return only active groups or only inactive groups
    
    Returns:
    
    the active or inactive groups
  - getActiveGroups
```
public List<Group> getActiveGroups(long companyId,
                                   boolean site,
                                   boolean active,
                                   int start,
                                   int end,
                                   OrderByComparator<Group> obc)
```
    Returns the active or inactive groups associated with the company and, optionally, the main site.
    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:
    
    getActiveGroups in interface GroupLocalService
    
    Parameters:
    
    companyId - the primary key of the company
    
    site - whether the group is associated with a main site
    
    active - whether to return only active groups or only inactive 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)
    
    obc - the comparator to order the groups (optionally null)
    
    Returns:
    
    the active or inactive groups
  - getActiveGroups
```
public List<Group> getActiveGroups(long companyId,
                                   boolean active,
                                   int start,
                                   int end,
                                   OrderByComparator<Group> obc)
```
    Returns the active or inactive 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:
    
    getActiveGroups in interface GroupLocalService
    
    Parameters:
    
    companyId - the primary key of the company
    
    active - whether to return only active groups or only inactive 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)
    
    obc - the comparator to order the groups (optionally null)
    
    Returns:
    
    the active or inactive groups
  - getActiveGroupsCount
```
public int getActiveGroupsCount(long companyId,
                                boolean active)
```
    Returns the number of active or inactive groups associated with the company.
    
    Specified by:
    
    getActiveGroupsCount in interface GroupLocalService
    
    Parameters:
    
    companyId - the primary key of the company
    
    active - whether to count only active groups or only inactive groups
    
    Returns:
    
    the number of active or inactive groups
  - getActiveGroupsCount
```
public int getActiveGroupsCount(long companyId,
                                boolean active,
                                boolean site)
```
    Returns the number of active or inactive groups associated with the company.
    
    Specified by:
    
    getActiveGroupsCount in interface GroupLocalService
    
    Parameters:
    
    companyId - the primary key of the company
    
    active - whether to count only active groups or only inactive groups
    
    site - whether the group is to be associated with a main site
    
    Returns:
    
    the number of active or inactive groups
  - getCompanyGroup
```
public Group getCompanyGroup(long companyId)
                      throws PortalException
```
    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 portal exception occurred
  - getCompanyGroups
```
public List<Group> getCompanyGroups(long companyId,
                                    int start,
                                    int end)
```
    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
  - getCompanyGroupsCount
```
public int getCompanyGroupsCount(long companyId)
```
    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
  - getFriendlyURLGroup
```
public Group getFriendlyURLGroup(long companyId,
                                 String friendlyURL)
                          throws PortalException
```
    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 portal exception occurred
  - getGroup
```
public Group getGroup(long groupId)
               throws PortalException
```
    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
  - getGroup
```
public Group getGroup(long companyId,
                      String groupKey)
               throws PortalException
```
    Returns the group with the matching group key.
    
    Specified by:
    
    getGroup in interface GroupLocalService
    
    Parameters:
    
    companyId - the primary key of the company
    
    groupKey - the group key
    
    Returns:
    
    the group with the group key
    
    Throws:
    
    PortalException - if a portal exception occurred
  - getGroupByUuidAndCompanyId
```
public Group getGroupByUuidAndCompanyId(String uuid,
                                        long companyId)
                                 throws PortalException
```
    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
  - getGroupDescriptiveName
```
@Deprecated
public String getGroupDescriptiveName(Group group,
                                                  Locale locale)
                                           throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), replaced by Group#getDescriptiveName(Locale)
    
    Specified by:
    
    getGroupDescriptiveName in interface GroupLocalService
    
    Throws:
    
    PortalException
  - getGroupDescriptiveName
```
@Deprecated
public String getGroupDescriptiveName(long groupId,
                                                  Locale locale)
                                           throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), replaced by Group#getDescriptiveName(Locale)
    
    Specified by:
    
    getGroupDescriptiveName in interface GroupLocalService
    
    Throws:
    
    PortalException
  - getGroups
```
public List<Group> getGroups(int start,
                             int end)
```
    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
  - getGroups
```
public List<Group> getGroups(long companyId,
                             long parentGroupId,
                             boolean site)
```
    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
  - getGroups
```
public List<Group> getGroups(long companyId,
                             long parentGroupId,
                             boolean site,
                             boolean inheritContent)
```
    Specified by:
    
    getGroups in interface GroupLocalService
  - getGroups
```
public List<Group> getGroups(long companyId,
                             long parentGroupId,
                             boolean site,
                             int start,
                             int end)
```
    Specified by:
    
    getGroups in interface GroupLocalService
  - getGroups
```
public List<Group> getGroups(long companyId,
                             long parentGroupId,
                             String name,
                             boolean site,
                             int start,
                             int end)
```
    Specified by:
    
    getGroups in interface GroupLocalService
  - getGroups
```
public List<Group> getGroups(long companyId,
                             String treePath,
                             boolean site)
```
    Specified by:
    
    getGroups in interface GroupLocalService
  - getGroups
```
public List<Group> getGroups(long companyId,
                             String className,
                             long parentGroupId)
```
    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
  - getGroups
```
public List<Group> getGroups(long companyId,
                             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.
    
    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
  - getGroups
```
public List<Group> getGroups(long[] groupIds)
                      throws PortalException
```
    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 a portal exception occurred
  - getGroupsCount
```
public int getGroupsCount()
```
    Returns the number of groups.
    
    Specified by:
    
    getGroupsCount in interface GroupLocalService
    
    Returns:
    
    the number of groups
  - getGroupsCount
```
public int getGroupsCount(long companyId,
                          long parentGroupId,
                          boolean site)
```
    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
  - getGroupsCount
```
public int getGroupsCount(long companyId,
                          long parentGroupId,
                          String name,
                          boolean site)
```
    Specified by:
    
    getGroupsCount in interface GroupLocalService
  - getGroupsCount
```
public int getGroupsCount(long companyId,
                          String className,
                          long parentGroupId)
```
    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
  - getIndexableActionableDynamicQuery
```
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
```
    Specified by:
    
    getIndexableActionableDynamicQuery in interface GroupLocalService
  - getLayoutGroup
```
public Group getLayoutGroup(long companyId,
                            long plid)
                     throws PortalException
```
    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 portal exception occurred
  - getLayoutPrototypeGroup
```
public Group getLayoutPrototypeGroup(long companyId,
                                     long layoutPrototypeId)
                              throws PortalException
```
    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 portal exception occurred
  - getLayoutSetPrototypeGroup
```
public Group getLayoutSetPrototypeGroup(long companyId,
                                        long layoutSetPrototypeId)
                                 throws PortalException
```
    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 portal exception occurred
  - getLayoutsGroups
```
public List<Group> getLayoutsGroups(long companyId,
                                    long parentGroupId,
                                    boolean site,
                                    boolean active,
                                    int start,
                                    int end,
                                    OrderByComparator<Group> obc)
```
    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
    
    active - whether to return only active groups, or only inactive 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)
    
    obc - the comparator to order the groups (optionally null)
    
    Returns:
    
    the range of matching groups ordered by comparator obc
  - getLayoutsGroups
```
public List<Group> getLayoutsGroups(long companyId,
                                    long parentGroupId,
                                    boolean site,
                                    int start,
                                    int end,
                                    OrderByComparator<Group> obc)
```
    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)
    
    obc - the comparator to order the groups (optionally null)
    
    Returns:
    
    the range of matching groups ordered by comparator obc
  - getLayoutsGroupsCount
```
public 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
    
    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
  - getLayoutsGroupsCount
```
public int getLayoutsGroupsCount(long companyId,
                                 long parentGroupId,
                                 boolean site,
                                 boolean active)
```
    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
    
    active - whether to return only active groups, or only inactive groups
    
    Returns:
    
    the number of matching groups
  - getLiveGroups
```
public List<Group> getLiveGroups()
```
    Returns all live groups.
    
    Specified by:
    
    getLiveGroups in interface GroupLocalService
    
    Returns:
    
    all live groups
  - getNoLayoutsGroups
```
public List<Group> getNoLayoutsGroups(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.
    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
  - getNullFriendlyURLGroups
```
@Deprecated
public List<Group> getNullFriendlyURLGroups()
```
    Deprecated. As of Judson (7.1.x), with no direct replacement
    
    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
  - getOrganizationGroup
```
public Group getOrganizationGroup(long companyId,
                                  long organizationId)
                           throws PortalException
```
    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 portal exception occurred
  - getOrganizationGroups
```
public List<Group> getOrganizationGroups(long organizationId)
```
    Specified by:
    
    getOrganizationGroups in interface GroupLocalService
  - getOrganizationGroups
```
public List<Group> getOrganizationGroups(long organizationId,
                                         int start,
                                         int end)
```
    Specified by:
    
    getOrganizationGroups in interface GroupLocalService
  - getOrganizationGroups
```
public List<Group> getOrganizationGroups(long organizationId,
                                         int start,
                                         int end,
                                         OrderByComparator<Group> orderByComparator)
```
    Specified by:
    
    getOrganizationGroups in interface GroupLocalService
  - getOrganizationGroupsCount
```
public int getOrganizationGroupsCount(long organizationId)
```
    Specified by:
    
    getOrganizationGroupsCount in interface GroupLocalService
  - getOrganizationPrimaryKeys
```
public long[] getOrganizationPrimaryKeys(long groupId)
```
    Returns the organizationIds of the organizations associated with the group.
    
    Specified by:
    
    getOrganizationPrimaryKeys in interface GroupLocalService
    
    Parameters:
    
    groupId - the groupId of the group
    
    Returns:
    
    long[] the organizationIds of organizations associated with the group
  - getOrganizationsGroups
```
public List<Group> getOrganizationsGroups(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 List<Group> getOrganizationsRelatedGroups(List<Organization> organizations)
```
    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
  - getOSGiServiceIdentifier
```
public String getOSGiServiceIdentifier()
```
    Returns the OSGi service identifier.
    
    Specified by:
    
    getOSGiServiceIdentifier in interface GroupLocalService
    
    Returns:
    
    the OSGi service identifier
  - getParentGroups
```
public List<Group> getParentGroups(long groupId)
                            throws PortalException
```
    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 portal exception occurred
  - getPersistedModel
```
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException
```
    Specified by:
    
    getPersistedModel in interface GroupLocalService
    
    Specified by:
    
    getPersistedModel in interface PersistedModelLocalService
    
    Throws:
    
    PortalException
  - getRoleGroups
```
public List<Group> getRoleGroups(long roleId)
```
    Specified by:
    
    getRoleGroups in interface GroupLocalService
  - getRoleGroups
```
public List<Group> getRoleGroups(long roleId,
                                 int start,
                                 int end)
```
    Specified by:
    
    getRoleGroups in interface GroupLocalService
  - getRoleGroups
```
public List<Group> getRoleGroups(long roleId,
                                 int start,
                                 int end,
                                 OrderByComparator<Group> orderByComparator)
```
    Specified by:
    
    getRoleGroups in interface GroupLocalService
  - getRoleGroupsCount
```
public int getRoleGroupsCount(long roleId)
```
    Specified by:
    
    getRoleGroupsCount in interface GroupLocalService
  - getRolePrimaryKeys
```
public long[] getRolePrimaryKeys(long groupId)
```
    Returns the roleIds of the roles associated with the group.
    
    Specified by:
    
    getRolePrimaryKeys in interface GroupLocalService
    
    Parameters:
    
    groupId - the groupId of the group
    
    Returns:
    
    long[] the roleIds of roles associated with the group
  - getStagedSites
```
public List<Group> getStagedSites()
```
    Specified by:
    
    getStagedSites in interface GroupLocalService
  - getStagingGroup
```
public Group getStagingGroup(long liveGroupId)
                      throws PortalException
```
    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 portal exception occurred
  - getUserGroup
```
public Group getUserGroup(long companyId,
                          long userId)
                   throws PortalException
```
    Returns the group directly 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 directly associated with the user
    
    Throws:
    
    PortalException - if a portal exception occurred
  - getUserGroupGroup
```
public Group getUserGroupGroup(long companyId,
                               long userGroupId)
                        throws PortalException
```
    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 portal exception occurred
  - getUserGroupGroups
```
public List<Group> getUserGroupGroups(long userGroupId)
```
    Specified by:
    
    getUserGroupGroups in interface GroupLocalService
  - getUserGroupGroups
```
public List<Group> getUserGroupGroups(long userGroupId,
                                      int start,
                                      int end)
```
    Specified by:
    
    getUserGroupGroups in interface GroupLocalService
  - getUserGroupGroups
```
public List<Group> getUserGroupGroups(long userGroupId,
                                      int start,
                                      int end,
                                      OrderByComparator<Group> orderByComparator)
```
    Specified by:
    
    getUserGroupGroups in interface GroupLocalService
  - getUserGroupGroupsCount
```
public int getUserGroupGroupsCount(long userGroupId)
```
    Specified by:
    
    getUserGroupGroupsCount in interface GroupLocalService
  - getUserGroupPrimaryKeys
```
public long[] getUserGroupPrimaryKeys(long groupId)
```
    Returns the userGroupIds of the user groups associated with the group.
    
    Specified by:
    
    getUserGroupPrimaryKeys in interface GroupLocalService
    
    Parameters:
    
    groupId - the groupId of the group
    
    Returns:
    
    long[] the userGroupIds of user groups associated with the group
  - getUserGroups
```
public List<Group> getUserGroups(long userId)
```
    Specified by:
    
    getUserGroups in interface GroupLocalService
  - getUserGroups
```
public List<Group> getUserGroups(long userId,
                                 boolean inherit)
                          throws PortalException
```
    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 portal exception occurred
  - getUserGroups
```
public List<Group> getUserGroups(long userId,
                                 boolean inherit,
                                 int start,
                                 int end)
                          throws PortalException
```
    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 portal exception occurred
  - getUserGroups
```
public List<Group> getUserGroups(long userId,
                                 int start,
                                 int end)
```
    Specified by:
    
    getUserGroups in interface GroupLocalService
  - getUserGroups
```
public List<Group> getUserGroups(long userId,
                                 int start,
                                 int end,
                                 OrderByComparator<Group> orderByComparator)
                          throws PortalException
```
    Specified by:
    
    getUserGroups in interface GroupLocalService
    
    Throws:
    
    PortalException
  - getUserGroupsCount
```
public int getUserGroupsCount(long userId)
```
    Specified by:
    
    getUserGroupsCount in interface GroupLocalService
  - getUserGroupsGroups
```
public List<Group> getUserGroupsGroups(List<UserGroup> userGroups)
                                throws PortalException
```
    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 a portal exception occurred
  - getUserGroupsRelatedGroups
```
public List<Group> getUserGroupsRelatedGroups(List<UserGroup> userGroups)
```
    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
  - getUserOrganizationsGroups
```
public List<Group> getUserOrganizationsGroups(long userId,
                                              int start,
                                              int end)
                                       throws PortalException
```
    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 portal exception occurred
  - getUserPersonalSiteGroup
```
public Group getUserPersonalSiteGroup(long companyId)
                               throws PortalException
```
    Returns the default user's personal site group.
    
    Specified by:
    
    getUserPersonalSiteGroup in interface GroupLocalService
    
    Parameters:
    
    companyId - the primary key of the company
    
    Returns:
    
    the default user's personal site group
    
    Throws:
    
    PortalException - if a portal exception occurred
  - getUserPrimaryKeys
```
public long[] getUserPrimaryKeys(long groupId)
```
    Returns the userIds of the users associated with the group.
    
    Specified by:
    
    getUserPrimaryKeys in interface GroupLocalService
    
    Parameters:
    
    groupId - the groupId of the group
    
    Returns:
    
    long[] the userIds of users associated with the group
  - getUserSitesGroups
```
public List<Group> getUserSitesGroups(long userId)
                               throws PortalException
```
    Specified by:
    
    getUserSitesGroups in interface GroupLocalService
    
    Throws:
    
    PortalException
  - getUserSitesGroups
```
public List<Group> getUserSitesGroups(long userId,
                                      boolean includeAdministrative)
                               throws PortalException
```
    Specified by:
    
    getUserSitesGroups in interface GroupLocalService
    
    Throws:
    
    PortalException
  - hasOrganizationGroup
```
public boolean hasOrganizationGroup(long organizationId,
                                    long groupId)
```
    Specified by:
    
    hasOrganizationGroup in interface GroupLocalService
  - hasOrganizationGroups
```
public boolean hasOrganizationGroups(long organizationId)
```
    Specified by:
    
    hasOrganizationGroups in interface GroupLocalService
  - hasRoleGroup
```
public boolean hasRoleGroup(long roleId,
                            long groupId)
```
    Specified by:
    
    hasRoleGroup in interface GroupLocalService
  - hasRoleGroups
```
public boolean hasRoleGroups(long roleId)
```
    Specified by:
    
    hasRoleGroups in interface GroupLocalService
  - hasStagingGroup
```
public boolean hasStagingGroup(long liveGroupId)
```
    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
  - hasUserGroup
```
public boolean hasUserGroup(long userId,
                            long groupId)
```
    Specified by:
    
    hasUserGroup in interface GroupLocalService
  - hasUserGroup
```
public 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.
    
    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
  - hasUserGroupGroup
```
public boolean hasUserGroupGroup(long userGroupId,
                                 long groupId)
```
    Specified by:
    
    hasUserGroupGroup in interface GroupLocalService
  - hasUserGroupGroups
```
public boolean hasUserGroupGroups(long userGroupId)
```
    Specified by:
    
    hasUserGroupGroups in interface GroupLocalService
  - hasUserGroups
```
public boolean hasUserGroups(long userId)
```
    Specified by:
    
    hasUserGroups in interface GroupLocalService
  - isLiveGroupActive
```
public boolean isLiveGroupActive(Group group)
```
    Specified by:
    
    isLiveGroupActive in interface GroupLocalService
  - loadFetchGroup
```
public Group loadFetchGroup(long companyId,
                            String groupKey)
```
    Returns the group with the matching group key 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
    
    groupKey - the group key
    
    Returns:
    
    the group with the group key and associated company, or null if a matching group could not be found
  - loadGetGroup
```
public Group loadGetGroup(long companyId,
                          String groupKey)
                   throws PortalException
```
    Returns the group with the matching group key.
    
    Specified by:
    
    loadGetGroup in interface GroupLocalService
    
    Parameters:
    
    companyId - the primary key of the company
    
    groupKey - the group key
    
    Returns:
    
    the group with the group key and associated company
    
    Throws:
    
    PortalException - if a portal exception occurred
  - rebuildTree
```
public void rebuildTree(long companyId)
                 throws PortalException
```
    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 portal exception occurred
  - search
```
public List<Group> search(long companyId,
                          LinkedHashMap<String,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. 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
  - search
```
public List<Group> search(long companyId,
                          long parentGroupId,
                          String keywords,
                          LinkedHashMap<String,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. 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
  - search
```
public List<Group> search(long companyId,
                          long parentGroupId,
                          String keywords,
                          LinkedHashMap<String,Object> params,
                          int start,
                          int end,
                          OrderByComparator<Group> 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. 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
  - search
```
public List<Group> search(long companyId,
                          long parentGroupId,
                          String name,
                          String description,
                          LinkedHashMap<String,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. 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
  - search
```
public List<Group> search(long companyId,
                          long parentGroupId,
                          String name,
                          String description,
                          LinkedHashMap<String,Object> params,
                          boolean andOperator,
                          int start,
                          int end,
                          OrderByComparator<Group> 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. 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
  - search
```
public List<Group> search(long companyId,
                          long[] classNameIds,
                          long parentGroupId,
                          String keywords,
                          LinkedHashMap<String,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. 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
  - search
```
public List<Group> search(long companyId,
                          long[] classNameIds,
                          long parentGroupId,
                          String keywords,
                          LinkedHashMap<String,Object> params,
                          int start,
                          int end,
                          OrderByComparator<Group> 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. 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
  - search
```
public List<Group> search(long companyId,
                          long[] classNameIds,
                          long parentGroupId,
                          String name,
                          String description,
                          LinkedHashMap<String,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. 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
  - search
```
public List<Group> search(long companyId,
                          long[] classNameIds,
                          long parentGroupId,
                          String name,
                          String description,
                          LinkedHashMap<String,Object> params,
                          boolean andOperator,
                          int start,
                          int end,
                          OrderByComparator<Group> 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. 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
  - search
```
public List<Group> search(long companyId,
                          long[] classNameIds,
                          String keywords,
                          LinkedHashMap<String,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. 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
  - search
```
public List<Group> search(long companyId,
                          long[] classNameIds,
                          String keywords,
                          LinkedHashMap<String,Object> params,
                          int start,
                          int end,
                          OrderByComparator<Group> 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. 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
  - search
```
public List<Group> search(long companyId,
                          long[] classNameIds,
                          String name,
                          String description,
                          LinkedHashMap<String,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. 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
  - search
```
public List<Group> search(long companyId,
                          long[] classNameIds,
                          String name,
                          String description,
                          LinkedHashMap<String,Object> params,
                          boolean andOperator,
                          int start,
                          int end,
                          OrderByComparator<Group> 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. 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
  - search
```
public List<Group> search(long companyId,
                          String keywords,
                          LinkedHashMap<String,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. 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
  - search
```
public List<Group> search(long companyId,
                          String keywords,
                          LinkedHashMap<String,Object> params,
                          int start,
                          int end,
                          OrderByComparator<Group> obc)
```
    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
  - search
```
public List<Group> search(long companyId,
                          String name,
                          String description,
                          LinkedHashMap<String,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. 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
  - search
```
public List<Group> search(long companyId,
                          String name,
                          String description,
                          LinkedHashMap<String,Object> params,
                          boolean andOperator,
                          int start,
                          int end,
                          OrderByComparator<Group> 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. 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
  - searchCount
```
public int searchCount(long companyId,
                       long parentGroupId,
                       String keywords,
                       LinkedHashMap<String,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. 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
  - searchCount
```
public int searchCount(long companyId,
                       long parentGroupId,
                       String name,
                       String description,
                       LinkedHashMap<String,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. 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
  - searchCount
```
public int searchCount(long companyId,
                       long[] classNameIds,
                       long parentGroupId,
                       String keywords,
                       LinkedHashMap<String,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. 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
  - searchCount
```
public int searchCount(long companyId,
                       long[] classNameIds,
                       long parentGroupId,
                       String name,
                       String description,
                       LinkedHashMap<String,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. 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
  - searchCount
```
public int searchCount(long companyId,
                       long[] classNameIds,
                       String keywords,
                       LinkedHashMap<String,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. 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
  - searchCount
```
public int searchCount(long companyId,
                       long[] classNameIds,
                       String name,
                       String description,
                       LinkedHashMap<String,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. 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
  - searchCount
```
public int searchCount(long companyId,
                       String keywords,
                       LinkedHashMap<String,Object> params)
```
    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
  - searchCount
```
public int searchCount(long companyId,
                       String name,
                       String description,
                       LinkedHashMap<String,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. 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
  - setOrganizationGroups
```
public void setOrganizationGroups(long organizationId,
                                  long[] groupIds)
```
    Specified by:
    
    setOrganizationGroups in interface GroupLocalService
  - setRoleGroups
```
public void setRoleGroups(long roleId,
                          long[] groupIds)
```
    Specified by:
    
    setRoleGroups in interface GroupLocalService
  - setUserGroupGroups
```
public void setUserGroupGroups(long userGroupId,
                               long[] groupIds)
```
    Specified by:
    
    setUserGroupGroups in interface GroupLocalService
  - setUserGroups
```
public void setUserGroups(long userId,
                          long[] groupIds)
```
    Specified by:
    
    setUserGroups in interface GroupLocalService
  - unsetRoleGroups
```
public void unsetRoleGroups(long roleId,
                            long[] groupIds)
```
    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
  - unsetUserGroups
```
public void unsetUserGroups(long userId,
                            long[] groupIds)
```
    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
  - updateAsset
```
public void updateAsset(long userId,
                        Group group,
                        long[] assetCategoryIds,
                        String[] assetTagNames)
                 throws PortalException
```
    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 portal exception occurred
  - updateFriendlyURL
```
public Group updateFriendlyURL(long groupId,
                               String friendlyURL)
                        throws PortalException
```
    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 portal exception occurred
  - updateGroup
```
public Group updateGroup(Group group)
```
    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
  - updateGroup
```
public Group updateGroup(long groupId,
                         long parentGroupId,
                         Map<Locale,String> nameMap,
                         Map<Locale,String> descriptionMap,
                         int type,
                         boolean manualMembership,
                         int membershipRestriction,
                         String friendlyURL,
                         boolean inheritContent,
                         boolean active,
                         ServiceContext serviceContext)
                  throws PortalException
```
    Specified by:
    
    updateGroup in interface GroupLocalService
    
    Throws:
    
    PortalException
  - updateGroup
```
@Deprecated
public Group updateGroup(long groupId,
                                     long parentGroupId,
                                     String name,
                                     String description,
                                     int type,
                                     boolean manualMembership,
                                     int membershipRestriction,
                                     String friendlyURL,
                                     boolean inheritContent,
                                     boolean active,
                                     ServiceContext serviceContext)
                              throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), replaced by updateGroup(long, long, Map, Map, int, boolean, int, String, boolean, boolean, ServiceContext)
    
    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 name's key
    
    description - the group's new description (optionally null)
    
    type - the group's new type. For more information see GroupConstants.
    
    manualMembership - whether manual membership is allowed for the group
    
    membershipRestriction - the group's membership restriction. For more information see GroupConstants.
    
    friendlyURL - the group's new friendlyURL (optionally null)
    
    inheritContent - whether to inherit content from the parent group
    
    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 portal exception occurred
  - updateGroup
```
public Group updateGroup(long groupId,
                         String typeSettings)
                  throws PortalException
```
    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 portal exception occurred
  - updateSite
```
public Group updateSite(long groupId,
                        boolean site)
                 throws PortalException
```
    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 portal exception occurred
  - validateRemote
```
public void validateRemote(long groupId,
                           String remoteAddress,
                           int remotePort,
                           String remotePathContext,
                           boolean secureConnection,
                           long remoteGroupId)
                    throws PortalException
```
    Specified by:
    
    validateRemote in interface GroupLocalService
    
    Throws:
    
    PortalException
  - 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 Object

Constructor Detail

GroupLocalServiceWrapper

Method Detail

addGroup

addGroup

addGroup

addGroup

addOrganizationGroup

addOrganizationGroup

addOrganizationGroups

addOrganizationGroups

addRoleGroup

addRoleGroup

addRoleGroups

addRoleGroups

addUserGroup

addUserGroup

addUserGroupGroup

addUserGroupGroup

addUserGroupGroups

addUserGroupGroups

addUserGroups

addUserGroups

checkCompanyGroup

checkScopeGroup

checkSystemGroups

clearOrganizationGroups

clearRoleGroups

clearUserGroupGroups

clearUserGroups

createGroup

deleteGroup

deleteGroup

deleteOrganizationGroup

deleteOrganizationGroup

deleteOrganizationGroups

deleteOrganizationGroups

deletePersistedModel

deleteRoleGroup

deleteRoleGroup

deleteRoleGroups

deleteRoleGroups

deleteUserGroup

deleteUserGroup

deleteUserGroupGroup

deleteUserGroupGroup

deleteUserGroupGroups

deleteUserGroupGroups

deleteUserGroups

deleteUserGroups

disableStaging

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQueryCount

dynamicQueryCount

enableStaging

fetchCompanyGroup

fetchFriendlyURLGroup

fetchGroup

fetchGroup

fetchGroupByUuidAndCompanyId

fetchStagingGroup

fetchUserGroup

fetchUserPersonalSiteGroup

getActionableDynamicQuery

getActiveGroupIds

getActiveGroups

getActiveGroups

getActiveGroups

getActiveGroupsCount

getActiveGroupsCount

getCompanyGroup

getCompanyGroups

getCompanyGroupsCount