GroupLocalServiceUtil (Liferay 7.2.10 portal-kernel API)

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

```
public class GroupLocalServiceUtil
extends Object
```
Provides the local service utility for Group. This utility wraps com.liferay.portal.service.impl.GroupLocalServiceImpl and is an access point for service operations in application layer code running on the local server. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

Author:

Brian Wing Shun Chan

See Also:

GroupLocalService

{$generated.description}

Constructor Summary

Constructors
Constructor and Description

GroupLocalServiceUtil()

Constructors
Constructor and Description
`GroupLocalServiceUtil()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static Group`	`addGroup(Group group)` Adds the group to the database.
`static Group`	`addGroup(long userId, long parentGroupId, String className, long classPK, long liveGroupId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean site, boolean inheritContent, boolean active, ServiceContext serviceContext)`
`static Group`	`addGroup(long userId, long parentGroupId, String className, long classPK, long liveGroupId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean site, boolean active, ServiceContext serviceContext)`
`static void`	`addOrganizationGroup(long organizationId, Group group)`
`static void`	`addOrganizationGroup(long organizationId, long groupId)`
`static void`	`addOrganizationGroups(long organizationId, List<Group> groups)`
`static void`	`addOrganizationGroups(long organizationId, long[] groupIds)`
`static void`	`addRoleGroup(long roleId, Group group)`
`static void`	`addRoleGroup(long roleId, long groupId)`
`static void`	`addRoleGroups(long roleId, List<Group> groups)`
`static void`	`addRoleGroups(long roleId, long[] groupIds)`
`static void`	`addUserGroup(long userId, Group group)`
`static void`	`addUserGroup(long userId, long groupId)`
`static void`	`addUserGroupGroup(long userGroupId, Group group)`
`static void`	`addUserGroupGroup(long userGroupId, long groupId)`
`static void`	`addUserGroupGroups(long userGroupId, List<Group> groups)`
`static void`	`addUserGroupGroups(long userGroupId, long[] groupIds)`
`static void`	`addUserGroups(long userId, List<Group> groups)`
`static void`	`addUserGroups(long userId, long[] groupIds)`
`static void`	`checkCompanyGroup(long companyId)` Adds a company group if it does not exist.
`static Group`	`checkScopeGroup(Layout layout, long userId)`
`static void`	`checkSystemGroups(long companyId)` Creates systems groups and other related data needed by the system on the very first startup.
`static void`	`clearOrganizationGroups(long organizationId)`
`static void`	`clearRoleGroups(long roleId)`
`static void`	`clearUserGroupGroups(long userGroupId)`
`static void`	`clearUserGroups(long userId)`
`static Group`	`createGroup(long groupId)` Creates a new group with the primary key.
`static Group`	`deleteGroup(Group group)` Deletes the group from the database.
`static Group`	`deleteGroup(long groupId)` Deletes the group with the primary key from the database.
`static void`	`deleteOrganizationGroup(long organizationId, Group group)`
`static void`	`deleteOrganizationGroup(long organizationId, long groupId)`
`static void`	`deleteOrganizationGroups(long organizationId, List<Group> groups)`
`static void`	`deleteOrganizationGroups(long organizationId, long[] groupIds)`
`static PersistedModel`	`deletePersistedModel(PersistedModel persistedModel)`
`static void`	`deleteRoleGroup(long roleId, Group group)`
`static void`	`deleteRoleGroup(long roleId, long groupId)`
`static void`	`deleteRoleGroups(long roleId, List<Group> groups)`
`static void`	`deleteRoleGroups(long roleId, long[] groupIds)`
`static void`	`deleteUserGroup(long userId, Group group)`
`static void`	`deleteUserGroup(long userId, long groupId)`
`static void`	`deleteUserGroupGroup(long userGroupId, Group group)`
`static void`	`deleteUserGroupGroup(long userGroupId, long groupId)`
`static void`	`deleteUserGroupGroups(long userGroupId, List<Group> groups)`
`static void`	`deleteUserGroupGroups(long userGroupId, long[] groupIds)`
`static void`	`deleteUserGroups(long userId, List<Group> groups)`
`static void`	`deleteUserGroups(long userId, long[] groupIds)`
`static void`	`disableStaging(long groupId)`
`static DynamicQuery`	`dynamicQuery()`
`static <T> List<T>`	`dynamicQuery(DynamicQuery dynamicQuery)` Performs a dynamic query on the database and returns the matching rows.
`static <T> List<T>`	`dynamicQuery(DynamicQuery dynamicQuery, int start, int end)` Performs a dynamic query on the database and returns a range of the matching rows.
`static <T> List<T>`	`dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)` Performs a dynamic query on the database and returns an ordered range of the matching rows.
`static long`	`dynamicQueryCount(DynamicQuery dynamicQuery)` Returns the number of rows matching the dynamic query.
`static long`	`dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)` Returns the number of rows matching the dynamic query.
`static void`	`enableStaging(long groupId)`
`static Group`	`fetchCompanyGroup(long companyId)` Returns the company's group.
`static Group`	`fetchFriendlyURLGroup(long companyId, String friendlyURL)` Returns the group with the matching friendly URL.
`static Group`	`fetchGroup(long groupId)`
`static Group`	`fetchGroup(long companyId, long classNameId, long classPK)`
`static Group`	`fetchGroup(long companyId, String groupKey)` Returns the group with the matching group key by first searching the system groups and then using the finder cache.
`static Group`	`fetchGroupByUuidAndCompanyId(String uuid, long companyId)` Returns the group with the matching UUID and company.
`static Group`	`fetchStagingGroup(long liveGroupId)`
`static Group`	`fetchUserGroup(long companyId, long userId)`
`static Group`	`fetchUserPersonalSiteGroup(long companyId)` Returns the default user's personal site group.
`static ActionableDynamicQuery`	`getActionableDynamicQuery()`
`static List<Long>`	`getActiveGroupIds(long userId)`
`static List<Group>`	`getActiveGroups(long companyId, boolean active)` Returns all the active or inactive groups associated with the company.
`static List<Group>`	`getActiveGroups(long companyId, boolean site, boolean active, int start, int end, OrderByComparator<Group> obc)` Returns the active or inactive groups associated with the company and, optionally, the main site.
`static List<Group>`	`getActiveGroups(long companyId, boolean active, int start, int end, OrderByComparator<Group> obc)` Returns the active or inactive groups associated with the company.
`static int`	`getActiveGroupsCount(long companyId, boolean active)` Returns the number of active or inactive groups associated with the company.
`static int`	`getActiveGroupsCount(long companyId, boolean active, boolean site)` Returns the number of active or inactive groups associated with the company.
`static Group`	`getCompanyGroup(long companyId)` Returns the company group.
`static List<Group>`	`getCompanyGroups(long companyId, int start, int end)` Returns a range of all the groups associated with the company.
`static int`	`getCompanyGroupsCount(long companyId)` Returns the number of groups associated with the company.
`static Group`	`getFriendlyURLGroup(long companyId, String friendlyURL)` Returns the group with the matching friendly URL.
`static Group`	`getGroup(long groupId)` Returns the group with the primary key.
`static Group`	`getGroup(long companyId, String groupKey)` Returns the group with the matching group key.
`static Group`	`getGroupByUuidAndCompanyId(String uuid, long companyId)` Returns the group with the matching UUID and company.
`static List<Group>`	`getGroups(int start, int end)` Returns a range of all the groups.
`static List<Group>`	`getGroups(long[] groupIds)` Returns the groups with the matching primary keys.
`static List<Group>`	`getGroups(long companyId, long parentGroupId, boolean site)` Returns all the groups that are direct children of the parent group.
`static List<Group>`	`getGroups(long companyId, long parentGroupId, boolean site, boolean inheritContent)`
`static List<Group>`	`getGroups(long companyId, long parentGroupId, boolean site, int start, int end)`
`static List<Group>`	`getGroups(long companyId, long parentGroupId, String name, boolean site, int start, int end)`
`static List<Group>`	`getGroups(long companyId, String treePath, boolean site)`
`static List<Group>`	`getGroups(long companyId, String className, long parentGroupId)` Returns all the groups that are direct children of the parent group with the matching className.
`static List<Group>`	`getGroups(long companyId, String className, long parentGroupId, int start, int end)` Returns a range of all the groups that are direct children of the parent group with the matching className.
`static int`	`getGroupsCount()` Returns the number of groups.
`static int`	`getGroupsCount(long companyId, long parentGroupId, boolean site)` Returns the number of groups that are direct children of the parent group.
`static int`	`getGroupsCount(long companyId, long parentGroupId, String name, boolean site)`
`static int`	`getGroupsCount(long companyId, String className, long parentGroupId)` Returns the number of groups that are direct children of the parent group with the matching className.
`static IndexableActionableDynamicQuery`	`getIndexableActionableDynamicQuery()`
`static Group`	`getLayoutGroup(long companyId, long plid)` Returns the group associated with the layout.
`static Group`	`getLayoutPrototypeGroup(long companyId, long layoutPrototypeId)` Returns the group associated with the layout prototype.
`static Group`	`getLayoutSetPrototypeGroup(long companyId, long layoutSetPrototypeId)` Returns the group associated with the layout set prototype.
`static List<Group>`	`getLayoutsGroups(long companyId, long parentGroupId, boolean site, boolean active, int start, int end, OrderByComparator<Group> obc)` Returns a range of all groups that are children of the parent group and that have at least one layout.
`static List<Group>`	`getLayoutsGroups(long companyId, long parentGroupId, boolean site, int start, int end, OrderByComparator<Group> obc)` Returns a range of all groups that are children of the parent group and that have at least one layout.
`static 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
`static 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
`static List<Group>`	`getLiveGroups()` Returns all live groups.
`static List<Group>`	`getNoLayoutsGroups(String className, boolean privateLayout, int start, int end)` Returns a range of all non-system groups of a specified type (className) that have no layouts.
`static List<Group>`	`getNullFriendlyURLGroups()` Deprecated. As of Judson (7.1.x), with no direct replacement
`static Group`	`getOrganizationGroup(long companyId, long organizationId)` Returns the specified organization group.
`static List<Group>`	`getOrganizationGroups(long organizationId)`
`static List<Group>`	`getOrganizationGroups(long organizationId, int start, int end)`
`static List<Group>`	`getOrganizationGroups(long organizationId, int start, int end, OrderByComparator<Group> orderByComparator)`
`static int`	`getOrganizationGroupsCount(long organizationId)`
`static long[]`	`getOrganizationPrimaryKeys(long groupId)` Returns the organizationIds of the organizations associated with the group.
`static List<Group>`	`getOrganizationsGroups(List<Organization> organizations)` Returns the specified organization groups.
`static List<Group>`	`getOrganizationsRelatedGroups(List<Organization> organizations)` Returns all the groups related to the organizations.
`static String`	`getOSGiServiceIdentifier()` Returns the OSGi service identifier.
`static List<Group>`	`getParentGroups(long groupId)` Returns the group followed by all its parent groups ordered by closest ancestor.
`static PersistedModel`	`getPersistedModel(Serializable primaryKeyObj)`
`static List<Group>`	`getRoleGroups(long roleId)`
`static List<Group>`	`getRoleGroups(long roleId, int start, int end)`
`static List<Group>`	`getRoleGroups(long roleId, int start, int end, OrderByComparator<Group> orderByComparator)`
`static int`	`getRoleGroupsCount(long roleId)`
`static long[]`	`getRolePrimaryKeys(long groupId)` Returns the roleIds of the roles associated with the group.
`static GroupLocalService`	`getService()`
`static List<Group>`	`getStagedSites()`
`static Group`	`getStagingGroup(long liveGroupId)` Returns the staging group.
`static Group`	`getUserGroup(long companyId, long userId)` Returns the group directly associated with the user.
`static Group`	`getUserGroupGroup(long companyId, long userGroupId)` Returns the specified "user group" group.
`static List<Group>`	`getUserGroupGroups(long userGroupId)`
`static List<Group>`	`getUserGroupGroups(long userGroupId, int start, int end)`
`static List<Group>`	`getUserGroupGroups(long userGroupId, int start, int end, OrderByComparator<Group> orderByComparator)`
`static int`	`getUserGroupGroupsCount(long userGroupId)`
`static long[]`	`getUserGroupPrimaryKeys(long groupId)` Returns the userGroupIds of the user groups associated with the group.
`static List<Group>`	`getUserGroups(long userId)`
`static List<Group>`	`getUserGroups(long userId, boolean inherit)` Returns all the user's site groups and immediate organization groups, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`getUserGroups(long userId, boolean inherit, int start, int end)` Returns an ordered range of all the user's site groups and immediate organization groups, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`getUserGroups(long userId, int start, int end)`
`static List<Group>`	`getUserGroups(long userId, int start, int end, OrderByComparator<Group> orderByComparator)`
`static int`	`getUserGroupsCount(long userId)`
`static List<Group>`	`getUserGroupsGroups(List<UserGroup> userGroups)` Returns the groups associated with the user groups.
`static List<Group>`	`getUserGroupsRelatedGroups(List<UserGroup> userGroups)` Returns all the groups related to the user groups.
`static List<Group>`	`getUserOrganizationsGroups(long userId, int start, int end)` Returns the range of all groups associated with the user's organization groups, including the ancestors of the organization groups, unless portal property `organizations.membership.strict` is set to `true`.
`static Group`	`getUserPersonalSiteGroup(long companyId)` Returns the default user's personal site group.
`static long[]`	`getUserPrimaryKeys(long groupId)` Returns the userIds of the users associated with the group.
`static List<Group>`	`getUserSitesGroups(long userId)`
`static List<Group>`	`getUserSitesGroups(long userId, boolean includeAdministrative)`
`static boolean`	`hasOrganizationGroup(long organizationId, long groupId)`
`static boolean`	`hasOrganizationGroups(long organizationId)`
`static boolean`	`hasRoleGroup(long roleId, long groupId)`
`static boolean`	`hasRoleGroups(long roleId)`
`static boolean`	`hasStagingGroup(long liveGroupId)` Returns `true` if the live group has a staging group.
`static boolean`	`hasUserGroup(long userId, long groupId)`
`static 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.
`static boolean`	`hasUserGroupGroup(long userGroupId, long groupId)`
`static boolean`	`hasUserGroupGroups(long userGroupId)`
`static boolean`	`hasUserGroups(long userId)`
`static boolean`	`isLiveGroupActive(Group group)`
`static Group`	`loadFetchGroup(long companyId, String groupKey)` Returns the group with the matching group key by first searching the system groups and then using the finder cache.
`static Group`	`loadGetGroup(long companyId, String groupKey)` Returns the group with the matching group key.
`static void`	`rebuildTree(long companyId)` Rebuilds the group tree.
`static List<Group>`	`search(long companyId, LinkedHashMap<String,Object> params, int start, int end)` Returns an ordered range of all the company's groups, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, long[] classNameIds, long parentGroupId, String keywords, LinkedHashMap<String,Object> params, int start, int end)` Returns an ordered range of all the groups belonging to the parent group that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, long[] classNameIds, long parentGroupId, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Group> obc)` Returns an ordered range of all the groups belonging to the parent group that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, long[] classNameIds, long parentGroupId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end)` Returns an ordered range of all the groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, long[] classNameIds, long parentGroupId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> obc)` Returns an ordered range of all the groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, long[] classNameIds, String keywords, LinkedHashMap<String,Object> params, int start, int end)` Returns an ordered range of all the groups that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, long[] classNameIds, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Group> obc)` Returns an ordered range of all the groups that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end)` Returns an ordered range of all the groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> obc)` Returns an ordered range of all the groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, long parentGroupId, String keywords, LinkedHashMap<String,Object> params, int start, int end)` Returns an ordered range of all the groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, long parentGroupId, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Group> obc)` Returns an ordered range of all the groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, long parentGroupId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end)` Returns an ordered range of all the site groups belonging to the parent group and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, long parentGroupId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> obc)` Returns an ordered range of all the site groups belonging to the parent group and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end)` Returns an ordered range of all the groups that match the keywords, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Group> obc)` Returns an ordered range of all the groups that match the keywords, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end)` Returns an ordered range of all the site groups and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> obc)` Returns an ordered range of all the site groups and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.
`static int`	`searchCount(long companyId, long[] classNameIds, long parentGroupId, String keywords, LinkedHashMap<String,Object> params)` Returns the number of groups belonging to the parent group that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups.
`static int`	`searchCount(long companyId, long[] classNameIds, long parentGroupId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator)` Returns the number of groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.
`static int`	`searchCount(long companyId, long[] classNameIds, String keywords, LinkedHashMap<String,Object> params)` Returns the number of groups that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups.
`static int`	`searchCount(long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator)` Returns the number of groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.
`static int`	`searchCount(long companyId, long parentGroupId, String keywords, LinkedHashMap<String,Object> params)` Returns the number of groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups.
`static int`	`searchCount(long companyId, long parentGroupId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator)` Returns the number of groups belonging to the parent group and immediate organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.
`static int`	`searchCount(long companyId, String keywords, LinkedHashMap<String,Object> params)` Returns the number of groups that match the keywords, optionally including the user's inherited organization groups and user groups.
`static int`	`searchCount(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator)` Returns the number of groups and immediate organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.
`static void`	`setOrganizationGroups(long organizationId, long[] groupIds)`
`static void`	`setRoleGroups(long roleId, long[] groupIds)`
`static void`	`setUserGroupGroups(long userGroupId, long[] groupIds)`
`static void`	`setUserGroups(long userId, long[] groupIds)`
`static void`	`unsetRoleGroups(long roleId, long[] groupIds)` Removes the groups from the role.
`static void`	`unsetUserGroups(long userId, long[] groupIds)` Removes the user from the groups.
`static void`	`updateAsset(long userId, Group group, long[] assetCategoryIds, String[] assetTagNames)` Updates the group's asset replacing categories and tag names.
`static Group`	`updateFriendlyURL(long groupId, String friendlyURL)` Updates the group's friendly URL.
`static Group`	`updateGroup(Group group)` Updates the group in the database or adds it if it does not yet exist.
`static Group`	`updateGroup(long groupId, long parentGroupId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean inheritContent, boolean active, ServiceContext serviceContext)`
`static Group`	`updateGroup(long groupId, String typeSettings)` Updates the group's type settings.
`static Group`	`updateSite(long groupId, boolean site)` Associates the group with a main site if the group is an organization.
`static void`	`validateRemote(long groupId, String remoteAddress, int remotePort, String remotePathContext, boolean secureConnection, long remoteGroupId)`

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

- Constructor Detail
  - GroupLocalServiceUtil
```
public GroupLocalServiceUtil()
```
- Method Detail
  - addGroup
```
public static Group addGroup(Group group)
```
    Adds the group to the database. Also notifies the appropriate model listeners.
    
    Parameters:
    
    group - the group
    
    Returns:
    
    the group that was added
  - addGroup
```
public static Group addGroup(long userId,
                             long parentGroupId,
                             String className,
                             long classPK,
                             long liveGroupId,
                             Map<Locale,String> nameMap,
                             Map<Locale,String> descriptionMap,
                             int type,
                             boolean manualMembership,
                             int membershipRestriction,
                             String friendlyURL,
                             boolean site,
                             boolean inheritContent,
                             boolean active,
                             ServiceContext serviceContext)
                      throws PortalException
