GroupLocalServiceImpl

java.lang.Object
- com.liferay.portal.kernel.service.BaseLocalServiceImpl
- - com.liferay.portal.service.base.GroupLocalServiceBaseImpl
  - - com.liferay.portal.service.impl.GroupLocalServiceImpl

All Implemented Interfaces:

com.liferay.portal.kernel.module.framework.service.IdentifiableOSGiService, com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.GroupLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
```
public class GroupLocalServiceImpl
extends GroupLocalServiceBaseImpl
```
Provides the local service for accessing, adding, deleting, and updating groups. Groups are mostly used in Liferay as a resource container for permissioning and content scoping purposes.
Groups are also the entity to which LayoutSets are generally associated. Since LayoutSets are the parent entities of Layouts (i.e. pages), no entity can have associated pages without also having an associated Group. This relationship can be depicted as ... Layout -> LayoutSet -> Group[type] -> [Entity]. Note, the Entity part is optional.

Group has a "type" definition that is typically identified by two fields of the entity - String className, and int type.

The className field helps create the group's association with other entities (e.g. Organization, User, Company, UserGroup, etc.). The value of className is the full name of the entity's class and the primary key of the associated entity instance. A site has className="Group" and has no associated entity.

The type field helps distinguish between a group used strictly for scoping and a group that also has pages (in which case the type is SITE). For a list of types, see GroupConstants.

Here is a listing of how Group is related to some portal entities:
- Site is a Group with className="Group"
- Company has one Group (this is the global scope, but never has pages)
- User has one Group (pages are optional based on the behavior configuration for personal pages)
- Layout Template (LayoutPrototype) has 1 Group which uses only one of its two LayoutSets to store a single page which can later be used to derive a single page in any Site
- Site Template (LayoutSetPrototype) has 1 Group which uses only one of its two LayoutSets to store many pages which can later be used to derive entire Sites or pulled into an existing Site
- Organization has one Group, but can also be associated to a Site at any point in its life cycle in order to support having pages
- UserGroup has one Group that can have pages in both of the group's LayoutSets which are later inherited by users assigned to the UserGroup
Author:

Brian Wing Shun Chan, Alexander Chow, Bruno Farache, Wesley Gong

See Also:

