GroupLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

GroupLocalServiceWrapper
```
@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface GroupLocalService
extends BaseLocalService, PersistedModelLocalService
```
Provides the local service interface for Group. 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:

GroupLocalServiceUtil, GroupLocalServiceBaseImpl, GroupLocalServiceImpl

Generated:

Method Summary

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

Method Detail

addGroup
```
@Indexable(type=REINDEX)
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

Group addGroup(long userId,
               long parentGroupId,
               java.lang.String className,
               long classPK,
               long liveGroupId,
               java.util.Map<java.util.Locale,java.lang.String> nameMap,
               java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
               int type,
               boolean manualMembership,
               int membershipRestriction,
               java.lang.String friendlyURL,
               boolean site,
               boolean inheritContent,
               boolean active,
               ServiceContext serviceContext)
        throws PortalException

Throws:: PortalException

addGroup

Group addGroup(long userId,
               long parentGroupId,
               java.lang.String className,
               long classPK,
               long liveGroupId,
               java.util.Map<java.util.Locale,java.lang.String> nameMap,
               java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
               int type,
               boolean manualMembership,
               int membershipRestriction,
               java.lang.String friendlyURL,
               boolean site,
               boolean active,
               ServiceContext serviceContext)
        throws PortalException

Throws:: PortalException

addGroup
```
@Deprecated
Group addGroup(long userId,
                           long parentGroupId,
                           java.lang.String className,
                           long classPK,
                           long liveGroupId,
                           java.lang.String name,
                           java.lang.String description,
                           int type,
                           boolean manualMembership,
                           int membershipRestriction,
                           java.lang.String friendlyURL,
                           boolean site,
                           boolean active,
                           ServiceContext serviceContext)
                    throws PortalException
```
Deprecated. As of Wilberforce (7.0.x), replaced by addGroup(long, long, String, long, long, Map, Map, int, boolean, int, String, boolean, boolean, ServiceContext)

Adds a group.

Parameters:

userId - the primary key of the group's creator/owner

parentGroupId - the primary key of the parent group

className - the entity's class name

classPK - the primary key of the entity's instance

liveGroupId - the primary key of the live group

name - the entity's name

description - the group's description (optionally null)

type - the group's type. For more information see GroupConstants.

manualMembership - whether manual membership is allowed for the group

membershipRestriction - the group's membership restriction. For more information see GroupConstants.

friendlyURL - the group's friendlyURL (optionally null)

site - whether the group is to be associated with a main site

active - whether the group is active

serviceContext - the service context to be applied (optionally null). Can set asset category IDs and asset tag names for the group, and whether the group is for staging.

Returns:

the group

Throws:

PortalException - if a portal exception occured

addOrganizationGroup

void addOrganizationGroup(long organizationId,
                          Group group)

addOrganizationGroup

void addOrganizationGroup(long organizationId,
                          long groupId)

addOrganizationGroups

void addOrganizationGroups(long organizationId,
                           java.util.List<Group> groups)

addOrganizationGroups

void addOrganizationGroups(long organizationId,
                           long[] groupIds)

addRoleGroup

void addRoleGroup(long roleId,
                  Group group)

addRoleGroup

void addRoleGroup(long roleId,
                  long groupId)

addRoleGroups

void addRoleGroups(long roleId,
                   java.util.List<Group> groups)

addRoleGroups

void addRoleGroups(long roleId,
                   long[] groupIds)

addUserGroup

void addUserGroup(long userId,
                  Group group)

addUserGroup

void addUserGroup(long userId,
                  long groupId)

addUserGroupGroup

void addUserGroupGroup(long userGroupId,
                       Group group)

addUserGroupGroup

void addUserGroupGroup(long userGroupId,
                       long groupId)

addUserGroupGroups

void addUserGroupGroups(long userGroupId,
                        java.util.List<Group> groups)

addUserGroupGroups

void addUserGroupGroups(long userGroupId,
                        long[] groupIds)

addUserGroups

void addUserGroups(long userId,
                   java.util.List<Group> groups)

addUserGroups

void addUserGroups(long userId,
                   long[] groupIds)

checkCompanyGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

Group checkScopeGroup(Layout layout,
                      long userId)
               throws PortalException

Throws:: PortalException

checkSystemGroups
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

void clearOrganizationGroups(long organizationId)

clearRoleGroups
```
void clearRoleGroups(long roleId)
```

clearUserGroupGroups

void clearUserGroupGroups(long userGroupId)

clearUserGroups
```
void clearUserGroups(long userId)
```

createGroup
```
@Transactional(enabled=false)
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
```
@Indexable(type=DELETE)
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
```
@Indexable(type=DELETE)
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