```
    Throws:
    
    PortalException
  - addGroup
```
public static Group addGroup(long userId,
                             long parentGroupId,
                             String className,
                             long classPK,
                             long liveGroupId,
                             Map<Locale,String> nameMap,
                             Map<Locale,String> descriptionMap,
                             int type,
                             boolean manualMembership,
                             int membershipRestriction,
                             String friendlyURL,
                             boolean site,
                             boolean active,
                             ServiceContext serviceContext)
                      throws PortalException
```
    Throws:
    
    PortalException
  - addOrganizationGroup
```
public static void addOrganizationGroup(long organizationId,
                                        Group group)
```
  - addOrganizationGroup
```
public static void addOrganizationGroup(long organizationId,
                                        long groupId)
```
  - addOrganizationGroups
```
public static void addOrganizationGroups(long organizationId,
                                         List<Group> groups)
```
  - addOrganizationGroups
```
public static void addOrganizationGroups(long organizationId,
                                         long[] groupIds)
```
  - addRoleGroup
```
public static void addRoleGroup(long roleId,
                                Group group)
```
  - addRoleGroup
```
public static void addRoleGroup(long roleId,
                                long groupId)
```
  - addRoleGroups
```
public static void addRoleGroups(long roleId,
                                 List<Group> groups)
```
  - addRoleGroups
```
public static void addRoleGroups(long roleId,
                                 long[] groupIds)