GroupImpl

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ORGANIZATION_NAME_SUFFIX`
`static java.lang.String`	`ORGANIZATION_STAGING_SUFFIX`
`protected java.io.File`	`publicLARFile`

Fields inherited from class com.liferay.portal.service.base.GroupLocalServiceBaseImpl
accountLocalService, accountPersistence, assetCategoryFinder, assetCategoryLocalService, assetCategoryPersistence, assetEntryFinder, assetEntryLocalService, assetEntryPersistence, assetTagFinder, assetTagLocalService, assetTagPersistence, assetVocabularyFinder, assetVocabularyLocalService, assetVocabularyPersistence, classNameLocalService, classNamePersistence, companyLocalService, companyPersistence, counterLocalService, dlAppLocalService, expandoRowLocalService, expandoRowPersistence, exportImportConfigurationFinder, exportImportConfigurationLocalService, exportImportConfigurationPersistence, exportImportLocalService, groupFinder, groupLocalService, groupPersistence, layoutFinder, layoutLocalService, layoutPersistence, layoutSetBranchLocalService, layoutSetBranchPersistence, layoutSetLocalService, layoutSetPersistence, membershipRequestLocalService, membershipRequestPersistence, organizationFinder, organizationLocalService, organizationPersistence, persistedModelLocalServiceRegistry, portletLocalService, portletPersistence, portletPreferencesFinder, portletPreferencesLocalService, portletPreferencesPersistence, resourceActionLocalService, resourceActionPersistence, resourceLocalService, resourcePermissionFinder, resourcePermissionLocalService, resourcePermissionPersistence, roleFinder, roleLocalService, rolePersistence, socialActivityFinder, socialActivityLocalService, socialActivityPersistence, socialActivitySettingLocalService, socialActivitySettingPersistence, socialRequestLocalService, socialRequestPersistence, stagingLocalService, systemEventLocalService, systemEventPersistence, teamFinder, teamLocalService, teamPersistence, userFinder, userGroupFinder, userGroupGroupRoleFinder, userGroupGroupRoleLocalService, userGroupGroupRolePersistence, userGroupLocalService, userGroupPersistence, userGroupRoleFinder, userGroupRoleLocalService, userGroupRolePersistence, userLocalService, userPersistence, workflowDefinitionLinkLocalService, workflowDefinitionLinkPersistence

Constructor Summary

Constructors
Constructor and Description

GroupLocalServiceImpl()
Constructs a group local service.

Constructors
Constructor and Description
`GroupLocalServiceImpl()` Constructs a group local service.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`addControlPanelLayouts(com.liferay.portal.kernel.model.Group group)`
`protected void`	`addDefaultGuestPublicLayoutByProperties(com.liferay.portal.kernel.model.Group group)`
`protected void`	`addDefaultGuestPublicLayouts(com.liferay.portal.kernel.model.Group group)`
`protected void`	`addDefaultGuestPublicLayoutsByLAR(com.liferay.portal.kernel.model.Group group, java.io.File larFile)`
`com.liferay.portal.kernel.model.Group`	`addGroup(long userId, long parentGroupId, java.lang.String className, long classPK, long liveGroupId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, java.lang.String friendlyURL, boolean site, boolean inheritContent, boolean active, com.liferay.portal.kernel.service.ServiceContext serviceContext)`
`com.liferay.portal.kernel.model.Group`	`addGroup(long userId, long parentGroupId, java.lang.String className, long classPK, long liveGroupId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, java.lang.String friendlyURL, boolean site, boolean active, com.liferay.portal.kernel.service.ServiceContext serviceContext)`
`com.liferay.portal.kernel.model.Group`	`addGroup(long userId, long parentGroupId, java.lang.String className, long classPK, long liveGroupId, java.lang.String name, java.lang.String description, int type, boolean manualMembership, int membershipRestriction, java.lang.String friendlyURL, boolean site, boolean active, com.liferay.portal.kernel.service.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, com.liferay.portal.kernel.model.Group group)` Adds the group to the organization.
`void`	`addOrganizationGroup(long organizationId, long groupId)` Adds the group to the organization.
`void`	`addOrganizationGroups(long organizationId, java.util.List<com.liferay.portal.kernel.model.Group> groups)` Adds the groups to the organization.
`void`	`addOrganizationGroups(long organizationId, long[] groupIds)` Adds the groups to the organization.
`protected void`	`addPortletDefaultData(com.liferay.portal.kernel.model.Group group)`
`void`	`addUserGroupGroup(long userGroupId, com.liferay.portal.kernel.model.Group group)` Adds the group to the user group.
`void`	`addUserGroupGroup(long userGroupId, long groupId)` Adds the group to the user group.
`void`	`addUserGroupGroups(long userGroupId, java.util.List<com.liferay.portal.kernel.model.Group> groups)` Adds the groups to the user group.
`void`	`addUserGroupGroups(long userGroupId, long[] groupIds)` Adds the groups to the user group.
`void`	`checkCompanyGroup(long companyId)` Adds a company group if it does not exist.
`com.liferay.portal.kernel.model.Group`	`checkScopeGroup(com.liferay.portal.kernel.model.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)` Clears the groups from the organization.
`void`	`clearUserGroupGroups(long userGroupId)` Clears the groups from the user group.
`com.liferay.portal.kernel.model.Group`	`deleteGroup(com.liferay.portal.kernel.model.Group group)` Deletes the group and its associated data.
`com.liferay.portal.kernel.model.Group`	`deleteGroup(long groupId)` Deletes the group and its associated data.
`void`	`deleteOrganizationGroup(long organizationId, com.liferay.portal.kernel.model.Group group)` Deletes the group from the organization.
`void`	`deleteOrganizationGroup(long organizationId, long groupId)` Deletes the group from the organization.
`void`	`deleteOrganizationGroups(long organizationId, java.util.List<com.liferay.portal.kernel.model.Group> groups)` Deletes the groups from the organization.
`void`	`deleteOrganizationGroups(long organizationId, long[] groupIds)` Deletes the groups from the organization.
`protected void`	`deletePortletData(com.liferay.portal.kernel.model.Group group)`
`void`	`deleteUserGroupGroup(long userGroupId, com.liferay.portal.kernel.model.Group group)` Deletes the group from the user group.
`void`	`deleteUserGroupGroup(long userGroupId, long groupId)` Deletes the group from the user group.
`void`	`deleteUserGroupGroups(long userGroupId, java.util.List<com.liferay.portal.kernel.model.Group> groups)` Deletes the groups from the user group.
`void`	`deleteUserGroupGroups(long userGroupId, long[] groupIds)` Deletes the groups from the user group.
`void`	`disableStaging(long groupId)`
`protected java.util.Collection<com.liferay.portal.kernel.model.Group>`	`doSearch(long companyId, long[] classNameIds, long parentGroupId, java.lang.String[] names, java.lang.String[] descriptions, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator)`
`void`	`enableStaging(long groupId)`
`com.liferay.portal.kernel.model.Group`	`fetchCompanyGroup(long companyId)` Returns the company's group.
`com.liferay.portal.kernel.model.Group`	`fetchFriendlyURLGroup(long companyId, java.lang.String friendlyURL)` Returns the group with the matching friendly URL.
`com.liferay.portal.kernel.model.Group`	`fetchGroup(long groupId)`
`com.liferay.portal.kernel.model.Group`	`fetchGroup(long companyId, java.lang.String groupKey)` Returns the group with the matching group key by first searching the system groups and then using the finder cache.
`com.liferay.portal.kernel.model.Group`	`fetchStagingGroup(long liveGroupId)`
`com.liferay.portal.kernel.model.Group`	`fetchUserGroup(long companyId, long userId)`
`com.liferay.portal.kernel.model.Group`	`fetchUserPersonalSiteGroup(long companyId)` Returns the default user's personal site group.
`java.util.List<java.lang.Long>`	`getActiveGroupIds(long userId)`
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getActiveGroups(long companyId, boolean active)` Returns all the active or inactive groups associated with the company.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getActiveGroups(long companyId, boolean site, boolean active, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Group> obc)` Returns the active or inactive groups associated with the company.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getActiveGroups(long companyId, boolean active, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.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.
`protected long[]`	`getClassNameIds()`
`com.liferay.portal.kernel.model.Group`	`getCompanyGroup(long companyId)` Returns the company group.
`java.util.List<com.liferay.portal.kernel.model.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.
`protected java.lang.String`	`getFriendlyURL(long companyId, long groupId, long classNameId, long classPK, java.lang.String friendlyName, java.lang.String friendlyURL)`
`protected java.lang.String`	`getFriendlyURL(java.lang.String friendlyURL)`
`com.liferay.portal.kernel.model.Group`	`getFriendlyURLGroup(long companyId, java.lang.String friendlyURL)` Returns the group with the matching friendly URL.
`com.liferay.portal.kernel.model.Group`	`getGroup(long groupId)` Returns the group with the matching primary key.
`com.liferay.portal.kernel.model.Group`	`getGroup(long companyId, java.lang.String groupKey)` Returns the group with the matching group key.
`java.lang.String`	`getGroupDescriptiveName(com.liferay.portal.kernel.model.Group group, java.util.Locale locale)` Deprecated. As of Wilberforce (7.0.x), replaced by `Group.getDescriptiveName(Locale)`
`java.lang.String`	`getGroupDescriptiveName(long groupId, java.util.Locale locale)` Deprecated. As of Wilberforce (7.0.x), replaced by `Group.getDescriptiveName(Locale)`
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getGroups(long[] groupIds)` Returns the groups with the matching primary keys.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getGroups(long companyId, long parentGroupId, boolean site)` Returns all the groups that are direct children of the parent group.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getGroups(long companyId, long parentGroupId, boolean site, boolean inheritContent)`
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getGroups(long companyId, long parentGroupId, boolean site, int start, int end)`
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getGroups(long companyId, long parentGroupId, java.lang.String name, boolean site, int start, int end)`
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getGroups(long companyId, java.lang.String treePath, boolean site)`
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getGroups(long companyId, java.lang.String className, long parentGroupId)` Returns all the groups that are direct children of the parent group with the matching className.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getGroups(long companyId, java.lang.String className, long parentGroupId, int start, int end)` Returns a range of all the groups that are direct children of the parent group with the matching className.
`int`	`getGroupsCount(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, java.lang.String name, boolean site)`
`int`	`getGroupsCount(long companyId, java.lang.String className, long parentGroupId)` Returns the number of groups that are direct children of the parent group with the matching className.
`com.liferay.portal.kernel.model.Group`	`getLayoutGroup(long companyId, long plid)` Returns the group associated with the layout.
`com.liferay.portal.kernel.model.Group`	`getLayoutPrototypeGroup(long companyId, long layoutPrototypeId)` Returns the group associated with the layout prototype.
`com.liferay.portal.kernel.model.Group`	`getLayoutSetPrototypeGroup(long companyId, long layoutSetPrototypeId)` Returns the group associated with the layout set prototype.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getLayoutsGroups(long companyId, long parentGroupId, boolean site, boolean active, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Group> obc)` Returns a range of all groups that are children of the parent group and that have at least one layout.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getLayoutsGroups(long companyId, long parentGroupId, boolean site, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.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
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getLiveGroups()` Returns all live groups.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getNoLayoutsGroups(java.lang.String className, boolean privateLayout, int start, int end)` Returns a range of all non-system groups of a specified type (className) that have no layouts.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getNullFriendlyURLGroups()` Deprecated. As of Judson (7.1.x), with no direct replacement
`com.liferay.portal.kernel.model.Group`	`getOrganizationGroup(long companyId, long organizationId)` Returns the specified organization group.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getOrganizationsGroups(java.util.List<com.liferay.portal.kernel.model.Organization> organizations)` Returns the specified organization groups.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getOrganizationsRelatedGroups(java.util.List<com.liferay.portal.kernel.model.Organization> organizations)` Returns all the groups related to the organizations.
`protected java.lang.String`	`getOrgGroupName(java.lang.String name)`
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getParentGroups(long groupId)` Returns the group followed by all its parent groups ordered by closest ancestor.
`protected java.util.List<com.liferay.exportimport.kernel.lar.PortletDataHandler>`	`getPortletDataHandlers(com.liferay.portal.kernel.model.Group group)`
`protected java.lang.String[]`	`getSearchNames(long companyId, java.lang.String name)`
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getStagedSites()`
`com.liferay.portal.kernel.model.Group`	`getStagingGroup(long liveGroupId)` Returns the staging group.
`com.liferay.portal.kernel.model.Group`	`getUserGroup(long companyId, long userId)` Returns the group directly associated with the user.
`com.liferay.portal.kernel.model.Group`	`getUserGroupGroup(long companyId, long userGroupId)` Returns the specified "user group" group.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getUserGroups(long userId, boolean inherit)` Returns all the user's site groups and immediate organization groups, optionally including the user's inherited organization groups and user groups.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getUserGroups(long userId, boolean inherit, int start, int end)` Returns an ordered range of all the user's site groups and immediate organization groups, optionally including the user's inherited organization groups and user groups.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getUserGroupsGroups(java.util.List<com.liferay.portal.kernel.model.UserGroup> userGroups)` Returns the groups associated with the user groups.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getUserGroupsRelatedGroups(java.util.List<com.liferay.portal.kernel.model.UserGroup> userGroups)` Returns all the groups related to the user groups.
`java.util.List<com.liferay.portal.kernel.model.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`.
`com.liferay.portal.kernel.model.Group`	`getUserPersonalSiteGroup(long companyId)` Returns the default user's personal site group.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getUserSitesGroups(long userId)`
`java.util.List<com.liferay.portal.kernel.model.Group>`	`getUserSitesGroups(long userId, boolean includeAdministrative)`
`protected java.lang.String`	`getValidatedFriendlyURL(long companyId, long groupId, long classNameId, long classPK, java.lang.String friendlyURL)`
`boolean`	`hasStagingGroup(long liveGroupId)` Returns `true` if the live group has a staging group.
`boolean`	`hasUserGroup(long userId, long groupId)` Returns `true` if the user is immediately associated with the group, or associated with the group via the user's organizations, inherited organizations, or user groups.
`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.
`protected void`	`initImportLARFile()`
`protected void`	`initUserPersonalSitePermissions(com.liferay.portal.kernel.model.Group group)`
`protected boolean`	`isCompanyGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, com.liferay.portal.kernel.model.Group group)`
`boolean`	`isLiveGroupActive(com.liferay.portal.kernel.model.Group group)`
`protected boolean`	`isParentGroup(long parentGroupId, long groupId)`
`protected boolean`	`isStaging(com.liferay.portal.kernel.service.ServiceContext serviceContext)`
`protected boolean`	`isUseComplexSQL(long[] classNameIds)`
`com.liferay.portal.kernel.model.Group`	`loadFetchGroup(long companyId, java.lang.String groupKey)` Returns the group with the matching group key by first searching the system groups and then using the finder cache.
`com.liferay.portal.kernel.model.Group`	`loadGetGroup(long companyId, java.lang.String groupKey)` Returns the group with the matching group key.
`protected boolean`	`matches(java.lang.String s, java.lang.String[] keywords)`
`void`	`rebuildTree(long companyId)` Rebuilds the group tree.
`protected void`	`reindex(long companyId, long[] userIds)`
`protected void`	`reindexUsersInOrganization(long organizationId)`
`protected void`	`reindexUsersInUserGroup(long userGroupId)`
`java.util.List<com.liferay.portal.kernel.model.Group>`	`search(long companyId, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end)` Returns an ordered range of all the company's groups, optionally including the user's inherited organization groups and user groups.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`search(long companyId, long[] classNameIds, long parentGroupId, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end)` Returns an ordered range of all the groups belonging to the parent group that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`search(long companyId, long[] classNameIds, long parentGroupId, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.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.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`search(long companyId, long[] classNameIds, long parentGroupId, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator, int start, int end)` Returns an ordered range of all the groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`search(long companyId, long[] classNameIds, long parentGroupId, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.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.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`search(long companyId, long[] classNameIds, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end)` Returns an ordered range of all the groups that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`search(long companyId, long[] classNameIds, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.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.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`search(long companyId, long[] classNameIds, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator, int start, int end)` Returns an ordered range of all the groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`search(long companyId, long[] classNameIds, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.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.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`search(long companyId, long parentGroupId, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end)` Returns an ordered range of all the groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`search(long companyId, long parentGroupId, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.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.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`search(long companyId, long parentGroupId, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator, int start, int end)` Returns an ordered range of all the site groups belonging to the parent group and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`search(long companyId, long parentGroupId, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.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.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`search(long companyId, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end)` Returns an ordered range of all the groups that match the keywords, optionally including the user's inherited organization groups and user groups.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`search(long companyId, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.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.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`search(long companyId, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator, int start, int end)` Returns an ordered range of all the site groups and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.
`java.util.List<com.liferay.portal.kernel.model.Group>`	`search(long companyId, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.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, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)` Returns the number of groups belonging to the parent group that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups.
`int`	`searchCount(long companyId, long[] classNameIds, long parentGroupId, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator)` Returns the number of groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.
`int`	`searchCount(long companyId, long[] classNameIds, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)` Returns the number of groups that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups.
`int`	`searchCount(long companyId, long[] classNameIds, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator)` Returns the number of groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.
`int`	`searchCount(long companyId, long parentGroupId, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)` Returns the number of groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups.
`int`	`searchCount(long companyId, long parentGroupId, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator)` Returns the number of groups belonging to the parent group and immediate organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.
`int`	`searchCount(long companyId, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)` Returns the number of groups that match the keywords, optionally including the user's inherited organization groups and user groups.
`int`	`searchCount(long companyId, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator)` Returns the number of groups and immediate organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.
`protected void`	`setCompanyPermissions(com.liferay.portal.kernel.model.Role role, java.lang.String name, java.lang.String[] actionIds)`
`protected void`	`setRolePermissions(com.liferay.portal.kernel.model.Group group, com.liferay.portal.kernel.model.Role role, java.lang.String name)`
`protected void`	`setRolePermissions(com.liferay.portal.kernel.model.Group group, com.liferay.portal.kernel.model.Role role, java.lang.String name, java.lang.String[] actionIds)`
`protected java.util.List<com.liferay.portal.kernel.model.Group>`	`sort(java.util.Collection<com.liferay.portal.kernel.model.Group> groups, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Group> obc)`
`protected void`	`unscheduleStaging(com.liferay.portal.kernel.model.Group group)`
`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, com.liferay.portal.kernel.model.Group group, long[] assetCategoryIds, java.lang.String[] assetTagNames)` Updates the group's asset replacing categories and tag names.
`com.liferay.portal.kernel.model.Group`	`updateFriendlyURL(long groupId, java.lang.String friendlyURL)` Updates the group's friendly URL.
`com.liferay.portal.kernel.model.Group`	`updateGroup(long groupId, long parentGroupId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, java.lang.String friendlyURL, boolean inheritContent, boolean active, com.liferay.portal.kernel.service.ServiceContext serviceContext)`
`com.liferay.portal.kernel.model.Group`	`updateGroup(long groupId, long parentGroupId, java.lang.String name, java.lang.String description, int type, boolean manualMembership, int membershipRestriction, java.lang.String friendlyURL, boolean inheritContent, boolean active, com.liferay.portal.kernel.service.ServiceContext serviceContext)` Deprecated. As of Wilberforce (7.0.x), replaced by `updateGroup(long, long, Map, Map, int, boolean, int, String, boolean, boolean, ServiceContext)`
`com.liferay.portal.kernel.model.Group`	`updateGroup(long groupId, java.lang.String typeSettings)` Updates the group's type settings.
`com.liferay.portal.kernel.model.Group`	`updateSite(long groupId, boolean site)` Associates the group with a main site if the group is an organization.
`protected void`	`validateFriendlyURL(long companyId, long groupId, long classNameId, long classPK, java.lang.String friendlyURL)`
`protected void`	`validateGroupKey(long groupId, long companyId, java.lang.String groupKey, boolean site)`
`protected void`	`validateInheritContent(long parentGroupId, boolean inheritContent)`
`protected void`	`validateLanguageIds(java.lang.String defaultLanguageId, java.lang.String languageIds)`
`protected void`	`validateParentGroup(long groupId, long parentGroupId)`
`void`	`validateRemote(long groupId, java.lang.String remoteAddress, int remotePort, java.lang.String remotePathContext, boolean secureConnection, long remoteGroupId)`
`protected void`	`validateRemoteGroup(long groupId, long remoteGroupId, java.lang.String remoteAddress, int remotePort, java.lang.String remotePathContext, boolean secureConnection)`

Methods inherited from class com.liferay.portal.service.base.GroupLocalServiceBaseImpl
addGroup, addRoleGroup, addRoleGroup, addRoleGroups, addRoleGroups, addUserGroup, addUserGroup, addUserGroups, addUserGroups, afterPropertiesSet, clearRoleGroups, clearUserGroups, createGroup, deletePersistedModel, deleteRoleGroup, deleteRoleGroup, deleteRoleGroups, deleteRoleGroups, deleteUserGroup, deleteUserGroup, deleteUserGroups, deleteUserGroups, destroy, dynamicQuery, dynamicQuery, dynamicQuery, dynamicQuery, dynamicQueryCount, dynamicQueryCount, fetchGroupByUuidAndCompanyId, getAccountLocalService, getAccountPersistence, getActionableDynamicQuery, getAssetCategoryFinder, getAssetCategoryLocalService, getAssetCategoryPersistence, getAssetEntryFinder, getAssetEntryLocalService, getAssetEntryPersistence, getAssetTagFinder, getAssetTagLocalService, getAssetTagPersistence, getAssetVocabularyFinder, getAssetVocabularyLocalService, getAssetVocabularyPersistence, getClassNameLocalService, getClassNamePersistence, getCompanyLocalService, getCompanyPersistence, getCounterLocalService, getDLAppLocalService, getExpandoRowLocalService, getExpandoRowPersistence, getExportImportConfigurationFinder, getExportImportConfigurationLocalService, getExportImportConfigurationPersistence, getExportImportLocalService, getGroupByUuidAndCompanyId, getGroupFinder, getGroupLocalService, getGroupPersistence, getGroups, getGroupsCount, getIndexableActionableDynamicQuery, getLayoutFinder, getLayoutLocalService, getLayoutPersistence, getLayoutSetBranchLocalService, getLayoutSetBranchPersistence, getLayoutSetLocalService, getLayoutSetPersistence, getMembershipRequestLocalService, getMembershipRequestPersistence, getModelClass, getModelClassName, getOrganizationFinder, getOrganizationGroups, getOrganizationGroups, getOrganizationGroups, getOrganizationGroupsCount, getOrganizationLocalService, getOrganizationPersistence, getOrganizationPrimaryKeys, getOSGiServiceIdentifier, getPersistedModel, getPortletLocalService, getPortletPersistence, getPortletPreferencesFinder, getPortletPreferencesLocalService, getPortletPreferencesPersistence, getResourceActionLocalService, getResourceActionPersistence, getResourceLocalService, getResourcePermissionFinder, getResourcePermissionLocalService, getResourcePermissionPersistence, getRoleFinder, getRoleGroups, getRoleGroups, getRoleGroups, getRoleGroupsCount, getRoleLocalService, getRolePersistence, getRolePrimaryKeys, getSocialActivityFinder, getSocialActivityLocalService, getSocialActivityPersistence, getSocialActivitySettingLocalService, getSocialActivitySettingPersistence, getSocialRequestLocalService, getSocialRequestPersistence, getStagingLocalService, getSystemEventLocalService, getSystemEventPersistence, getTeamFinder, getTeamLocalService, getTeamPersistence, getUserFinder, getUserGroupFinder, getUserGroupGroupRoleFinder, getUserGroupGroupRoleLocalService, getUserGroupGroupRolePersistence, getUserGroupGroups, getUserGroupGroups, getUserGroupGroups, getUserGroupGroupsCount, getUserGroupLocalService, getUserGroupPersistence, getUserGroupPrimaryKeys, getUserGroupRoleFinder, getUserGroupRoleLocalService, getUserGroupRolePersistence, getUserGroups, getUserGroups, getUserGroups, getUserGroupsCount, getUserLocalService, getUserPersistence, getUserPrimaryKeys, getWorkflowDefinitionLinkLocalService, getWorkflowDefinitionLinkPersistence, hasOrganizationGroup, hasOrganizationGroups, hasRoleGroup, hasRoleGroups, hasUserGroupGroup, hasUserGroupGroups, hasUserGroups, initActionableDynamicQuery, runSQL, setAccountLocalService, setAccountPersistence, setAssetCategoryFinder, setAssetCategoryLocalService, setAssetCategoryPersistence, setAssetEntryFinder, setAssetEntryLocalService, setAssetEntryPersistence, setAssetTagFinder, setAssetTagLocalService, setAssetTagPersistence, setAssetVocabularyFinder, setAssetVocabularyLocalService, setAssetVocabularyPersistence, setClassNameLocalService, setClassNamePersistence, setCompanyLocalService, setCompanyPersistence, setCounterLocalService, setDLAppLocalService, setExpandoRowLocalService, setExpandoRowPersistence, setExportImportConfigurationFinder, setExportImportConfigurationLocalService, setExportImportConfigurationPersistence, setExportImportLocalService, setGroupFinder, setGroupLocalService, setGroupPersistence, setLayoutFinder, setLayoutLocalService, setLayoutPersistence, setLayoutSetBranchLocalService, setLayoutSetBranchPersistence, setLayoutSetLocalService, setLayoutSetPersistence, setMembershipRequestLocalService, setMembershipRequestPersistence, setOrganizationFinder, setOrganizationGroups, setOrganizationLocalService, setOrganizationPersistence, setPortletLocalService, setPortletPersistence, setPortletPreferencesFinder, setPortletPreferencesLocalService, setPortletPreferencesPersistence, setResourceActionLocalService, setResourceActionPersistence, setResourceLocalService, setResourcePermissionFinder, setResourcePermissionLocalService, setResourcePermissionPersistence, setRoleFinder, setRoleGroups, setRoleLocalService, setRolePersistence, setSocialActivityFinder, setSocialActivityLocalService, setSocialActivityPersistence, setSocialActivitySettingLocalService, setSocialActivitySettingPersistence, setSocialRequestLocalService, setSocialRequestPersistence, setStagingLocalService, setSystemEventLocalService, setSystemEventPersistence, setTeamFinder, setTeamLocalService, setTeamPersistence, setUserFinder, setUserGroupFinder, setUserGroupGroupRoleFinder, setUserGroupGroupRoleLocalService, setUserGroupGroupRolePersistence, setUserGroupGroups, setUserGroupLocalService, setUserGroupPersistence, setUserGroupRoleFinder, setUserGroupRoleLocalService, setUserGroupRolePersistence, setUserGroups, setUserLocalService, setUserPersistence, setWorkflowDefinitionLinkLocalService, setWorkflowDefinitionLinkPersistence, updateGroup

Methods inherited from class com.liferay.portal.kernel.service.BaseLocalServiceImpl
getClassLoader, getLocalizationMap

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

- Field Detail
  - ORGANIZATION_NAME_SUFFIX
```
public static final java.lang.String ORGANIZATION_NAME_SUFFIX
```
    See Also:
    
    Constant Field Values
  - ORGANIZATION_STAGING_SUFFIX
```
public static final java.lang.String ORGANIZATION_STAGING_SUFFIX
```
    See Also:
    
    Constant Field Values
  - publicLARFile
```
protected java.io.File publicLARFile
```
- Constructor Detail
  - GroupLocalServiceImpl
```
public GroupLocalServiceImpl()
```
    Constructs a group local service.
- Method Detail
  - addGroup
```
public com.liferay.portal.kernel.model.Group addGroup(long userId,
                                                      long parentGroupId,
                                                      java.lang.String className,
                                                      long classPK,
                                                      long liveGroupId,
                                                      java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                                      java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                                      int type,
                                                      boolean manualMembership,
                                                      int membershipRestriction,
                                                      java.lang.String friendlyURL,
                                                      boolean site,
                                                      boolean inheritContent,
                                                      boolean active,
                                                      com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                               throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - addGroup
```
public com.liferay.portal.kernel.model.Group addGroup(long userId,
                                                      long parentGroupId,
                                                      java.lang.String className,
                                                      long classPK,
                                                      long liveGroupId,
                                                      java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                                      java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                                      int type,
                                                      boolean manualMembership,
                                                      int membershipRestriction,
                                                      java.lang.String friendlyURL,
                                                      boolean site,
                                                      boolean active,
                                                      com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                               throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - addGroup
```
@Deprecated
public com.liferay.portal.kernel.model.Group addGroup(long userId,
                                                                  long parentGroupId,
                                                                  java.lang.String className,
                                                                  long classPK,
                                                                  long liveGroupId,
                                                                  java.lang.String name,
                                                                  java.lang.String description,
                                                                  int type,
                                                                  boolean manualMembership,
                                                                  int membershipRestriction,
                                                                  java.lang.String friendlyURL,
                                                                  boolean site,
                                                                  boolean active,
                                                                  com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                           throws com.liferay.portal.kernel.exception.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.
    
    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:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occured
  - addOrganizationGroup
```
public void addOrganizationGroup(long organizationId,
                                 com.liferay.portal.kernel.model.Group group)
```
    Adds the group to the organization.
    
    Specified by:
    
    addOrganizationGroup in interface com.liferay.portal.kernel.service.GroupLocalService
    
    Overrides:
    
    addOrganizationGroup in class GroupLocalServiceBaseImpl
    
    Parameters:
    
    organizationId - the primary key of the organization
    
    group - the group
  - addOrganizationGroup
```
public void addOrganizationGroup(long organizationId,
                                 long groupId)
```
    Adds the group to the organization.
    
    Specified by:
    
    addOrganizationGroup in interface com.liferay.portal.kernel.service.GroupLocalService
    
    Overrides:
    
    addOrganizationGroup in class GroupLocalServiceBaseImpl
    
    Parameters:
    
    organizationId - the primary key of the organization
    
    groupId - the primary key of the group
  - addOrganizationGroups
```
public void addOrganizationGroups(long organizationId,
                                  java.util.List<com.liferay.portal.kernel.model.Group> groups)
```
    Adds the groups to the organization.
    
    Specified by:
    
    addOrganizationGroups in interface com.liferay.portal.kernel.service.GroupLocalService
    
    Overrides:
    
    addOrganizationGroups in class GroupLocalServiceBaseImpl
    
    Parameters:
    
    organizationId - the primary key of the organization
    
    groups - the groups
  - addOrganizationGroups
```
public void addOrganizationGroups(long organizationId,
                                  long[] groupIds)
```
    Adds the groups to the organization.
    
    Specified by:
    
    addOrganizationGroups in interface com.liferay.portal.kernel.service.GroupLocalService
    
    Overrides:
    
    addOrganizationGroups in class GroupLocalServiceBaseImpl
    
    Parameters:
    
    organizationId - the primary key of the organization
    
    groupIds - the primary keys of the groups
  - addUserGroupGroup
```
public void addUserGroupGroup(long userGroupId,
                              com.liferay.portal.kernel.model.Group group)
```
    Adds the group to the user group.
    
    Specified by:
    
    addUserGroupGroup in interface com.liferay.portal.kernel.service.GroupLocalService
    
    Overrides:
    
    addUserGroupGroup in class GroupLocalServiceBaseImpl
    
    Parameters:
    
    userGroupId - the primary key of the user group
    
    group - the group
  - addUserGroupGroup
```
public void addUserGroupGroup(long userGroupId,
                              long groupId)
```
    Adds the group to the user group.
    
    Specified by:
    
    addUserGroupGroup in interface com.liferay.portal.kernel.service.GroupLocalService
    
    Overrides:
    
    addUserGroupGroup in class GroupLocalServiceBaseImpl
    
    Parameters:
    
    userGroupId - the primary key of the user group
    
    groupId - the primary key of the group
  - addUserGroupGroups
```
public void addUserGroupGroups(long userGroupId,
                               java.util.List<com.liferay.portal.kernel.model.Group> groups)
```
    Adds the groups to the user group.
    
    Specified by:
    
    addUserGroupGroups in interface com.liferay.portal.kernel.service.GroupLocalService
    
    Overrides:
    
    addUserGroupGroups in class GroupLocalServiceBaseImpl
    
    Parameters:
    
    userGroupId - the primary key of the user group
    
    groups - the groups
  - addUserGroupGroups
```
public void addUserGroupGroups(long userGroupId,
                               long[] groupIds)
```
    Adds the groups to the user group.
    
    Specified by:
    
    addUserGroupGroups in interface com.liferay.portal.kernel.service.GroupLocalService
    
    Overrides:
    
    addUserGroupGroups in class GroupLocalServiceBaseImpl
    
    Parameters:
    
    userGroupId - the primary key of the user group
    
    groupIds - the primary keys of the groups
  - checkCompanyGroup
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
public void checkCompanyGroup(long companyId)
                                                                                          throws com.liferay.portal.kernel.exception.PortalException
```
    Adds a company group if it does not exist. This method is typically used when a virtual host is added.
    
    Parameters:
    
    companyId - the primary key of the company
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - checkScopeGroup
```
public com.liferay.portal.kernel.model.Group checkScopeGroup(com.liferay.portal.kernel.model.Layout layout,
                                                             long userId)
                                                      throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - checkSystemGroups
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
public void checkSystemGroups(long companyId)
                                                                                          throws com.liferay.portal.kernel.exception.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.
    
    Parameters:
    
    companyId - the primary key of the company
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - clearOrganizationGroups
```
public void clearOrganizationGroups(long organizationId)
```
    Clears the groups from the organization.
    
    Specified by:
    
    clearOrganizationGroups in interface com.liferay.portal.kernel.service.GroupLocalService
    
    Overrides:
    
    clearOrganizationGroups in class GroupLocalServiceBaseImpl
    
    Parameters:
    
    organizationId - the primary key of the organization
  - clearUserGroupGroups
```
public void clearUserGroupGroups(long userGroupId)
```
    Clears the groups from the user group.
    
    Specified by:
    
    clearUserGroupGroups in interface com.liferay.portal.kernel.service.GroupLocalService
    
    Overrides:
    
    clearUserGroupGroups in class GroupLocalServiceBaseImpl
    
    Parameters:
    
    userGroupId - the primary key of the user group
  - deleteGroup
```
public com.liferay.portal.kernel.model.Group deleteGroup(com.liferay.portal.kernel.model.Group group)
                                                  throws com.liferay.portal.kernel.exception.PortalException
```
    Deletes the group and its associated data.
    The group is unstaged and its assets and resources including layouts, membership requests, subscriptions, teams, blogs, bookmarks, events, image gallery, journals, message boards, polls, and wikis are also deleted.
    
    Specified by:
    
    deleteGroup in interface com.liferay.portal.kernel.service.GroupLocalService
    
    Overrides:
    
    deleteGroup in class GroupLocalServiceBaseImpl
    
    Parameters:
    
    group - the group
    
    Returns:
    
    the deleted group
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - deleteGroup
```
public com.liferay.portal.kernel.model.Group deleteGroup(long groupId)
                                                  throws com.liferay.portal.kernel.exception.PortalException
```
    Deletes the group and its associated data.
    The group is unstaged and its assets and resources including layouts, membership requests, subscriptions, teams, blogs, bookmarks, events, image gallery, journals, message boards, polls, and wikis are also deleted.
    
    Specified by:
    
    deleteGroup in interface com.liferay.portal.kernel.service.GroupLocalService
    
    Overrides:
    
    deleteGroup in class GroupLocalServiceBaseImpl
    
    Parameters:
    
    groupId - the primary key of the group
    
    Returns:
    
    the deleted group
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - deleteOrganizationGroup
```
public void deleteOrganizationGroup(long organizationId,
                                    com.liferay.portal.kernel.model.Group group)
```
    Deletes the group from the organization.
    
    Specified by:
    
    deleteOrganizationGroup in interface com.liferay.portal.kernel.service.GroupLocalService
    
    Overrides:
    
    deleteOrganizationGroup in class GroupLocalServiceBaseImpl
    
    Parameters:
    
    organizationId - the primary key of the organization
    
    group - the group
  - deleteOrganizationGroup
```
public void deleteOrganizationGroup(long organizationId,
                                    long groupId)
```
    Deletes the group from the organization.
    
    Specified by:
    
    deleteOrganizationGroup in interface com.liferay.portal.kernel.service.GroupLocalService
    
    Overrides:
    
    deleteOrganizationGroup in class GroupLocalServiceBaseImpl
    
    Parameters:
    
    organizationId - the primary key of the organization
    
    groupId - the primary key of the group
  - deleteOrganizationGroups
```
public void deleteOrganizationGroups(long organizationId,
                                     java.util.List<com.liferay.portal.kernel.model.Group> groups)
```
    Deletes the groups from the organization.
    
    Specified by:
    
    deleteOrganizationGroups in interface com.liferay.portal.kernel.service.GroupLocalService
    
    Overrides:
    
    deleteOrganizationGroups in class GroupLocalServiceBaseImpl
    
    Parameters:
    
    organizationId - the primary key of the organization
    
    groups - the groups
  - deleteOrganizationGroups
```
public void deleteOrganizationGroups(long organizationId,
                                     long[] groupIds)
```
    Deletes the groups from the organization.
    
    Specified by:
    
    deleteOrganizationGroups in interface com.liferay.portal.kernel.service.GroupLocalService
    
    Overrides:
    
    deleteOrganizationGroups in class GroupLocalServiceBaseImpl
    
    Parameters:
    
    organizationId - the primary key of the organization
    
    groupIds - the primary keys of the groups
  - deleteUserGroupGroup
```
public void deleteUserGroupGroup(long userGroupId,
                                 com.liferay.portal.kernel.model.Group group)
```
    Deletes the group from the user group.
    
    Specified by:
    
    deleteUserGroupGroup in interface com.liferay.portal.kernel.service.GroupLocalService
    
    Overrides:
    
    deleteUserGroupGroup in class GroupLocalServiceBaseImpl
    
    Parameters:
    
    userGroupId - the primary key of the user group
    
    group - the group
  - deleteUserGroupGroup
```
public void deleteUserGroupGroup(long userGroupId,
                                 long groupId)
```
    Deletes the group from the user group.
    
    Specified by:
    
    deleteUserGroupGroup in interface com.liferay.portal.kernel.service.GroupLocalService
    
    Overrides:
    
    deleteUserGroupGroup in class GroupLocalServiceBaseImpl
    
    Parameters:
    
    userGroupId - the primary key of the user group
    
    groupId - the primary key of the group
  - deleteUserGroupGroups
```
public void deleteUserGroupGroups(long userGroupId,
                                  java.util.List<com.liferay.portal.kernel.model.Group> groups)
```
    Deletes the groups from the user group.
    
    Specified by:
    
    deleteUserGroupGroups in interface com.liferay.portal.kernel.service.GroupLocalService
    
    Overrides:
    
    deleteUserGroupGroups in class GroupLocalServiceBaseImpl
    
    Parameters:
    
    userGroupId - the primary key of the user group
    
    groups - the groups
  - deleteUserGroupGroups
```
public void deleteUserGroupGroups(long userGroupId,
                                  long[] groupIds)
```
    Deletes the groups from the user group.
    
    Specified by:
    
    deleteUserGroupGroups in interface com.liferay.portal.kernel.service.GroupLocalService
    
    Overrides:
    
    deleteUserGroupGroups in class GroupLocalServiceBaseImpl
    
    Parameters:
    
    userGroupId - the primary key of the user group
    
    groupIds - the primary keys of the groups
  - disableStaging
```
public void disableStaging(long groupId)
                    throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - enableStaging
```
public void enableStaging(long groupId)
                   throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - fetchCompanyGroup
```
public com.liferay.portal.kernel.model.Group fetchCompanyGroup(long companyId)
```
    Returns the company's group.
    
    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 com.liferay.portal.kernel.model.Group fetchFriendlyURLGroup(long companyId,
                                                                   java.lang.String friendlyURL)
```
    Returns the group with the matching friendly URL.
    
    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
```
@ThreadLocalCachable
public com.liferay.portal.kernel.model.Group fetchGroup(long groupId)
```
    Specified by:
    
    fetchGroup in interface com.liferay.portal.kernel.service.GroupLocalService
    
    Overrides:
    
    fetchGroup in class GroupLocalServiceBaseImpl
  - fetchGroup
```
@Skip
public com.liferay.portal.kernel.model.Group fetchGroup(long companyId,
                                                              java.lang.String groupKey)
```
    Returns the group with the matching group key by first searching the system groups and then using the finder cache.
    
    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
  - fetchStagingGroup
```
public com.liferay.portal.kernel.model.Group fetchStagingGroup(long liveGroupId)
```
  - fetchUserGroup
```
public com.liferay.portal.kernel.model.Group fetchUserGroup(long companyId,
                                                            long userId)
```
  - fetchUserPersonalSiteGroup
```
public com.liferay.portal.kernel.model.Group fetchUserPersonalSiteGroup(long companyId)
                                                                 throws com.liferay.portal.kernel.exception.PortalException
```
    Returns the default user's personal site group.
    
    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:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - getActiveGroupIds
```
public java.util.List<java.lang.Long> getActiveGroupIds(long userId)
```
  - getActiveGroups
```
public java.util.List<com.liferay.portal.kernel.model.Group> getActiveGroups(long companyId,
                                                                             boolean active)
```
    Returns all the active or inactive groups associated with the company.
    
    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 associated with the company
  - getActiveGroups
```
public java.util.List<com.liferay.portal.kernel.model.Group> getActiveGroups(long companyId,
                                                                             boolean site,
                                                                             boolean active,
                                                                             int start,
                                                                             int end,
                                                                             com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Group> obc)
```
    Returns the active or inactive groups associated with the company.
    
    Parameters:
    
    companyId - the primary key of the company
    
    active - whether to return only active groups, or only inactive groups
    
    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 active or inactive groups associated with the company
  - getActiveGroups
```
public java.util.List<com.liferay.portal.kernel.model.Group> getActiveGroups(long companyId,
                                                                             boolean active,
                                                                             int start,
                                                                             int end,
                                                                             com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Group> obc)
```
    Returns the active or inactive groups associated with the company.
    
    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 associated with the company
  - getActiveGroupsCount
```
public int getActiveGroupsCount(long companyId,
                                boolean active)
```
    Returns the number of active or inactive groups associated with the company.
    
    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 associated with the company
  - getActiveGroupsCount
```
public int getActiveGroupsCount(long companyId,
                                boolean active,
                                boolean site)
```
    Returns the number of active or inactive groups associated with the company.
    
    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 associated with the company
  - getCompanyGroup
```
public com.liferay.portal.kernel.model.Group getCompanyGroup(long companyId)
                                                      throws com.liferay.portal.kernel.exception.PortalException
```
    Returns the company group.
    
    Parameters:
    
    companyId - the primary key of the company
    
    Returns:
    
    the group associated with the company
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - getCompanyGroups
```
public java.util.List<com.liferay.portal.kernel.model.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.
    
    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.
    
    Parameters:
    
    companyId - the primary key of the company
    
    Returns:
    
    the number of groups associated with the company
  - getFriendlyURLGroup
```
public com.liferay.portal.kernel.model.Group getFriendlyURLGroup(long companyId,
                                                                 java.lang.String friendlyURL)
                                                          throws com.liferay.portal.kernel.exception.PortalException
```
    Returns the group with the matching friendly URL.
    
    Parameters:
    
    companyId - the primary key of the company
    
    friendlyURL - the group's friendlyURL
    
    Returns:
    
    the group with the friendly URL
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - getGroup
```
@ThreadLocalCachable
public com.liferay.portal.kernel.model.Group getGroup(long groupId)
                                                                    throws com.liferay.portal.kernel.exception.PortalException
```
    Returns the group with the matching primary key.
    
    Specified by:
    
    getGroup in interface com.liferay.portal.kernel.service.GroupLocalService
    
    Overrides:
    
    getGroup in class GroupLocalServiceBaseImpl
    
    Parameters:
    
    groupId - the primary key of the group
    
    Returns:
    
    the group with the primary key
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - getGroup
```
@Skip
public com.liferay.portal.kernel.model.Group getGroup(long companyId,
                                                            java.lang.String groupKey)
                                                     throws com.liferay.portal.kernel.exception.PortalException
```
    Returns the group with the matching group key.
    
    Parameters:
    
    companyId - the primary key of the company
    
    groupKey - the group key
    
    Returns:
    
    the group with the group key
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - getGroupDescriptiveName
```
@Deprecated
public java.lang.String getGroupDescriptiveName(com.liferay.portal.kernel.model.Group group,
                                                            java.util.Locale locale)
                                                     throws com.liferay.portal.kernel.exception.PortalException
```
    Deprecated. As of Wilberforce (7.0.x), replaced by Group.getDescriptiveName(Locale)
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - getGroupDescriptiveName
```
@Deprecated
public java.lang.String getGroupDescriptiveName(long groupId,
                                                            java.util.Locale locale)
                                                     throws com.liferay.portal.kernel.exception.PortalException
```
    Deprecated. As of Wilberforce (7.0.x), replaced by Group.getDescriptiveName(Locale)
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - getGroups
```
public java.util.List<com.liferay.portal.kernel.model.Group> getGroups(long companyId,
                                                                       long parentGroupId,
                                                                       boolean site)
```
    Returns all the groups that are direct children of the parent group.
    
    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 java.util.List<com.liferay.portal.kernel.model.Group> getGroups(long companyId,
                                                                       long parentGroupId,
                                                                       boolean site,
                                                                       boolean inheritContent)
```
  - getGroups
```
public java.util.List<com.liferay.portal.kernel.model.Group> getGroups(long companyId,
                                                                       long parentGroupId,
                                                                       boolean site,
                                                                       int start,
                                                                       int end)
```
  - getGroups
```
public java.util.List<com.liferay.portal.kernel.model.Group> getGroups(long companyId,
                                                                       long parentGroupId,
                                                                       java.lang.String name,
                                                                       boolean site,
                                                                       int start,
                                                                       int end)
```
  - getGroups
```
public java.util.List<com.liferay.portal.kernel.model.Group> getGroups(long companyId,
                                                                       java.lang.String treePath,
                                                                       boolean site)
```
  - getGroups
```
public java.util.List<com.liferay.portal.kernel.model.Group> getGroups(long companyId,
                                                                       java.lang.String className,
                                                                       long parentGroupId)
```
    Returns all the groups that are direct children of the parent group with the matching className.
    
    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 java.util.List<com.liferay.portal.kernel.model.Group> getGroups(long companyId,
                                                                       java.lang.String className,
                                                                       long parentGroupId,
                                                                       int start,
                                                                       int end)
```
    Returns a range of all the groups that are direct children of the parent group with the matching className.
    
    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 java.util.List<com.liferay.portal.kernel.model.Group> getGroups(long[] groupIds)
                                                                throws com.liferay.portal.kernel.exception.PortalException
```
    Returns the groups with the matching primary keys.
    
    Parameters:
    
    groupIds - the primary keys of the groups
    
    Returns:
    
    the groups with the primary keys
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - getGroupsCount
```
public int getGroupsCount(long companyId,
                          long parentGroupId,
                          boolean site)
```
    Returns the number of groups that are direct children of the parent group.
    
    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,
                          java.lang.String name,
                          boolean site)
```
  - getGroupsCount
```
public int getGroupsCount(long companyId,
                          java.lang.String className,
                          long parentGroupId)
```
    Returns the number of groups that are direct children of the parent group with the matching className.
    
    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
  - getLayoutGroup
```
public com.liferay.portal.kernel.model.Group getLayoutGroup(long companyId,
                                                            long plid)
                                                     throws com.liferay.portal.kernel.exception.PortalException
```
    Returns the group associated with the layout.
    
    Parameters:
    
    companyId - the primary key of the company
    
    plid - the primary key of the layout
    
    Returns:
    
    the group associated with the layout
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - getLayoutPrototypeGroup
```
public com.liferay.portal.kernel.model.Group getLayoutPrototypeGroup(long companyId,
                                                                     long layoutPrototypeId)
                                                              throws com.liferay.portal.kernel.exception.PortalException
```
    Returns the group associated with the layout prototype.
    
    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:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - getLayoutSetPrototypeGroup
```
public com.liferay.portal.kernel.model.Group getLayoutSetPrototypeGroup(long companyId,
                                                                        long layoutSetPrototypeId)
                                                                 throws com.liferay.portal.kernel.exception.PortalException
```
    Returns the group associated with the layout set prototype.
    
    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:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - getLayoutsGroups
```
public java.util.List<com.liferay.portal.kernel.model.Group> getLayoutsGroups(long companyId,
                                                                              long parentGroupId,
                                                                              boolean site,
                                                                              boolean active,
                                                                              int start,
                                                                              int end,
                                                                              com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.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.
    
    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 java.util.List<com.liferay.portal.kernel.model.Group> getLayoutsGroups(long companyId,
                                                                              long parentGroupId,
                                                                              boolean site,
                                                                              int start,
                                                                              int end,
                                                                              com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.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.
    
    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
    
    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
    
    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 java.util.List<com.liferay.portal.kernel.model.Group> getLiveGroups()
```
    Returns all live groups.
    
    Returns:
    
    all live groups
  - getNoLayoutsGroups
```
public java.util.List<com.liferay.portal.kernel.model.Group> getNoLayoutsGroups(java.lang.String className,
                                                                                boolean privateLayout,
                                                                                int start,
                                                                                int end)
```
    Returns a range of all non-system groups of a specified type (className) that have no layouts.
    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.
    
    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 java.util.List<com.liferay.portal.kernel.model.Group> getNullFriendlyURLGroups()
```
    Deprecated. As of Judson (7.1.x), with no direct replacement
    
    Returns all non-system groups having null or empty friendly URLs.
    
    Returns:
    
    the non-system groups having null or empty friendly URLs
  - getOrganizationGroup
```
public com.liferay.portal.kernel.model.Group getOrganizationGroup(long companyId,
                                                                  long organizationId)
                                                           throws com.liferay.portal.kernel.exception.PortalException
```
    Returns the specified organization group.
    
    Parameters:
    
    companyId - the primary key of the company
    
    organizationId - the primary key of the organization
    
    Returns:
    
    the group associated with the organization
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - getOrganizationsGroups
```
public java.util.List<com.liferay.portal.kernel.model.Group> getOrganizationsGroups(java.util.List<com.liferay.portal.kernel.model.Organization> organizations)
```
    Returns the specified organization groups.
    
    Parameters:
    
    organizations - the organizations
    
    Returns:
    
    the groups associated with the organizations
  - getOrganizationsRelatedGroups
```
public java.util.List<com.liferay.portal.kernel.model.Group> getOrganizationsRelatedGroups(java.util.List<com.liferay.portal.kernel.model.Organization> organizations)
```
    Returns all the groups related to the organizations.
    
    Parameters:
    
    organizations - the organizations
    
    Returns:
    
    the groups related to the organizations
  - getParentGroups
```
public java.util.List<com.liferay.portal.kernel.model.Group> getParentGroups(long groupId)
                                                                      throws com.liferay.portal.kernel.exception.PortalException
```
    Returns the group followed by all its parent groups ordered by closest ancestor.
    
    Parameters:
    
    groupId - the primary key of the group
    
    Returns:
    
    the group followed by all its parent groups ordered by closest ancestor
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - getStagedSites
```
public java.util.List<com.liferay.portal.kernel.model.Group> getStagedSites()
```
  - getStagingGroup
```
public com.liferay.portal.kernel.model.Group getStagingGroup(long liveGroupId)
                                                      throws com.liferay.portal.kernel.exception.PortalException
```
    Returns the staging group.
    
    Parameters:
    
    liveGroupId - the primary key of the live group
    
    Returns:
    
    the staging group
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - getUserGroup
```
public com.liferay.portal.kernel.model.Group getUserGroup(long companyId,
                                                          long userId)
                                                   throws com.liferay.portal.kernel.exception.PortalException
```
    Returns the group directly associated with the user.
    
    Parameters:
    
    companyId - the primary key of the company
    
    userId - the primary key of the user
    
    Returns:
    
    the group directly associated with the user
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - getUserGroupGroup
```
public com.liferay.portal.kernel.model.Group getUserGroupGroup(long companyId,
                                                               long userGroupId)
                                                        throws com.liferay.portal.kernel.exception.PortalException
```
    Returns the specified "user group" group. That is, the group that represents the UserGroup entity.
    
    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:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - getUserGroups
```
public java.util.List<com.liferay.portal.kernel.model.Group> getUserGroups(long userId,
                                                                           boolean inherit)
                                                                    throws com.liferay.portal.kernel.exception.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.
    
    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:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - getUserGroups
```
public java.util.List<com.liferay.portal.kernel.model.Group> getUserGroups(long userId,
                                                                           boolean inherit,
                                                                           int start,
                                                                           int end)
                                                                    throws com.liferay.portal.kernel.exception.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.
    
    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:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - getUserGroupsGroups
```
public java.util.List<com.liferay.portal.kernel.model.Group> getUserGroupsGroups(java.util.List<com.liferay.portal.kernel.model.UserGroup> userGroups)
                                                                          throws com.liferay.portal.kernel.exception.PortalException
```
    Returns the groups associated with the user groups.
    
    Parameters:
    
    userGroups - the user groups
    
    Returns:
    
    the groups associated with the user groups
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - getUserGroupsRelatedGroups
```
public java.util.List<com.liferay.portal.kernel.model.Group> getUserGroupsRelatedGroups(java.util.List<com.liferay.portal.kernel.model.UserGroup> userGroups)
```
    Returns all the groups related to the user groups.
    
    Parameters:
    
    userGroups - the user groups
    
    Returns:
    
    the groups related to the user groups
  - getUserOrganizationsGroups
```
public java.util.List<com.liferay.portal.kernel.model.Group> getUserOrganizationsGroups(long userId,
                                                                                        int start,
                                                                                        int end)
                                                                                 throws com.liferay.portal.kernel.exception.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.
    
    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:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - getUserPersonalSiteGroup
```
public com.liferay.portal.kernel.model.Group getUserPersonalSiteGroup(long companyId)
                                                               throws com.liferay.portal.kernel.exception.PortalException
```
    Returns the default user's personal site group.
    
    Parameters:
    
    companyId - the primary key of the company
    
    Returns:
    
    the default user's personal site group
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - getUserSitesGroups
```
public java.util.List<com.liferay.portal.kernel.model.Group> getUserSitesGroups(long userId)
                                                                         throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - getUserSitesGroups
```
public java.util.List<com.liferay.portal.kernel.model.Group> getUserSitesGroups(long userId,
                                                                                boolean includeAdministrative)
                                                                         throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - hasStagingGroup
```
public boolean hasStagingGroup(long liveGroupId)
```
    Returns true if the live group has a staging group.
    
    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)
```
    Returns true if the user is immediately associated with the group, or associated with the group via the user's organizations, inherited organizations, or user groups.
    
    Specified by:
    
    hasUserGroup in interface com.liferay.portal.kernel.service.GroupLocalService
    
    Overrides:
    
    hasUserGroup in class GroupLocalServiceBaseImpl
    
    Parameters:
    
    userId - the primary key of the user
    
    groupId - the primary key of the group
    
    Returns:
    
    true if the user is associated with the group; false otherwise
  - 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.
    
    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
  - isLiveGroupActive
```
@Skip
public boolean isLiveGroupActive(com.liferay.portal.kernel.model.Group group)
```
  - loadFetchGroup
```
public com.liferay.portal.kernel.model.Group loadFetchGroup(long companyId,
                                                            java.lang.String groupKey)
```
    Returns the group with the matching group key by first searching the system groups and then using the finder cache.
    
    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 com.liferay.portal.kernel.model.Group loadGetGroup(long companyId,
                                                          java.lang.String groupKey)
                                                   throws com.liferay.portal.kernel.exception.PortalException
```
    Returns the group with the matching group key.
    
    Parameters:
    
    companyId - the primary key of the company
    
    groupKey - the group key
    
    Returns:
    
    the group with the group key and associated company
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - rebuildTree
```
public void rebuildTree(long companyId)
                 throws com.liferay.portal.kernel.exception.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.
    
    Parameters:
    
    companyId - the primary key of the group's company
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - search
```
public java.util.List<com.liferay.portal.kernel.model.Group> search(long companyId,
                                                                    java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                    int start,
                                                                    int end)
```
    Returns an ordered range of all the company's groups, optionally including the user's inherited organization groups and user groups. 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.
    
    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 java.util.List<com.liferay.portal.kernel.model.Group> search(long companyId,
                                                                    long parentGroupId,
                                                                    java.lang.String keywords,
                                                                    java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                    int start,
                                                                    int end)
```
    Returns an ordered range of all the groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups. 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.
    
    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 java.util.List<com.liferay.portal.kernel.model.Group> search(long companyId,
                                                                    long parentGroupId,
                                                                    java.lang.String keywords,
                                                                    java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                    int start,
                                                                    int end,
                                                                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.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.
    
    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 java.util.List<com.liferay.portal.kernel.model.Group> search(long companyId,
                                                                    long parentGroupId,
                                                                    java.lang.String name,
                                                                    java.lang.String description,
                                                                    java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                    boolean andOperator,
                                                                    int start,
                                                                    int end)
```
    Returns an ordered range of all the site groups belonging to the parent group and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. 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.
    
    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 java.util.List<com.liferay.portal.kernel.model.Group> search(long companyId,
                                                                    long parentGroupId,
                                                                    java.lang.String name,
                                                                    java.lang.String description,
                                                                    java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                    boolean andOperator,
                                                                    int start,
                                                                    int end,
                                                                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.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.
    
    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 java.util.List<com.liferay.portal.kernel.model.Group> search(long companyId,
                                                                    long[] classNameIds,
                                                                    long parentGroupId,
                                                                    java.lang.String keywords,
                                                                    java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                    int start,
                                                                    int end)
```
    Returns an ordered range of all the groups belonging to the parent group that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups. 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.
    
    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 java.util.List<com.liferay.portal.kernel.model.Group> search(long companyId,
                                                                    long[] classNameIds,
                                                                    long parentGroupId,
                                                                    java.lang.String keywords,
                                                                    java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                    int start,
                                                                    int end,
                                                                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.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.
    
    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 java.util.List<com.liferay.portal.kernel.model.Group> search(long companyId,
                                                                    long[] classNameIds,
                                                                    long parentGroupId,
                                                                    java.lang.String name,
                                                                    java.lang.String description,
                                                                    java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                    boolean andOperator,
                                                                    int start,
                                                                    int end)
```
    Returns an ordered range of all the groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. 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.
    
    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 java.util.List<com.liferay.portal.kernel.model.Group> search(long companyId,
                                                                    long[] classNameIds,
                                                                    long parentGroupId,
                                                                    java.lang.String name,
                                                                    java.lang.String description,
                                                                    java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                    boolean andOperator,
                                                                    int start,
                                                                    int end,
                                                                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.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.
    
    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 java.util.List<com.liferay.portal.kernel.model.Group> search(long companyId,
                                                                    long[] classNameIds,
                                                                    java.lang.String keywords,
                                                                    java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                    int start,
                                                                    int end)
```
    Returns an ordered range of all the groups that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups. 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.
    
    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 java.util.List<com.liferay.portal.kernel.model.Group> search(long companyId,
                                                                    long[] classNameIds,
                                                                    java.lang.String keywords,
                                                                    java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                    int start,
                                                                    int end,
                                                                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.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.
    
    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 java.util.List<com.liferay.portal.kernel.model.Group> search(long companyId,
                                                                    long[] classNameIds,
                                                                    java.lang.String name,
                                                                    java.lang.String description,
                                                                    java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                    boolean andOperator,
                                                                    int start,
                                                                    int end)
```
    Returns an ordered range of all the groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. 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.
    
    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 java.util.List<com.liferay.portal.kernel.model.Group> search(long companyId,
                                                                    long[] classNameIds,
                                                                    java.lang.String name,
                                                                    java.lang.String description,
                                                                    java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                    boolean andOperator,
                                                                    int start,
                                                                    int end,
                                                                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.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.
    
    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
```
@ThreadLocalCachable
public java.util.List<com.liferay.portal.kernel.model.Group> search(long companyId,
                                                                                         java.lang.String keywords,
                                                                                         java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                         int start,
                                                                                         int end)
```
    Returns an ordered range of all the groups that match the keywords, optionally including the user's inherited organization groups and user groups. 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.
    
    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 java.util.List<com.liferay.portal.kernel.model.Group> search(long companyId,
                                                                    java.lang.String keywords,
                                                                    java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                    int start,
                                                                    int end,
                                                                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.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.
    
    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 java.util.List<com.liferay.portal.kernel.model.Group> search(long companyId,
                                                                    java.lang.String name,
                                                                    java.lang.String description,
                                                                    java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                    boolean andOperator,
                                                                    int start,
                                                                    int end)
```
    Returns an ordered range of all the site groups and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. 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.
    
    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 java.util.List<com.liferay.portal.kernel.model.Group> search(long companyId,
                                                                    java.lang.String name,
                                                                    java.lang.String description,
                                                                    java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                    boolean andOperator,
                                                                    int start,
                                                                    int end,
                                                                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.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.
    
    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
```
@ThreadLocalCachable
public int searchCount(long companyId,
                                            long parentGroupId,
                                            java.lang.String keywords,
                                            java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
```
    Returns the number of groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    
    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
```
@ThreadLocalCachable
public int searchCount(long companyId,
                                            long parentGroupId,
                                            java.lang.String name,
                                            java.lang.String description,
                                            java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                            boolean andOperator)
```
    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.
    
    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
```
@ThreadLocalCachable
public int searchCount(long companyId,
                                            long[] classNameIds,
                                            long parentGroupId,
                                            java.lang.String keywords,
                                            java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
```
    Returns the number of groups belonging to the parent group that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    
    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
```
@ThreadLocalCachable
public int searchCount(long companyId,
                                            long[] classNameIds,
                                            long parentGroupId,
                                            java.lang.String name,
                                            java.lang.String description,
                                            java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                            boolean andOperator)
```
    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.
    
    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
```
@ThreadLocalCachable
public int searchCount(long companyId,
                                            long[] classNameIds,
                                            java.lang.String keywords,
                                            java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
```
    Returns the number of groups that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    
    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
```
@ThreadLocalCachable
public int searchCount(long companyId,
                                            long[] classNameIds,
                                            java.lang.String name,
                                            java.lang.String description,
                                            java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                            boolean andOperator)
```
    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.
    
    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
```
@ThreadLocalCachable
public int searchCount(long companyId,
                                            java.lang.String keywords,
                                            java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
```
    Returns the number of groups that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    
    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
```
@ThreadLocalCachable
public int searchCount(long companyId,
                                            java.lang.String name,
                                            java.lang.String description,
                                            java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                            boolean andOperator)
```
    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.
    
    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
  - unsetRoleGroups
```
public void unsetRoleGroups(long roleId,
                            long[] groupIds)
```
    Removes the groups from the role.
    
    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.
    
    Parameters:
    
    userId - the primary key of the user
    
    groupIds - the primary keys of the groups
  - updateAsset
```
public void updateAsset(long userId,
                        com.liferay.portal.kernel.model.Group group,
                        long[] assetCategoryIds,
                        java.lang.String[] assetTagNames)
                 throws com.liferay.portal.kernel.exception.PortalException
```
    Updates the group's asset replacing categories and tag names.
    
    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:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - updateFriendlyURL
```
public com.liferay.portal.kernel.model.Group updateFriendlyURL(long groupId,
                                                               java.lang.String friendlyURL)
                                                        throws com.liferay.portal.kernel.exception.PortalException
```
    Updates the group's friendly URL.
    
    Parameters:
    
    groupId - the primary key of the group
    
    friendlyURL - the group's new friendlyURL (optionally null)
    
    Returns:
    
    the group
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - updateGroup
```
public com.liferay.portal.kernel.model.Group updateGroup(long groupId,
                                                         long parentGroupId,
                                                         java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                                         java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                                         int type,
                                                         boolean manualMembership,
                                                         int membershipRestriction,
                                                         java.lang.String friendlyURL,
                                                         boolean inheritContent,
                                                         boolean active,
                                                         com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                  throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - updateGroup
```
@Deprecated
public com.liferay.portal.kernel.model.Group updateGroup(long groupId,
                                                                     long parentGroupId,
                                                                     java.lang.String name,
                                                                     java.lang.String description,
                                                                     int type,
                                                                     boolean manualMembership,
                                                                     int membershipRestriction,
                                                                     java.lang.String friendlyURL,
                                                                     boolean inheritContent,
                                                                     boolean active,
                                                                     com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                              throws com.liferay.portal.kernel.exception.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.
    
    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:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - updateGroup
```
public com.liferay.portal.kernel.model.Group updateGroup(long groupId,
                                                         java.lang.String typeSettings)
                                                  throws com.liferay.portal.kernel.exception.PortalException
```
    Updates the group's type settings.
    
    Parameters:
    
    groupId - the primary key of the group
    
    typeSettings - the group's new type settings (optionally null)
    
    Returns:
    
    the group
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - updateSite
```
public com.liferay.portal.kernel.model.Group updateSite(long groupId,
                                                        boolean site)
                                                 throws com.liferay.portal.kernel.exception.PortalException
```
    Associates the group with a main site if the group is an organization.
    
    Parameters:
    
    groupId - the primary key of the group
    
    site - whether the group is to be associated with a main site
    
    Returns:
    
    the group
    
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
  - validateRemote
```
public void validateRemote(long groupId,
                           java.lang.String remoteAddress,
                           int remotePort,
                           java.lang.String remotePathContext,
                           boolean secureConnection,
                           long remoteGroupId)
                    throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - addControlPanelLayouts
```
protected void addControlPanelLayouts(com.liferay.portal.kernel.model.Group group)
                               throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - addDefaultGuestPublicLayoutByProperties
```
protected void addDefaultGuestPublicLayoutByProperties(com.liferay.portal.kernel.model.Group group)
                                                throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - addDefaultGuestPublicLayouts
```
protected void addDefaultGuestPublicLayouts(com.liferay.portal.kernel.model.Group group)
                                     throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - addDefaultGuestPublicLayoutsByLAR
```
protected void addDefaultGuestPublicLayoutsByLAR(com.liferay.portal.kernel.model.Group group,
                                                 java.io.File larFile)
                                          throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - addPortletDefaultData
```
protected void addPortletDefaultData(com.liferay.portal.kernel.model.Group group)
                              throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - deletePortletData
```
protected void deletePortletData(com.liferay.portal.kernel.model.Group group)
                          throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - doSearch
```
protected java.util.Collection<com.liferay.portal.kernel.model.Group> doSearch(long companyId,
                                                                               long[] classNameIds,
                                                                               long parentGroupId,
                                                                               java.lang.String[] names,
                                                                               java.lang.String[] descriptions,
                                                                               java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                               boolean andOperator)
```
  - getClassNameIds
```
protected long[] getClassNameIds()
```
  - getFriendlyURL
```
protected java.lang.String getFriendlyURL(long companyId,
                                          long groupId,
                                          long classNameId,
                                          long classPK,
                                          java.lang.String friendlyName,
                                          java.lang.String friendlyURL)
                                   throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - getFriendlyURL
```
protected java.lang.String getFriendlyURL(java.lang.String friendlyURL)
```
  - getOrgGroupName
```
protected java.lang.String getOrgGroupName(java.lang.String name)
```
  - getPortletDataHandlers
```
protected java.util.List<com.liferay.exportimport.kernel.lar.PortletDataHandler> getPortletDataHandlers(com.liferay.portal.kernel.model.Group group)
```
  - getSearchNames
```
protected java.lang.String[] getSearchNames(long companyId,
                                            java.lang.String name)
```
  - getValidatedFriendlyURL
```
protected java.lang.String getValidatedFriendlyURL(long companyId,
                                                   long groupId,
                                                   long classNameId,
                                                   long classPK,
                                                   java.lang.String friendlyURL)
                                            throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - initImportLARFile
```
protected void initImportLARFile()
```
  - initUserPersonalSitePermissions
```
protected void initUserPersonalSitePermissions(com.liferay.portal.kernel.model.Group group)
                                        throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - isCompanyGroup
```
protected boolean isCompanyGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal,
                                 com.liferay.portal.kernel.model.Group group)
```
  - isParentGroup
```
protected boolean isParentGroup(long parentGroupId,
                                long groupId)
                         throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - isStaging
```
protected boolean isStaging(com.liferay.portal.kernel.service.ServiceContext serviceContext)
```
  - isUseComplexSQL
```
protected boolean isUseComplexSQL(long[] classNameIds)
```
  - matches
```
protected boolean matches(java.lang.String s,
                          java.lang.String[] keywords)
```
  - reindex
```
protected void reindex(long companyId,
                       long[] userIds)
                throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - reindexUsersInOrganization
```
protected void reindexUsersInOrganization(long organizationId)
                                   throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - reindexUsersInUserGroup
```
protected void reindexUsersInUserGroup(long userGroupId)
                                throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - setCompanyPermissions
```
protected void setCompanyPermissions(com.liferay.portal.kernel.model.Role role,
                                     java.lang.String name,
                                     java.lang.String[] actionIds)
                              throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - setRolePermissions
```
protected void setRolePermissions(com.liferay.portal.kernel.model.Group group,
                                  com.liferay.portal.kernel.model.Role role,
                                  java.lang.String name)
                           throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - setRolePermissions
```
protected void setRolePermissions(com.liferay.portal.kernel.model.Group group,
                                  com.liferay.portal.kernel.model.Role role,
                                  java.lang.String name,
                                  java.lang.String[] actionIds)
                           throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - sort
```
protected java.util.List<com.liferay.portal.kernel.model.Group> sort(java.util.Collection<com.liferay.portal.kernel.model.Group> groups,
                                                                     int start,
                                                                     int end,
                                                                     com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Group> obc)
```
  - unscheduleStaging
```
protected void unscheduleStaging(com.liferay.portal.kernel.model.Group group)
```
  - validateFriendlyURL
```
protected void validateFriendlyURL(long companyId,
                                   long groupId,
                                   long classNameId,
                                   long classPK,
                                   java.lang.String friendlyURL)
                            throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - validateGroupKey
```
protected void validateGroupKey(long groupId,
                                long companyId,
                                java.lang.String groupKey,
                                boolean site)
                         throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - validateInheritContent
```
protected void validateInheritContent(long parentGroupId,
                                      boolean inheritContent)
                               throws com.liferay.portal.kernel.exception.GroupInheritContentException
```
    Throws:
    
    com.liferay.portal.kernel.exception.GroupInheritContentException
  - validateLanguageIds
```
protected void validateLanguageIds(java.lang.String defaultLanguageId,
                                   java.lang.String languageIds)
                            throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - validateParentGroup
```
protected void validateParentGroup(long groupId,
                                   long parentGroupId)
                            throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException
  - validateRemoteGroup
```
protected void validateRemoteGroup(long groupId,
                                   long remoteGroupId,
                                   java.lang.String remoteAddress,
                                   int remotePort,
                                   java.lang.String remotePathContext,
                                   boolean secureConnection)
                            throws com.liferay.portal.kernel.exception.PortalException
```
    Throws:
    
    com.liferay.portal.kernel.exception.PortalException

Class GroupLocalServiceImpl

Field Summary

Fields inherited from class com.liferay.portal.service.base.GroupLocalServiceBaseImpl

Constructor Summary

Method Summary

Methods inherited from class com.liferay.portal.service.base.GroupLocalServiceBaseImpl

Methods inherited from class com.liferay.portal.kernel.service.BaseLocalServiceImpl

Methods inherited from class java.lang.Object

Field Detail

ORGANIZATION_NAME_SUFFIX

ORGANIZATION_STAGING_SUFFIX

publicLARFile

Constructor Detail

GroupLocalServiceImpl

Method Detail

addGroup

addGroup

addGroup

addOrganizationGroup

addOrganizationGroup

addOrganizationGroups

addOrganizationGroups

addUserGroupGroup

addUserGroupGroup

addUserGroupGroups

addUserGroupGroups

checkCompanyGroup

checkScopeGroup

checkSystemGroups

clearOrganizationGroups

clearUserGroupGroups

deleteGroup

deleteGroup

deleteOrganizationGroup

deleteOrganizationGroup

deleteOrganizationGroups

deleteOrganizationGroups

deleteUserGroupGroup

deleteUserGroupGroup

deleteUserGroupGroups

deleteUserGroupGroups

disableStaging

enableStaging

fetchCompanyGroup

fetchFriendlyURLGroup

fetchGroup

fetchGroup

fetchStagingGroup

fetchUserGroup

fetchUserPersonalSiteGroup

getActiveGroupIds

getActiveGroups

getActiveGroups

getActiveGroups

getActiveGroupsCount

getActiveGroupsCount

getCompanyGroup

getCompanyGroups

getCompanyGroupsCount

getFriendlyURLGroup

getGroup

getGroup

getGroupDescriptiveName

getGroupDescriptiveName

getGroups

getGroups

getGroups

getGroups

getGroups

getGroups

getGroups

getGroups

getGroupsCount

getGroupsCount

getGroupsCount

getLayoutGroup

getLayoutPrototypeGroup

getLayoutSetPrototypeGroup

getLayoutsGroups

getLayoutsGroups