void deleteOrganizationGroup(long organizationId,
                             Group group)

deleteOrganizationGroup

void deleteOrganizationGroup(long organizationId,
                             long groupId)

deleteOrganizationGroups

void deleteOrganizationGroups(long organizationId,
                              java.util.List<Group> groups)

deleteOrganizationGroups

void deleteOrganizationGroups(long organizationId,
                              long[] groupIds)

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:: deletePersistedModel in interface PersistedModelLocalService
Throws:: PortalException

deleteRoleGroup

void deleteRoleGroup(long roleId,
                     Group group)

deleteRoleGroup

void deleteRoleGroup(long roleId,
                     long groupId)

deleteRoleGroups

void deleteRoleGroups(long roleId,
                      java.util.List<Group> groups)

deleteRoleGroups

void deleteRoleGroups(long roleId,
                      long[] groupIds)

deleteUserGroup

void deleteUserGroup(long userId,
                     Group group)

deleteUserGroup

void deleteUserGroup(long userId,
                     long groupId)

deleteUserGroupGroup

void deleteUserGroupGroup(long userGroupId,
                          Group group)

deleteUserGroupGroup

void deleteUserGroupGroup(long userGroupId,
                          long groupId)

deleteUserGroupGroups

void deleteUserGroupGroups(long userGroupId,
                           java.util.List<Group> groups)

deleteUserGroupGroups

void deleteUserGroupGroups(long userGroupId,
                           long[] groupIds)

deleteUserGroups

void deleteUserGroups(long userId,
                      java.util.List<Group> groups)

deleteUserGroups

void deleteUserGroups(long userId,
                      long[] groupIds)

disableStaging

void disableStaging(long groupId)
             throws PortalException

Throws:: PortalException

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                                      int start,
                                                                                                      int end)
```
Performs a dynamic query on the database and returns a range of the matching rows.
Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from GroupModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                                      int start,
                                                                                                      int end,
                                                                                                      OrderByComparator<T> orderByComparator)
```
Performs a dynamic query on the database and returns an ordered range of the matching rows.
Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from GroupModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

void enableStaging(long groupId)
            throws PortalException

Throws:: PortalException

fetchCompanyGroup
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Group fetchFriendlyURLGroup(long companyId,
                                                                                               java.lang.String friendlyURL)

Returns the group with the matching friendly URL.

Parameters:: companyId - the primary key of the company; friendlyURL - the friendly URL
Returns:: the group with the friendly URL, or null if a matching group could not be found

fetchGroup

@ThreadLocalCachable
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
Group fetchGroup(long groupId)

fetchGroup
```
@Skip
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
Group fetchGroup(long companyId,
                                                                                           java.lang.String groupKey)
```
Returns the group with the matching group key by first searching the system groups and then using the finder cache.

Parameters:

companyId - the primary key of the company

groupKey - the group key

Returns:

the group with the group key and associated company, or null if a matching group could not be found

fetchGroupByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Group fetchGroupByUuidAndCompanyId(java.lang.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Group fetchStagingGroup(long liveGroupId)

fetchUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Group fetchUserGroup(long companyId,
                                                                                        long userId)

fetchUserPersonalSiteGroup
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getActiveGroupIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<java.lang.Long> getActiveGroupIds(long userId)

getActiveGroups
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.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 associated with the company

getCompanyGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Group getFriendlyURLGroup(long companyId,
                                                                                             java.lang.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

@ThreadLocalCachable
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Skip
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
Group getGroup(long companyId,
                                                                                         java.lang.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Group getGroupByUuidAndCompanyId(java.lang.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

getGroupDescriptiveName

@Deprecated
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
java.lang.String getGroupDescriptiveName(Group group,
                                                                                                                         java.util.Locale locale)
                                                                                                                  throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by Group.getDescriptiveName(Locale)

Throws:: PortalException

getGroupDescriptiveName

@Deprecated
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
java.lang.String getGroupDescriptiveName(long groupId,
                                                                                                                         java.util.Locale locale)
                                                                                                                  throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by Group.getDescriptiveName(Locale)

Throws:: PortalException

getGroups
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getGroups(int start,
                                                                                                   int end)
```
Returns a range of all the groups.
Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from GroupModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getGroups(long companyId,
                                                                                                   long parentGroupId,
                                                                                                   boolean site,
                                                                                                   boolean inheritContent)

getGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getGroups(long companyId,
                                                                                                   long parentGroupId,
                                                                                                   boolean site,
                                                                                                   int start,
                                                                                                   int end)

getGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getGroups(long companyId,
                                                                                                   long parentGroupId,
                                                                                                   java.lang.String name,
                                                                                                   boolean site,
                                                                                                   int start,
                                                                                                   int end)

getGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getGroups(long companyId,
                                                                                                   java.lang.String treePath,
                                                                                                   boolean site)

getGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getGroups(long companyId,
                                                                                                   java.lang.String className,
                                                                                                   long parentGroupId)

Returns all the groups that are direct children of the parent group with the matching className.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getGroups(long companyId,
                                                                                                   java.lang.String className,
                                                                                                   long parentGroupId,
                                                                                                   int start,
                                                                                                   int end)

Returns a range of all the groups that are direct children of the parent group with the matching className.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupsCount()

Returns the number of groups.

Returns:: the number of groups

getGroupsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupsCount(long companyId,
                                                                                      long parentGroupId,
                                                                                      java.lang.String name,
                                                                                      boolean site)

getGroupsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupsCount(long companyId,
                                                                                      java.lang.String className,
                                                                                      long parentGroupId)

Returns the number of groups that are direct children of the parent group with the matching className.

Parameters:: companyId - the primary key of the company; className - the class name of the group; parentGroupId - the primary key of the parent group
Returns:: the number of matching groups

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getLayoutGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.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.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getLiveGroups()

Returns all live groups.

Returns:: all live groups

getNoLayoutsGroups
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getNoLayoutsGroups(java.lang.String className,
                                                                                                            boolean privateLayout,
                                                                                                            int start,
                                                                                                            int end)
```
Returns a range of all non-system groups of a specified type (className) that have no layouts.
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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getNullFriendlyURLGroups()
```
Returns all non-system groups having null or empty friendly URLs.

Returns:

the non-system groups having null or empty friendly URLs

getOrganizationGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getOrganizationGroups(long organizationId)

getOrganizationGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getOrganizationGroups(long organizationId,
                                                                                                               int start,
                                                                                                               int end)

getOrganizationGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getOrganizationGroups(long organizationId,
                                                                                                               int start,
                                                                                                               int end,
                                                                                                               OrderByComparator<Group> orderByComparator)

getOrganizationGroupsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getOrganizationGroupsCount(long organizationId)

getOrganizationPrimaryKeys
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getOrganizationsGroups(java.util.List<Organization> organizations)

Returns the specified organization groups.

Parameters:: organizations - the organizations
Returns:: the groups associated with the organizations

getOrganizationsRelatedGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getOrganizationsRelatedGroups(java.util.List<Organization> organizations)

Returns all the groups related to the organizations.

Parameters:: organizations - the organizations
Returns:: the groups related to the organizations

getOSGiServiceIdentifier
```
java.lang.String getOSGiServiceIdentifier()
```
Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getParentGroups
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:: getPersistedModel in interface PersistedModelLocalService
Throws:: PortalException

getRoleGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getRoleGroups(long roleId)

getRoleGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getRoleGroups(long roleId,
                                                                                                       int start,
                                                                                                       int end)

getRoleGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getRoleGroups(long roleId,
                                                                                                       int start,
                                                                                                       int end,
                                                                                                       OrderByComparator<Group> orderByComparator)

getRoleGroupsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getRoleGroupsCount(long roleId)

getRolePrimaryKeys
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getStagedSites()

getStagingGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getUserGroupGroups(long userGroupId)

getUserGroupGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getUserGroupGroups(long userGroupId,
                                                                                                            int start,
                                                                                                            int end)

getUserGroupGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getUserGroupGroups(long userGroupId,
                                                                                                            int start,
                                                                                                            int end,
                                                                                                            OrderByComparator<Group> orderByComparator)

getUserGroupGroupsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserGroupGroupsCount(long userGroupId)

getUserGroupPrimaryKeys
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getUserGroups(long userId)

getUserGroups
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getUserGroups(long userId,
                                                                                                       int start,
                                                                                                       int end)

getUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getUserGroups(long userId,
                                                                                                       int start,
                                                                                                       int end,
                                                                                                       OrderByComparator<Group> orderByComparator)
                                                                                                throws PortalException

Throws:: PortalException

getUserGroupsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserGroupsCount(long userId)

getUserGroupsGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getUserGroupsGroups(java.util.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getUserGroupsRelatedGroups(java.util.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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getUserSitesGroups(long userId)
                                                                                                     throws PortalException

Throws:: PortalException

getUserSitesGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getUserSitesGroups(long userId,
                                                                                                            boolean includeAdministrative)
                                                                                                     throws PortalException

Throws:: PortalException

hasOrganizationGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasOrganizationGroup(long organizationId,
                                                                                                long groupId)

hasOrganizationGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasOrganizationGroups(long organizationId)

hasRoleGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasRoleGroup(long roleId,
                                                                                        long groupId)

hasRoleGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasRoleGroups(long roleId)

hasStagingGroup
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserGroup(long userId,
                                                                                        long groupId)

hasUserGroup
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserGroupGroup(long userGroupId,
                                                                                             long groupId)

hasUserGroupGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserGroupGroups(long userGroupId)

hasUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserGroups(long userId)

isLiveGroupActive

@Skip
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isLiveGroupActive(Group group)

loadFetchGroup
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
Group loadFetchGroup(long companyId,
                                                                                        java.lang.String groupKey)
```
Returns the group with the matching group key by first searching the system groups and then using the finder cache.

Parameters:

companyId - the primary key of the company

groupKey - the group key

Returns:

the group with the group key and associated company, or null if a matching group could not be found

loadGetGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Group loadGetGroup(long companyId,
                                                                                      java.lang.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
```
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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> search(long companyId,
                                                                                                java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                int start,
                                                                                                int end)
```
Returns an ordered range of all the company's groups, optionally including the user's inherited organization groups and user groups. 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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> search(long companyId,
                                                                                                long parentGroupId,
                                                                                                java.lang.String keywords,
                                                                                                java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                int start,
                                                                                                int end)
```
Returns an ordered range of all the groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups. 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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> search(long companyId,
                                                                                                long parentGroupId,
                                                                                                java.lang.String keywords,
                                                                                                java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                int start,
                                                                                                int end,
                                                                                                OrderByComparator<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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> search(long companyId,
                                                                                                long parentGroupId,
                                                                                                java.lang.String name,
                                                                                                java.lang.String description,
                                                                                                java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                boolean andOperator,
                                                                                                int start,
                                                                                                int end)
```
Returns an ordered range of all the site groups belonging to the parent group and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. 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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> search(long companyId,
                                                                                                long parentGroupId,
                                                                                                java.lang.String name,
                                                                                                java.lang.String description,
                                                                                                java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                boolean andOperator,
                                                                                                int start,
                                                                                                int end,
                                                                                                OrderByComparator<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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> search(long companyId,
                                                                                                long[] classNameIds,
                                                                                                long parentGroupId,
                                                                                                java.lang.String keywords,
                                                                                                java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                int start,
                                                                                                int end)
```
Returns an ordered range of all the groups belonging to the parent group that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups. 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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> search(long companyId,
                                                                                                long[] classNameIds,
                                                                                                long parentGroupId,
                                                                                                java.lang.String keywords,
                                                                                                java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                int start,
                                                                                                int end,
                                                                                                OrderByComparator<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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> search(long companyId,
                                                                                                long[] classNameIds,
                                                                                                long parentGroupId,
                                                                                                java.lang.String name,
                                                                                                java.lang.String description,
                                                                                                java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                boolean andOperator,
                                                                                                int start,
                                                                                                int end)
```
Returns an ordered range of all the groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. 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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> search(long companyId,
                                                                                                long[] classNameIds,
                                                                                                long parentGroupId,
                                                                                                java.lang.String name,
                                                                                                java.lang.String description,
                                                                                                java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                boolean andOperator,
                                                                                                int start,
                                                                                                int end,
                                                                                                OrderByComparator<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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> search(long companyId,
                                                                                                long[] classNameIds,
                                                                                                java.lang.String keywords,
                                                                                                java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                int start,
                                                                                                int end)
```
Returns an ordered range of all the groups that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups. 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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> search(long companyId,
                                                                                                long[] classNameIds,
                                                                                                java.lang.String keywords,
                                                                                                java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                int start,
                                                                                                int end,
                                                                                                OrderByComparator<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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> search(long companyId,
                                                                                                long[] classNameIds,
                                                                                                java.lang.String name,
                                                                                                java.lang.String description,
                                                                                                java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                boolean andOperator,
                                                                                                int start,
                                                                                                int end)
```
Returns an ordered range of all the groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. 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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> search(long companyId,
                                                                                                long[] classNameIds,
                                                                                                java.lang.String name,
                                                                                                java.lang.String description,
                                                                                                java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                boolean andOperator,
                                                                                                int start,
                                                                                                int end,
                                                                                                OrderByComparator<Group> obc)
```
Returns an ordered range of all the groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

Parameters:

companyId - the primary key of the company

classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null)

name - the group's name (optionally null)

description - the group's description (optionally null)

params - the finder params (optionally null). To include a user's organizations, inherited organizations, and user groups in the search, add an entry with key "usersGroups" mapped to the user's ID and an entry with key "inherit" mapped to a non-null object. For more information see GroupFinder.

andOperator - whether every field must match its keywords, or just one field.

start - the lower bound of the range of groups to return

end - the upper bound of the range of groups to return (not inclusive)

obc - the comparator to order the groups (optionally null)

Returns:

the matching groups ordered by comparator obc

search
```
@ThreadLocalCachable
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> search(long companyId,
                                                                                                                      java.lang.String keywords,
                                                                                                                      java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                                      int start,
                                                                                                                      int end)
```
Returns an ordered range of all the groups that match the keywords, optionally including the user's inherited organization groups and user groups. 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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> search(long companyId,
                                                                                                java.lang.String keywords,
                                                                                                java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                int start,
                                                                                                int end,
                                                                                                OrderByComparator<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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> search(long companyId,
                                                                                                java.lang.String name,
                                                                                                java.lang.String description,
                                                                                                java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                boolean andOperator,
                                                                                                int start,
                                                                                                int end)
```
Returns an ordered range of all the site groups and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. 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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> search(long companyId,
                                                                                                java.lang.String name,
                                                                                                java.lang.String description,
                                                                                                java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                boolean andOperator,
                                                                                                int start,
                                                                                                int end,
                                                                                                OrderByComparator<Group> obc)
```
Returns an ordered range of all the site groups and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.
Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

Parameters:

companyId - the primary key of the company

name - the group's name (optionally null)

description - the group's description (optionally null)

params - the finder params (optionally null). To include the user's inherited organizations and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder.

andOperator - whether every field must match its keywords, or just one field.

start - the lower bound of the range of groups to return

end - the upper bound of the range of groups to return (not inclusive)

obc - the comparator to order the groups (optionally null)

Returns:

the matching groups ordered by comparator obc

searchCount
```
@ThreadLocalCachable
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                                                                         long parentGroupId,
                                                                                                         java.lang.String keywords,
                                                                                                         java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
```
Returns the number of groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:

companyId - the primary key of the company

parentGroupId - the primary key of the parent group

keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null)

params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder.

Returns:

the number of matching groups

searchCount
```
@ThreadLocalCachable
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                                                                         long parentGroupId,
                                                                                                         java.lang.String name,
                                                                                                         java.lang.String description,
                                                                                                         java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                         boolean andOperator)
```
Returns the number of groups belonging to the parent group and immediate organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:

companyId - the primary key of the company

parentGroupId - the primary key of the parent group

name - the group's name (optionally null)

description - the group's description (optionally null)

params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder.

andOperator - whether every field must match its keywords, or just one field.

Returns:

the number of matching groups

searchCount
```
@ThreadLocalCachable
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                                                                         long[] classNameIds,
                                                                                                         long parentGroupId,
                                                                                                         java.lang.String keywords,
                                                                                                         java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
```
Returns the number of groups belonging to the parent group that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:

companyId - the primary key of the company

classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null)

parentGroupId - the primary key of the parent group

keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null)

params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder.

Returns:

the number of matching groups

searchCount

@ThreadLocalCachable
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                                                                         long[] classNameIds,
                                                                                                         long parentGroupId,
                                                                                                         java.lang.String name,
                                                                                                         java.lang.String description,
                                                                                                         java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                         boolean andOperator)

Returns the number of groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:: companyId - the primary key of the company; classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null); parentGroupId - the primary key of the parent group; name - the group's name (optionally null); description - the group's description (optionally null); params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder.; andOperator - whether every field must match its keywords, or just one field.
Returns:: the number of matching groups

searchCount
```
@ThreadLocalCachable
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                                                                         long[] classNameIds,
                                                                                                         java.lang.String keywords,
                                                                                                         java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
```
Returns the number of groups that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:

companyId - the primary key of the company

classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null)

keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null)

params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder.

Returns:

the number of matching groups

searchCount
```
@ThreadLocalCachable
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                                                                         long[] classNameIds,
                                                                                                         java.lang.String name,
                                                                                                         java.lang.String description,
                                                                                                         java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                         boolean andOperator)
```
Returns the number of groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:

companyId - the primary key of the company

classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null)

name - the group's name (optionally null)

description - the group's description (optionally null)

params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder.

andOperator - whether every field must match its keywords, or just one field.

Returns:

the number of matching groups

searchCount
```
@ThreadLocalCachable
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                                                                         java.lang.String keywords,
                                                                                                         java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
```
Returns the number of groups that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:

companyId - the primary key of the company

keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null)

params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder.

Returns:

the number of matching groups

searchCount
```
@ThreadLocalCachable
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                                                                         java.lang.String name,
                                                                                                         java.lang.String description,
                                                                                                         java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                         boolean andOperator)
```
Returns the number of groups and immediate organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:

companyId - the primary key of the company

name - the group's name (optionally null)

description - the group's description (optionally null)

params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder.

andOperator - whether every field must match its keywords, or just one field.

Returns:

the number of matching groups

setOrganizationGroups

void setOrganizationGroups(long organizationId,
                           long[] groupIds)

setRoleGroups

void setRoleGroups(long roleId,
                   long[] groupIds)

setUserGroupGroups

void setUserGroupGroups(long userGroupId,
                        long[] groupIds)

setUserGroups

void setUserGroups(long userId,
                   long[] groupIds)

unsetRoleGroups
```
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
```
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
```
void updateAsset(long userId,
                 Group group,
                 long[] assetCategoryIds,
                 java.lang.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
```
Group updateFriendlyURL(long groupId,
                        java.lang.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
```
@Indexable(type=REINDEX)
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

Group updateGroup(long groupId,
                  long parentGroupId,
                  java.util.Map<java.util.Locale,java.lang.String> nameMap,
                  java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                  int type,
                  boolean manualMembership,
                  int membershipRestriction,
                  java.lang.String friendlyURL,
                  boolean inheritContent,
                  boolean active,
                  ServiceContext serviceContext)
           throws PortalException

Throws:: PortalException

updateGroup
```
@Deprecated
Group updateGroup(long groupId,
                              long parentGroupId,
                              java.lang.String name,
                              java.lang.String description,
                              int type,
                              boolean manualMembership,
                              int membershipRestriction,
                              java.lang.String friendlyURL,
                              boolean inheritContent,
                              boolean active,
                              ServiceContext serviceContext)
                       throws PortalException
```
Deprecated. As of Wilberforce (7.0.x), replaced by updateGroup(long, long, Map, Map, int, boolean, int, String, boolean, boolean, ServiceContext)

Updates the group.

Parameters:

groupId - the primary key of the group

parentGroupId - the primary key of the parent group

name - the name's key

description - the group's new description (optionally null)

type - the group's new type. For more information see GroupConstants.

manualMembership - whether manual membership is allowed for the group

membershipRestriction - the group's membership restriction. For more information see GroupConstants.

friendlyURL - the group's new friendlyURL (optionally null)

inheritContent - whether to inherit content from the parent group

active - whether the group is active

serviceContext - the service context to be applied (optionally null). Can set asset category IDs and asset tag names for the group.

Returns:

the group

Throws:

PortalException - if a portal exception occurred

updateGroup
```
Group updateGroup(long groupId,
                  java.lang.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
```
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

Interface GroupLocalService

Method Summary

Method Detail

addGroup

addGroup

addGroup

addGroup

addOrganizationGroup

addOrganizationGroup

addOrganizationGroups

addOrganizationGroups

addRoleGroup

addRoleGroup

addRoleGroups

addRoleGroups

addUserGroup

addUserGroup

addUserGroupGroup

addUserGroupGroup

addUserGroupGroups

addUserGroupGroups

addUserGroups

addUserGroups

checkCompanyGroup

checkScopeGroup

checkSystemGroups

clearOrganizationGroups

clearRoleGroups

clearUserGroupGroups

clearUserGroups

createGroup

deleteGroup

deleteGroup

deleteOrganizationGroup

deleteOrganizationGroup

deleteOrganizationGroups

deleteOrganizationGroups

deletePersistedModel

deleteRoleGroup

deleteRoleGroup

deleteRoleGroups

deleteRoleGroups

deleteUserGroup

deleteUserGroup

deleteUserGroupGroup

deleteUserGroupGroup

deleteUserGroupGroups

deleteUserGroupGroups

deleteUserGroups

deleteUserGroups

disableStaging

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQueryCount

dynamicQueryCount

enableStaging

fetchCompanyGroup

fetchFriendlyURLGroup

fetchGroup

fetchGroup

fetchGroupByUuidAndCompanyId

fetchStagingGroup

fetchUserGroup

fetchUserPersonalSiteGroup

getActionableDynamicQuery

getActiveGroupIds

getActiveGroups

getCompanyGroup

getCompanyGroups

getCompanyGroupsCount

getFriendlyURLGroup

getGroup

getGroup

getGroupByUuidAndCompanyId

getGroupDescriptiveName

getGroupDescriptiveName

getGroups

getGroups