```
  - addUserGroup
```
public static void addUserGroup(long userId,
                                Group group)
```
  - addUserGroup
```
public static void addUserGroup(long userId,
                                long groupId)
```
  - addUserGroupGroup
```
public static void addUserGroupGroup(long userGroupId,
                                     Group group)
```
  - addUserGroupGroup
```
public static void addUserGroupGroup(long userGroupId,
                                     long groupId)
```
  - addUserGroupGroups
```
public static void addUserGroupGroups(long userGroupId,
                                      List<Group> groups)
```
  - addUserGroupGroups
```
public static void addUserGroupGroups(long userGroupId,
                                      long[] groupIds)
```
  - addUserGroups
```
public static void addUserGroups(long userId,
                                 List<Group> groups)
```
  - addUserGroups
```
public static void addUserGroups(long userId,
                                 long[] groupIds)
```
  - checkCompanyGroup
```
public static void checkCompanyGroup(long companyId)
                              throws PortalException
```
    Adds a company group if it does not exist. This method is typically used when a virtual host is added.
    
    Parameters:
    
    companyId - the primary key of the company
    
    Throws:
    
    PortalException - if a portal exception occurred
  - checkScopeGroup
```
public static Group checkScopeGroup(Layout layout,
                                    long userId)
                             throws PortalException
```
    Throws:
    
    PortalException
  - checkSystemGroups
```
public static void checkSystemGroups(long companyId)
                              throws PortalException
```
    Creates systems groups and other related data needed by the system on the very first startup. Also takes care of creating the Control Panel groups and layouts.
    
    Parameters:
    
    companyId - the primary key of the company
    
    Throws:
    
    PortalException - if a portal exception occurred
  - clearOrganizationGroups
```
public static void clearOrganizationGroups(long organizationId)
```
  - clearRoleGroups
```
public static void clearRoleGroups(long roleId)
```
  - clearUserGroupGroups
```
public static void clearUserGroupGroups(long userGroupId)
```
  - clearUserGroups
```
public static void clearUserGroups(long userId)
```
  - createGroup
```
public static Group createGroup(long groupId)
```
    Creates a new group with the primary key. Does not add the group to the database.
    
    Parameters:
    
    groupId - the primary key for the new group
    
    Returns:
    
    the new group
  - deleteGroup
```
public static Group deleteGroup(Group group)
                         throws PortalException
```
    Deletes the group from the database. Also notifies the appropriate model listeners.
    
    Parameters:
    
    group - the group
    
    Returns:
    
    the group that was removed
    
    Throws:
    
    PortalException
  - deleteGroup
```
public static Group deleteGroup(long groupId)
                         throws PortalException
```
    Deletes the group with the primary key from the database. Also notifies the appropriate model listeners.
    
    Parameters:
    
    groupId - the primary key of the group
    
    Returns:
    
    the group that was removed
    
    Throws:
    
    PortalException - if a group with the primary key could not be found
  - deleteOrganizationGroup
```
public static void deleteOrganizationGroup(long organizationId,
                                           Group group)
```
  - deleteOrganizationGroup
```
public static void deleteOrganizationGroup(long organizationId,
                                           long groupId)
```
  - deleteOrganizationGroups
```
public static void deleteOrganizationGroups(long organizationId,
                                            List<Group> groups)
```
  - deleteOrganizationGroups
```
public static void deleteOrganizationGroups(long organizationId,
                                            long[] groupIds)
```
  - deletePersistedModel
```
public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException
```
    Throws:
    
    PortalException
  - deleteRoleGroup
```
public static void deleteRoleGroup(long roleId,
                                   Group group)
```
  - deleteRoleGroup
```
public static void deleteRoleGroup(long roleId,
                                   long groupId)
```
  - deleteRoleGroups
```
public static void deleteRoleGroups(long roleId,
                                    List<Group> groups)
```
  - deleteRoleGroups
```
public static void deleteRoleGroups(long roleId,
                                    long[] groupIds)
```
  - deleteUserGroup
```
public static void deleteUserGroup(long userId,
                                   Group group)
```
  - deleteUserGroup
```
public static void deleteUserGroup(long userId,
                                   long groupId)
```
  - deleteUserGroupGroup
```
public static void deleteUserGroupGroup(long userGroupId,
                                        Group group)
```
  - deleteUserGroupGroup
```
public static void deleteUserGroupGroup(long userGroupId,
                                        long groupId)
```
  - deleteUserGroupGroups
```
public static void deleteUserGroupGroups(long userGroupId,
                                         List<Group> groups)
```
  - deleteUserGroupGroups
```
public static void deleteUserGroupGroups(long userGroupId,
                                         long[] groupIds)
```
  - deleteUserGroups
```
public static void deleteUserGroups(long userId,
                                    List<Group> groups)
```
  - deleteUserGroups
```
public static void deleteUserGroups(long userId,
                                    long[] groupIds)
```
  - disableStaging
```
public static void disableStaging(long groupId)
                           throws PortalException
```
    Throws:
    
    PortalException
  - dynamicQuery
```
public static DynamicQuery dynamicQuery()
```
  - dynamicQuery
```
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
```
    Performs a dynamic query on the database and returns the matching rows.
    
    Parameters:
    
    dynamicQuery - the dynamic query
    
    Returns:
    
    the matching rows
  - dynamicQuery
```
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end)
```
    Performs a dynamic query on the database and returns a range of the matching rows.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.GroupModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
    
    Parameters:
    
    dynamicQuery - the dynamic query
    
    start - the lower bound of the range of model instances
    
    end - the upper bound of the range of model instances (not inclusive)
    
    Returns:
    
    the range of matching rows
  - dynamicQuery
```
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end,
                                       OrderByComparator<T> orderByComparator)
```
    Performs a dynamic query on the database and returns an ordered range of the matching rows.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.GroupModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
    
    Parameters:
    
    dynamicQuery - the dynamic query
    
    start - the lower bound of the range of model instances
    
    end - the upper bound of the range of model instances (not inclusive)
    
    orderByComparator - the comparator to order the results by (optionally null)
    
    Returns:
    
    the ordered range of matching rows
  - dynamicQueryCount
```
public static long dynamicQueryCount(DynamicQuery dynamicQuery)
```
    Returns the number of rows matching the dynamic query.
    
    Parameters:
    
    dynamicQuery - the dynamic query
    
    Returns:
    
    the number of rows matching the dynamic query
  - dynamicQueryCount
```
public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
```
    Returns the number of rows matching the dynamic query.
    
    Parameters:
    
    dynamicQuery - the dynamic query
    
    projection - the projection to apply to the query
    
    Returns:
    
    the number of rows matching the dynamic query
  - enableStaging
```
public static void enableStaging(long groupId)
                          throws PortalException
```
    Throws:
    
    PortalException
  - fetchCompanyGroup
```
public static 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 static Group fetchFriendlyURLGroup(long companyId,
                                          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
```
public static Group fetchGroup(long groupId)
```
  - fetchGroup
```
public static Group fetchGroup(long companyId,
                               long classNameId,
                               long classPK)
```
  - fetchGroup
```
public static Group fetchGroup(long companyId,
                               String groupKey)
```
    Returns the group with the matching group key by first searching the system groups and then using the finder cache.
    
    Parameters:
    
    companyId - the primary key of the company
    
    groupKey - the group key
    
    Returns:
    
    the group with the group key and associated company, or null if a matching group could not be found
  - fetchGroupByUuidAndCompanyId
```
public static Group fetchGroupByUuidAndCompanyId(String uuid,
                                                 long companyId)
```
    Returns the group with the matching UUID and company.
    
    Parameters:
    
    uuid - the group's UUID
    
    companyId - the primary key of the company
    
    Returns:
    
    the matching group, or null if a matching group could not be found
  - fetchStagingGroup
```
public static Group fetchStagingGroup(long liveGroupId)
```
  - fetchUserGroup
```
public static Group fetchUserGroup(long companyId,
                                   long userId)
```
  - fetchUserPersonalSiteGroup
```
public static Group fetchUserPersonalSiteGroup(long companyId)
                                        throws 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:
    
    PortalException - if a portal exception occurred
  - getActionableDynamicQuery
```
public static ActionableDynamicQuery getActionableDynamicQuery()
```
  - getActiveGroupIds
```
public static List<Long> getActiveGroupIds(long userId)
```
  - getActiveGroups
```
public static List<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
  - getActiveGroups
```
public static List<Group> getActiveGroups(long companyId,
                                          boolean site,
                                          boolean active,
                                          int start,
                                          int end,
                                          OrderByComparator<Group> obc)
```
    Returns the active or inactive groups associated with the company and, optionally, the main site.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    Parameters:
    
    companyId - the primary key of the company
    
    site - whether the group is associated with a main site
    
    active - whether to return only active groups or only inactive groups
    
    start - the lower bound of the range of groups to return
    
    end - the upper bound of the range of groups to return (not inclusive)
    
    obc - the comparator to order the groups (optionally null)
    
    Returns:
    
    the active or inactive groups
  - getActiveGroups
```
public static List<Group> getActiveGroups(long companyId,
                                          boolean active,
                                          int start,
                                          int end,
                                          OrderByComparator<Group> obc)
```
    Returns the active or inactive groups associated with the company.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    Parameters:
    
    companyId - the primary key of the company
    
    active - whether to return only active groups or only inactive groups
    
    start - the lower bound of the range of groups to return
    
    end - the upper bound of the range of groups to return (not inclusive)
    
    obc - the comparator to order the groups (optionally null)
    
    Returns:
    
    the active or inactive groups
  - getActiveGroupsCount
```
public static 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
  - getActiveGroupsCount
```
public static 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
  - getCompanyGroup
```
public static Group getCompanyGroup(long companyId)
                             throws PortalException
```
    Returns the company group.
    
    Parameters:
    
    companyId - the primary key of the company
    
    Returns:
    
    the group associated with the company
    
    Throws:
    
    PortalException - if a portal exception occurred
  - getCompanyGroups
```
public static List<Group> getCompanyGroups(long companyId,
                                           int start,
                                           int end)
```
    Returns a range of all the groups associated with the company.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    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 static 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 static Group getFriendlyURLGroup(long companyId,
                                        String friendlyURL)
                                 throws 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:
    
    PortalException - if a portal exception occurred
  - getGroup
```
public static Group getGroup(long groupId)
                      throws PortalException
```
    Returns the group with the primary key.
    
    Parameters:
    
    groupId - the primary key of the group
    
    Returns:
    
    the group
    
    Throws:
    
    PortalException - if a group with the primary key could not be found
  - getGroup
```
public static Group getGroup(long companyId,
                             String groupKey)
                      throws 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:
    
    PortalException - if a portal exception occurred
  - getGroupByUuidAndCompanyId
```
public static Group getGroupByUuidAndCompanyId(String uuid,
                                               long companyId)
                                        throws PortalException
```
    Returns the group with the matching UUID and company.
    
    Parameters:
    
    uuid - the group's UUID
    
    companyId - the primary key of the company
    
    Returns:
    
    the matching group
    
    Throws:
    
    PortalException - if a matching group could not be found
  - getGroups
```
public static List<Group> getGroups(int start,
                                    int end)
```
    Returns a range of all the groups.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.GroupModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
    
    Parameters:
    
    start - the lower bound of the range of groups
    
    end - the upper bound of the range of groups (not inclusive)
    
    Returns:
    
    the range of groups
  - getGroups
```
public static List<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 static List<Group> getGroups(long companyId,
                                    long parentGroupId,
                                    boolean site,
                                    boolean inheritContent)
```
  - getGroups
```
public static List<Group> getGroups(long companyId,
                                    long parentGroupId,
                                    boolean site,
                                    int start,
                                    int end)
```
  - getGroups
```
public static List<Group> getGroups(long companyId,
                                    long parentGroupId,
                                    String name,
                                    boolean site,
                                    int start,
                                    int end)
```
  - getGroups
```
public static List<Group> getGroups(long companyId,
                                    String treePath,
                                    boolean site)
```
  - getGroups
```
public static List<Group> getGroups(long companyId,
                                    String className,
                                    long parentGroupId)
```
    Returns all the groups that are direct children of the parent group with the matching className.
    
    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 static List<Group> getGroups(long companyId,
                                    String className,
                                    long parentGroupId,
                                    int start,
                                    int end)
```
    Returns a range of all the groups that are direct children of the parent group with the matching className.
    
    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 static List<Group> getGroups(long[] groupIds)
                             throws 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:
    
    PortalException - if a portal exception occurred
  - getGroupsCount
```
public static int getGroupsCount()
```
    Returns the number of groups.
    
    Returns:
    
    the number of groups
  - getGroupsCount
```
public static 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 static int getGroupsCount(long companyId,
                                 long parentGroupId,
                                 String name,
                                 boolean site)
```
  - getGroupsCount
```
public static int getGroupsCount(long companyId,
                                 String className,
                                 long parentGroupId)
```
    Returns the number of groups that are direct children of the parent group with the matching className.
    
    Parameters:
    
    companyId - the primary key of the company
    
    className - the class name of the group
    
    parentGroupId - the primary key of the parent group
    
    Returns:
    
    the number of matching groups
  - getIndexableActionableDynamicQuery
```
public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
```
  - getLayoutGroup
```
public static Group getLayoutGroup(long companyId,
                                   long plid)
                            throws 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:
    
    PortalException - if a portal exception occurred
  - getLayoutPrototypeGroup
```
public static Group getLayoutPrototypeGroup(long companyId,
                                            long layoutPrototypeId)
                                     throws 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:
    
    PortalException - if a portal exception occurred
  - getLayoutSetPrototypeGroup
```
public static Group getLayoutSetPrototypeGroup(long companyId,
                                               long layoutSetPrototypeId)
                                        throws 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:
    
    PortalException - if a portal exception occurred
  - getLayoutsGroups
```
public static List<Group> getLayoutsGroups(long companyId,
                                           long parentGroupId,
                                           boolean site,
                                           boolean active,
                                           int start,
                                           int end,
                                           OrderByComparator<Group> obc)
```
    Returns a range of all groups that are children of the parent group and that have at least one layout.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    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 static List<Group> getLayoutsGroups(long companyId,
                                           long parentGroupId,
                                           boolean site,
                                           int start,
                                           int end,
                                           OrderByComparator<Group> obc)
```
    Returns a range of all groups that are children of the parent group and that have at least one layout.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    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 static 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 static 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 static List<Group> getLiveGroups()
```
    Returns all live groups.
    
    Returns:
    
    all live groups
  - getNoLayoutsGroups
```
public static List<Group> getNoLayoutsGroups(String className,
                                             boolean privateLayout,
                                             int start,
                                             int end)
```
    Returns a range of all non-system groups of a specified type (className) that have no layouts.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    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 static List<Group> getNullFriendlyURLGroups()
```
    Deprecated. As of Judson (7.1.x), with no direct replacement
    
    Returns all non-system groups having null or empty friendly URLs.
    
    Returns:
    
    the non-system groups having null or empty friendly URLs
  - getOrganizationGroup
```
public static Group getOrganizationGroup(long companyId,
                                         long organizationId)
                                  throws 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:
    
    PortalException - if a portal exception occurred
  - getOrganizationGroups
```
public static List<Group> getOrganizationGroups(long organizationId)
```
  - getOrganizationGroups
```
public static List<Group> getOrganizationGroups(long organizationId,
                                                int start,
                                                int end)
```
  - getOrganizationGroups
```
public static List<Group> getOrganizationGroups(long organizationId,
                                                int start,
                                                int end,
                                                OrderByComparator<Group> orderByComparator)
```
  - getOrganizationGroupsCount
```
public static int getOrganizationGroupsCount(long organizationId)
```
  - getOrganizationPrimaryKeys
```
public static long[] getOrganizationPrimaryKeys(long groupId)
```
    Returns the organizationIds of the organizations associated with the group.
    
    Parameters:
    
    groupId - the groupId of the group
    
    Returns:
    
    long[] the organizationIds of organizations associated with the group
  - getOrganizationsGroups
```
public static List<Group> getOrganizationsGroups(List<Organization> organizations)
```
    Returns the specified organization groups.
    
    Parameters:
    
    organizations - the organizations
    
    Returns:
    
    the groups associated with the organizations
  - getOrganizationsRelatedGroups
```
public static List<Group> getOrganizationsRelatedGroups(List<Organization> organizations)
```
    Returns all the groups related to the organizations.
    
    Parameters:
    
    organizations - the organizations
    
    Returns:
    
    the groups related to the organizations
  - getOSGiServiceIdentifier
```
public static String getOSGiServiceIdentifier()
```
    Returns the OSGi service identifier.
    
    Returns:
    
    the OSGi service identifier
  - getParentGroups
```
public static List<Group> getParentGroups(long groupId)
                                   throws 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:
    
    PortalException - if a portal exception occurred
  - getPersistedModel
```
public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException
```
    Throws:
    
    PortalException
  - getRoleGroups
```
public static List<Group> getRoleGroups(long roleId)
```
  - getRoleGroups
```
public static List<Group> getRoleGroups(long roleId,
                                        int start,
                                        int end)
```
  - getRoleGroups
```
public static List<Group> getRoleGroups(long roleId,
                                        int start,
                                        int end,
                                        OrderByComparator<Group> orderByComparator)
```
  - getRoleGroupsCount
```
public static int getRoleGroupsCount(long roleId)
```
  - getRolePrimaryKeys
```
public static long[] getRolePrimaryKeys(long groupId)
```
    Returns the roleIds of the roles associated with the group.
    
    Parameters:
    
    groupId - the groupId of the group
    
    Returns:
    
    long[] the roleIds of roles associated with the group
  - getStagedSites
```
public static List<Group> getStagedSites()
```
  - getStagingGroup
```
public static Group getStagingGroup(long liveGroupId)
                             throws PortalException
```
    Returns the staging group.
    
    Parameters:
    
    liveGroupId - the primary key of the live group
    
    Returns:
    
    the staging group
    
    Throws:
    
    PortalException - if a portal exception occurred
  - getUserGroup
```
public static Group getUserGroup(long companyId,
                                 long userId)
                          throws 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:
    
    PortalException - if a portal exception occurred
  - getUserGroupGroup
```
public static Group getUserGroupGroup(long companyId,
                                      long userGroupId)
                               throws 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:
    
    PortalException - if a portal exception occurred
  - getUserGroupGroups
```
public static List<Group> getUserGroupGroups(long userGroupId)
```
  - getUserGroupGroups
```
public static List<Group> getUserGroupGroups(long userGroupId,
                                             int start,
                                             int end)
```
  - getUserGroupGroups
```
public static List<Group> getUserGroupGroups(long userGroupId,
                                             int start,
                                             int end,
                                             OrderByComparator<Group> orderByComparator)
```
  - getUserGroupGroupsCount
```
public static int getUserGroupGroupsCount(long userGroupId)
```
  - getUserGroupPrimaryKeys
```
public static long[] getUserGroupPrimaryKeys(long groupId)
```
    Returns the userGroupIds of the user groups associated with the group.
    
    Parameters:
    
    groupId - the groupId of the group
    
    Returns:
    
    long[] the userGroupIds of user groups associated with the group
  - getUserGroups
```
public static List<Group> getUserGroups(long userId)
```
  - getUserGroups
```
public static List<Group> getUserGroups(long userId,
                                        boolean inherit)
                                 throws PortalException
```
    Returns all the user's site groups and immediate organization groups, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    
    Parameters:
    
    userId - the primary key of the user
    
    inherit - whether to include the user's inherited organization groups and user groups
    
    Returns:
    
    the user's groups and immediate organization groups
    
    Throws:
    
    PortalException - if a portal exception occurred
  - getUserGroups
```
public static List<Group> getUserGroups(long userId,
                                        boolean inherit,
                                        int start,
                                        int end)
                                 throws PortalException
```
    Returns an ordered range of all the user's site groups and immediate organization groups, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    Parameters:
    
    userId - the primary key of the user
    
    inherit - whether to include the user's inherited organization groups and user groups
    
    start - the lower bound of the range of groups to return
    
    end - the upper bound of the range of groups to return (not inclusive)
    
    Returns:
    
    the range of the user's groups and immediate organization groups ordered by name
    
    Throws:
    
    PortalException - if a portal exception occurred
  - getUserGroups
```
public static List<Group> getUserGroups(long userId,
                                        int start,
                                        int end)
```
  - getUserGroups
```
public static List<Group> getUserGroups(long userId,
                                        int start,
                                        int end,
                                        OrderByComparator<Group> orderByComparator)
                                 throws PortalException
```
    Throws:
    
    PortalException
  - getUserGroupsCount
```
public static int getUserGroupsCount(long userId)
```
  - getUserGroupsGroups
```
public static List<Group> getUserGroupsGroups(List<UserGroup> userGroups)
                                       throws PortalException
```
    Returns the groups associated with the user groups.
    
    Parameters:
    
    userGroups - the user groups
    
    Returns:
    
    the groups associated with the user groups
    
    Throws:
    
    PortalException - if a portal exception occurred
  - getUserGroupsRelatedGroups
```
public static List<Group> getUserGroupsRelatedGroups(List<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 static List<Group> getUserOrganizationsGroups(long userId,
                                                     int start,
                                                     int end)
                                              throws PortalException
```
    Returns the range of all groups associated with the user's organization groups, including the ancestors of the organization groups, unless portal property organizations.membership.strict is set to true.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    Parameters:
    
    userId - the primary key of the user
    
    start - the lower bound of the range of groups to consider
    
    end - the upper bound of the range of groups to consider (not inclusive)
    
    Returns:
    
    the range of groups associated with the user's organization groups
    
    Throws:
    
    PortalException - if a portal exception occurred
  - getUserPersonalSiteGroup
```
public static Group getUserPersonalSiteGroup(long companyId)
                                      throws 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:
    
    PortalException - if a portal exception occurred
  - getUserPrimaryKeys
```
public static long[] getUserPrimaryKeys(long groupId)
```
    Returns the userIds of the users associated with the group.
    
    Parameters:
    
    groupId - the groupId of the group
    
    Returns:
    
    long[] the userIds of users associated with the group
  - getUserSitesGroups
```
public static List<Group> getUserSitesGroups(long userId)
                                      throws PortalException
```
    Throws:
    
    PortalException
  - getUserSitesGroups
```
public static List<Group> getUserSitesGroups(long userId,
                                             boolean includeAdministrative)
                                      throws PortalException
```
    Throws:
    
    PortalException
  - hasOrganizationGroup
```
public static boolean hasOrganizationGroup(long organizationId,
                                           long groupId)
```
  - hasOrganizationGroups
```
public static boolean hasOrganizationGroups(long organizationId)
```
  - hasRoleGroup
```
public static boolean hasRoleGroup(long roleId,
                                   long groupId)
```
  - hasRoleGroups
```
public static boolean hasRoleGroups(long roleId)
```
  - hasStagingGroup
```
public static 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 static boolean hasUserGroup(long userId,
                                   long groupId)
```
  - hasUserGroup
```
public static 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
  - hasUserGroupGroup
```
public static boolean hasUserGroupGroup(long userGroupId,
                                        long groupId)
```
  - hasUserGroupGroups
```
public static boolean hasUserGroupGroups(long userGroupId)
```
  - hasUserGroups
```
public static boolean hasUserGroups(long userId)
```
  - isLiveGroupActive
```
public static boolean isLiveGroupActive(Group group)
```
  - loadFetchGroup
```
public static Group loadFetchGroup(long companyId,
                                   String groupKey)
```
    Returns the group with the matching group key by first searching the system groups and then using the finder cache.
    
    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 static Group loadGetGroup(long companyId,
                                 String groupKey)
                          throws 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:
    
    PortalException - if a portal exception occurred
  - rebuildTree
```
public static void rebuildTree(long companyId)
                        throws PortalException
```
    Rebuilds the group tree.
    Only call this method if the tree has become stale through operations other than normal CRUD. Under normal circumstances the tree is automatically rebuilt whenever necessary.
    
    Parameters:
    
    companyId - the primary key of the group's company
    
    Throws:
    
    PortalException - if a portal exception occurred
  - search
```
public static List<Group> search(long companyId,
                                 LinkedHashMap<String,Object> params,
                                 int start,
                                 int end)
```
    Returns an ordered range of all the company's groups, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    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 static List<Group> search(long companyId,
                                 long parentGroupId,
                                 String keywords,
                                 LinkedHashMap<String,Object> params,
                                 int start,
                                 int end)
```
    Returns an ordered range of all the groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    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 static List<Group> search(long companyId,
                                 long parentGroupId,
                                 String keywords,
                                 LinkedHashMap<String,Object> params,
                                 int start,
                                 int end,
                                 OrderByComparator<Group> obc)
```
    Returns an ordered range of all the groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    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 static List<Group> search(long companyId,
                                 long parentGroupId,
                                 String name,
                                 String description,
                                 LinkedHashMap<String,Object> params,
                                 boolean andOperator,
                                 int start,
                                 int end)
```
    Returns an ordered range of all the site groups belonging to the parent group and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    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 static List<Group> search(long companyId,
                                 long parentGroupId,
                                 String name,
                                 String description,
                                 LinkedHashMap<String,Object> params,
                                 boolean andOperator,
                                 int start,
                                 int end,
                                 OrderByComparator<Group> obc)
```
    Returns an ordered range of all the site groups belonging to the parent group and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    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 static List<Group> search(long companyId,
                                 long[] classNameIds,
                                 long parentGroupId,
                                 String keywords,
                                 LinkedHashMap<String,Object> params,
                                 int start,
                                 int end)
```
    Returns an ordered range of all the groups belonging to the parent group that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    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 static List<Group> search(long companyId,
                                 long[] classNameIds,
                                 long parentGroupId,
                                 String keywords,
                                 LinkedHashMap<String,Object> params,
                                 int start,
                                 int end,
                                 OrderByComparator<Group> obc)
```
    Returns an ordered range of all the groups belonging to the parent group that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    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 static List<Group> search(long companyId,
                                 long[] classNameIds,
                                 long parentGroupId,
                                 String name,
                                 String description,
                                 LinkedHashMap<String,Object> params,
                                 boolean andOperator,
                                 int start,
                                 int end)
```
    Returns an ordered range of all the groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    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 static List<Group> search(long companyId,
                                 long[] classNameIds,
                                 long parentGroupId,
                                 String name,
                                 String description,
                                 LinkedHashMap<String,Object> params,
                                 boolean andOperator,
                                 int start,
                                 int end,
                                 OrderByComparator<Group> obc)
```
    Returns an ordered range of all the groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    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 static List<Group> search(long companyId,
                                 long[] classNameIds,
                                 String keywords,
                                 LinkedHashMap<String,Object> params,
                                 int start,
                                 int end)
```
    Returns an ordered range of all the groups that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    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 static List<Group> search(long companyId,
                                 long[] classNameIds,
                                 String keywords,
                                 LinkedHashMap<String,Object> params,
                                 int start,
                                 int end,
                                 OrderByComparator<Group> obc)
```
    Returns an ordered range of all the groups that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    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 static List<Group> search(long companyId,
                                 long[] classNameIds,
                                 String name,
                                 String description,
                                 LinkedHashMap<String,Object> params,
                                 boolean andOperator,
                                 int start,
                                 int end)
```
    Returns an ordered range of all the groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    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 static List<Group> search(long companyId,
                                 long[] classNameIds,
                                 String name,
                                 String description,
                                 LinkedHashMap<String,Object> params,
                                 boolean andOperator,
                                 int start,
                                 int end,
                                 OrderByComparator<Group> obc)
```
    Returns an ordered range of all the groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    Parameters:
    
    companyId - the primary key of the company
    
    classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null)
    
    name - the group's name (optionally null)
    
    description - the group's description (optionally null)
    
    params - the finder params (optionally null). To include a user's organizations, inherited organizations, and user groups in the search, add an entry with key "usersGroups" mapped to the user's ID and an entry with key "inherit" mapped to a non-null object. For more information see GroupFinder.
    
    andOperator - whether every field must match its keywords, or just one field.
    
    start - the lower bound of the range of groups to return
    
    end - the upper bound of the range of groups to return (not inclusive)
    
    obc - the comparator to order the groups (optionally null)
    
    Returns:
    
    the matching groups ordered by comparator obc
  - search
```
public static List<Group> search(long companyId,
                                 String keywords,
                                 LinkedHashMap<String,Object> params,
                                 int start,
                                 int end)
```
    Returns an ordered range of all the groups that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    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 static List<Group> search(long companyId,
                                 String keywords,
                                 LinkedHashMap<String,Object> params,
                                 int start,
                                 int end,
                                 OrderByComparator<Group> obc)
```
    Returns an ordered range of all the groups that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    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 static List<Group> search(long companyId,
                                 String name,
                                 String description,
                                 LinkedHashMap<String,Object> params,
                                 boolean andOperator,
                                 int start,
                                 int end)
```
    Returns an ordered range of all the site groups and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    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 static List<Group> search(long companyId,
                                 String name,
                                 String description,
                                 LinkedHashMap<String,Object> params,
                                 boolean andOperator,
                                 int start,
                                 int end,
                                 OrderByComparator<Group> obc)
```
    Returns an ordered range of all the site groups and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    Parameters:
    
    companyId - the primary key of the company
    
    name - the group's name (optionally null)
    
    description - the group's description (optionally null)
    
    params - the finder params (optionally null). To include the user's inherited organizations and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder.
    
    andOperator - whether every field must match its keywords, or just one field.
    
    start - the lower bound of the range of groups to return
    
    end - the upper bound of the range of groups to return (not inclusive)
    
    obc - the comparator to order the groups (optionally null)
    
    Returns:
    
    the matching groups ordered by comparator obc
  - searchCount
```
public static int searchCount(long companyId,
                              long parentGroupId,
                              String keywords,
                              LinkedHashMap<String,Object> params)
```
    Returns the number of groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    
    Parameters:
    
    companyId - the primary key of the company
    
    parentGroupId - the primary key of the parent group
    
    keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null)
    
    params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder.
    
    Returns:
    
    the number of matching groups
  - searchCount
```
public static int searchCount(long companyId,
                              long parentGroupId,
                              String name,
                              String description,
                              LinkedHashMap<String,Object> params,
                              boolean andOperator)
```
    Returns the number of groups belonging to the parent group and immediate organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    
    Parameters:
    
    companyId - the primary key of the company
    
    parentGroupId - the primary key of the parent group
    
    name - the group's name (optionally null)
    
    description - the group's description (optionally null)
    
    params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder.
    
    andOperator - whether every field must match its keywords, or just one field.
    
    Returns:
    
    the number of matching groups
  - searchCount
```
public static int searchCount(long companyId,
                              long[] classNameIds,
                              long parentGroupId,
                              String keywords,
                              LinkedHashMap<String,Object> params)
```
    Returns the number of groups belonging to the parent group that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    
    Parameters:
    
    companyId - the primary key of the company
    
    classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null)
    
    parentGroupId - the primary key of the parent group
    
    keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null)
    
    params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder.
    
    Returns:
    
    the number of matching groups
  - searchCount
```
public static int searchCount(long companyId,
                              long[] classNameIds,
                              long parentGroupId,
                              String name,
                              String description,
                              LinkedHashMap<String,Object> params,
                              boolean andOperator)
```
    Returns the number of groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    
    Parameters:
    
    companyId - the primary key of the company
    
    classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null)
    
    parentGroupId - the primary key of the parent group
    
    name - the group's name (optionally null)
    
    description - the group's description (optionally null)
    
    params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder.
    
    andOperator - whether every field must match its keywords, or just one field.
    
    Returns:
    
    the number of matching groups
  - searchCount
```
public static int searchCount(long companyId,
                              long[] classNameIds,
                              String keywords,
                              LinkedHashMap<String,Object> params)
```
    Returns the number of groups that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    
    Parameters:
    
    companyId - the primary key of the company
    
    classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null)
    
    keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null)
    
    params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder.
    
    Returns:
    
    the number of matching groups
  - searchCount
```
public static int searchCount(long companyId,
                              long[] classNameIds,
                              String name,
                              String description,
                              LinkedHashMap<String,Object> params,
                              boolean andOperator)
```
    Returns the number of groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    
    Parameters:
    
    companyId - the primary key of the company
    
    classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null)
    
    name - the group's name (optionally null)
    
    description - the group's description (optionally null)
    
    params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder.
    
    andOperator - whether every field must match its keywords, or just one field.
    
    Returns:
    
    the number of matching groups
  - searchCount
```
public static int searchCount(long companyId,
                              String keywords,
                              LinkedHashMap<String,Object> params)
```
    Returns the number of groups that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    
    Parameters:
    
    companyId - the primary key of the company
    
    keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null)
    
    params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder.
    
    Returns:
    
    the number of matching groups
  - searchCount
```
public static int searchCount(long companyId,
                              String name,
                              String description,
                              LinkedHashMap<String,Object> params,
                              boolean andOperator)
```
    Returns the number of groups and immediate organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
    
    Parameters:
    
    companyId - the primary key of the company
    
    name - the group's name (optionally null)
    
    description - the group's description (optionally null)
    
    params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder.
    
    andOperator - whether every field must match its keywords, or just one field.
    
    Returns:
    
    the number of matching groups
  - setOrganizationGroups
```
public static void setOrganizationGroups(long organizationId,
                                         long[] groupIds)
```
  - setRoleGroups
```
public static void setRoleGroups(long roleId,
                                 long[] groupIds)
```
  - setUserGroupGroups
```
public static void setUserGroupGroups(long userGroupId,
                                      long[] groupIds)
```
  - setUserGroups
```
public static void setUserGroups(long userId,
                                 long[] groupIds)
```
  - unsetRoleGroups
```
public static 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 static 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 static void updateAsset(long userId,
                               Group group,
                               long[] assetCategoryIds,
                               String[] assetTagNames)
                        throws 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:
    
    PortalException - if a portal exception occurred
  - updateFriendlyURL
```
public static Group updateFriendlyURL(long groupId,
                                      String friendlyURL)
                               throws 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:
    
    PortalException - if a portal exception occurred
  - updateGroup
```
public static Group updateGroup(Group group)
```
    Updates the group in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
    
    Parameters:
    
    group - the group
    
    Returns:
    
    the group that was updated
  - updateGroup
```
public static Group updateGroup(long groupId,
                                long parentGroupId,
                                Map<Locale,String> nameMap,
                                Map<Locale,String> descriptionMap,
                                int type,
                                boolean manualMembership,
                                int membershipRestriction,
                                String friendlyURL,
                                boolean inheritContent,
                                boolean active,
                                ServiceContext serviceContext)
                         throws PortalException
```
    Throws:
    
    PortalException
  - updateGroup
```
public static Group updateGroup(long groupId,
                                String typeSettings)
                         throws 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:
    
    PortalException - if a portal exception occurred
  - updateSite
```
public static Group updateSite(long groupId,
                               boolean site)
                        throws 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:
    
    PortalException - if a portal exception occurred
  - validateRemote
```
public static void validateRemote(long groupId,
                                  String remoteAddress,
                                  int remotePort,
                                  String remotePathContext,
                                  boolean secureConnection,
                                  long remoteGroupId)
                           throws PortalException
```
    Throws:
    
    PortalException
  - getService
```
public static GroupLocalService getService()
```

Class GroupLocalServiceUtil

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

GroupLocalServiceUtil

Method Detail

addGroup

addGroup

addGroup

addOrganizationGroup

addOrganizationGroup

addOrganizationGroups

addOrganizationGroups

addRoleGroup

addRoleGroup

addRoleGroups

addRoleGroups

addUserGroup

addUserGroup

addUserGroupGroup

addUserGroupGroup

addUserGroupGroups

addUserGroupGroups

addUserGroups

addUserGroups

checkCompanyGroup

checkScopeGroup

checkSystemGroups

clearOrganizationGroups

clearRoleGroups

clearUserGroupGroups

clearUserGroups

createGroup

deleteGroup

deleteGroup

deleteOrganizationGroup

deleteOrganizationGroup

deleteOrganizationGroups

deleteOrganizationGroups

deletePersistedModel

deleteRoleGroup

deleteRoleGroup

deleteRoleGroups

deleteRoleGroups

deleteUserGroup

deleteUserGroup

deleteUserGroupGroup

deleteUserGroupGroup

deleteUserGroupGroups

deleteUserGroupGroups

deleteUserGroups

deleteUserGroups

disableStaging

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQueryCount

dynamicQueryCount

enableStaging

fetchCompanyGroup

fetchFriendlyURLGroup

fetchGroup

fetchGroup

fetchGroup

fetchGroupByUuidAndCompanyId

fetchStagingGroup

fetchUserGroup

fetchUserPersonalSiteGroup

getActionableDynamicQuery

getActiveGroupIds

getActiveGroups

getActiveGroups

getActiveGroups

getActiveGroupsCount

getActiveGroupsCount

getCompanyGroup

getCompanyGroups

getCompanyGroupsCount