@ProviderType @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface GroupLocalService extends BaseLocalService, PersistedModelLocalService
GroupLocalServiceUtil
,
GroupLocalServiceBaseImpl
,
GroupLocalServiceImpl
Modifier and Type | Method and Description |
---|---|
Group |
addGroup(Group group)
Adds the group to the database.
|
Group |
addGroup(long userId,
long parentGroupId,
String className,
long classPK,
long liveGroupId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
int type,
boolean manualMembership,
int membershipRestriction,
String friendlyURL,
boolean site,
boolean inheritContent,
boolean active,
ServiceContext serviceContext) |
Group |
addGroup(long userId,
long parentGroupId,
String className,
long classPK,
long liveGroupId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
int type,
boolean manualMembership,
int membershipRestriction,
String friendlyURL,
boolean site,
boolean active,
ServiceContext serviceContext) |
Group |
addGroup(long userId,
long parentGroupId,
String className,
long classPK,
long liveGroupId,
String name,
String description,
int type,
boolean manualMembership,
int membershipRestriction,
String friendlyURL,
boolean site,
boolean active,
ServiceContext serviceContext)
Deprecated.
As of Wilberforce (7.0.x), replaced by
addGroup(long,
long, String, long, long, Map, Map, int, boolean, int,
String, boolean, boolean, ServiceContext) |
void |
addOrganizationGroup(long organizationId,
Group group) |
void |
addOrganizationGroup(long organizationId,
long groupId) |
void |
addOrganizationGroups(long organizationId,
List<Group> groups) |
void |
addOrganizationGroups(long organizationId,
long[] groupIds) |
void |
addRoleGroup(long roleId,
Group group) |
void |
addRoleGroup(long roleId,
long groupId) |
void |
addRoleGroups(long roleId,
List<Group> groups) |
void |
addRoleGroups(long roleId,
long[] groupIds) |
void |
addUserGroup(long userId,
Group group) |
void |
addUserGroup(long userId,
long groupId) |
void |
addUserGroupGroup(long userGroupId,
Group group) |
void |
addUserGroupGroup(long userGroupId,
long groupId) |
void |
addUserGroupGroups(long userGroupId,
List<Group> groups) |
void |
addUserGroupGroups(long userGroupId,
long[] groupIds) |
void |
addUserGroups(long userId,
List<Group> groups) |
void |
addUserGroups(long userId,
long[] groupIds) |
void |
checkCompanyGroup(long companyId)
Adds a company group if it does not exist.
|
Group |
checkScopeGroup(Layout layout,
long userId) |
void |
checkSystemGroups(long companyId)
Creates systems groups and other related data needed by the system on the
very first startup.
|
void |
clearOrganizationGroups(long organizationId) |
void |
clearRoleGroups(long roleId) |
void |
clearUserGroupGroups(long userGroupId) |
void |
clearUserGroups(long userId) |
Group |
createGroup(long groupId)
Creates a new group with the primary key.
|
Group |
deleteGroup(Group group)
Deletes the group from the database.
|
Group |
deleteGroup(long groupId)
Deletes the group with the primary key from the database.
|
void |
deleteOrganizationGroup(long organizationId,
Group group) |
void |
deleteOrganizationGroup(long organizationId,
long groupId) |
void |
deleteOrganizationGroups(long organizationId,
List<Group> groups) |
void |
deleteOrganizationGroups(long organizationId,
long[] groupIds) |
PersistedModel |
deletePersistedModel(PersistedModel persistedModel) |
void |
deleteRoleGroup(long roleId,
Group group) |
void |
deleteRoleGroup(long roleId,
long groupId) |
void |
deleteRoleGroups(long roleId,
List<Group> groups) |
void |
deleteRoleGroups(long roleId,
long[] groupIds) |
void |
deleteUserGroup(long userId,
Group group) |
void |
deleteUserGroup(long userId,
long groupId) |
void |
deleteUserGroupGroup(long userGroupId,
Group group) |
void |
deleteUserGroupGroup(long userGroupId,
long groupId) |
void |
deleteUserGroupGroups(long userGroupId,
List<Group> groups) |
void |
deleteUserGroupGroups(long userGroupId,
long[] groupIds) |
void |
deleteUserGroups(long userId,
List<Group> groups) |
void |
deleteUserGroups(long userId,
long[] groupIds) |
void |
disableStaging(long groupId) |
DynamicQuery |
dynamicQuery() |
<T> List<T> |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
<T> List<T> |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows.
|
<T> List<T> |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator<T> orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows.
|
long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.
|
long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows matching the dynamic query.
|
void |
enableStaging(long groupId) |
Group |
fetchCompanyGroup(long companyId)
Returns the company's group.
|
Group |
fetchFriendlyURLGroup(long companyId,
String friendlyURL)
Returns the group with the matching friendly URL.
|
Group |
fetchGroup(long groupId) |
Group |
fetchGroup(long companyId,
String groupKey)
Returns the group with the matching group key by first searching the
system groups and then using the finder cache.
|
Group |
fetchGroupByUuidAndCompanyId(String uuid,
long companyId)
Returns the group with the matching UUID and company.
|
Group |
fetchStagingGroup(long liveGroupId) |
Group |
fetchUserGroup(long companyId,
long userId) |
Group |
fetchUserPersonalSiteGroup(long companyId)
Returns the default user's personal site group.
|
ActionableDynamicQuery |
getActionableDynamicQuery() |
List<Long> |
getActiveGroupIds(long userId) |
List<Group> |
getActiveGroups(long companyId,
boolean active)
Returns all the active or inactive groups associated with the company.
|
Group |
getCompanyGroup(long companyId)
Returns the company group.
|
List<Group> |
getCompanyGroups(long companyId,
int start,
int end)
Returns a range of all the groups associated with the company.
|
int |
getCompanyGroupsCount(long companyId)
Returns the number of groups associated with the company.
|
Group |
getFriendlyURLGroup(long companyId,
String friendlyURL)
Returns the group with the matching friendly URL.
|
Group |
getGroup(long groupId)
Returns the group with the primary key.
|
Group |
getGroup(long companyId,
String groupKey)
Returns the group with the matching group key.
|
Group |
getGroupByUuidAndCompanyId(String uuid,
long companyId)
Returns the group with the matching UUID and company.
|
String |
getGroupDescriptiveName(Group group,
Locale locale)
Deprecated.
As of Wilberforce (7.0.x), replaced by
Group.getDescriptiveName(Locale) |
String |
getGroupDescriptiveName(long groupId,
Locale locale)
Deprecated.
As of Wilberforce (7.0.x), replaced by
Group.getDescriptiveName(Locale) |
List<Group> |
getGroups(int start,
int end)
Returns a range of all the groups.
|
List<Group> |
getGroups(long[] groupIds)
Returns the groups with the matching primary keys.
|
List<Group> |
getGroups(long companyId,
long parentGroupId,
boolean site)
Returns all the groups that are direct children of the parent group.
|
List<Group> |
getGroups(long companyId,
long parentGroupId,
boolean site,
boolean inheritContent) |
List<Group> |
getGroups(long companyId,
long parentGroupId,
boolean site,
int start,
int end) |
List<Group> |
getGroups(long companyId,
long parentGroupId,
String name,
boolean site,
int start,
int end) |
List<Group> |
getGroups(long companyId,
String treePath,
boolean site) |
List<Group> |
getGroups(long companyId,
String className,
long parentGroupId)
Returns all the groups that are direct children of the parent group with
the matching className.
|
List<Group> |
getGroups(long companyId,
String className,
long parentGroupId,
int start,
int end)
Returns a range of all the groups that are direct children of the parent
group with the matching className.
|
int |
getGroupsCount()
Returns the number of groups.
|
int |
getGroupsCount(long companyId,
long parentGroupId,
boolean site)
Returns the number of groups that are direct children of the parent
group.
|
int |
getGroupsCount(long companyId,
long parentGroupId,
String name,
boolean site) |
int |
getGroupsCount(long companyId,
String className,
long parentGroupId)
Returns the number of groups that are direct children of the parent group
with the matching className.
|
IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
Group |
getLayoutGroup(long companyId,
long plid)
Returns the group associated with the layout.
|
Group |
getLayoutPrototypeGroup(long companyId,
long layoutPrototypeId)
Returns the group associated with the layout prototype.
|
Group |
getLayoutSetPrototypeGroup(long companyId,
long layoutSetPrototypeId)
Returns the group associated with the layout set prototype.
|
List<Group> |
getLayoutsGroups(long companyId,
long parentGroupId,
boolean site,
boolean active,
int start,
int end,
OrderByComparator<Group> obc)
Returns a range of all groups that are children of the parent group and
that have at least one layout.
|
List<Group> |
getLayoutsGroups(long companyId,
long parentGroupId,
boolean site,
int start,
int end,
OrderByComparator<Group> obc)
Returns a range of all groups that are children of the parent group and
that have at least one layout.
|
int |
getLayoutsGroupsCount(long companyId,
long parentGroupId,
boolean site)
Returns the number of groups that are children or the parent group and
that have at least one layout
|
int |
getLayoutsGroupsCount(long companyId,
long parentGroupId,
boolean site,
boolean active)
Returns the number of groups that are children or the parent group and
that have at least one layout
|
List<Group> |
getLiveGroups()
Returns all live groups.
|
List<Group> |
getNoLayoutsGroups(String className,
boolean privateLayout,
int start,
int end)
Returns a range of all non-system groups of a specified type (className)
that have no layouts.
|
List<Group> |
getNullFriendlyURLGroups()
Returns all non-system groups having
null or empty friendly
URLs. |
Group |
getOrganizationGroup(long companyId,
long organizationId)
Returns the specified organization group.
|
List<Group> |
getOrganizationGroups(long organizationId) |
List<Group> |
getOrganizationGroups(long organizationId,
int start,
int end) |
List<Group> |
getOrganizationGroups(long organizationId,
int start,
int end,
OrderByComparator<Group> orderByComparator) |
int |
getOrganizationGroupsCount(long organizationId) |
long[] |
getOrganizationPrimaryKeys(long groupId)
Returns the organizationIds of the organizations associated with the group.
|
List<Group> |
getOrganizationsGroups(List<Organization> organizations)
Returns the specified organization groups.
|
List<Group> |
getOrganizationsRelatedGroups(List<Organization> organizations)
Returns all the groups related to the organizations.
|
String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
List<Group> |
getParentGroups(long groupId)
Returns the group followed by all its parent groups ordered by closest
ancestor.
|
PersistedModel |
getPersistedModel(Serializable primaryKeyObj) |
List<Group> |
getRoleGroups(long roleId) |
List<Group> |
getRoleGroups(long roleId,
int start,
int end) |
List<Group> |
getRoleGroups(long roleId,
int start,
int end,
OrderByComparator<Group> orderByComparator) |
int |
getRoleGroupsCount(long roleId) |
long[] |
getRolePrimaryKeys(long groupId)
Returns the roleIds of the roles associated with the group.
|
List<Group> |
getStagedSites() |
Group |
getStagingGroup(long liveGroupId)
Returns the staging group.
|
Group |
getUserGroup(long companyId,
long userId)
Returns the group directly associated with the user.
|
Group |
getUserGroupGroup(long companyId,
long userGroupId)
Returns the specified "user group" group.
|
List<Group> |
getUserGroupGroups(long userGroupId) |
List<Group> |
getUserGroupGroups(long userGroupId,
int start,
int end) |
List<Group> |
getUserGroupGroups(long userGroupId,
int start,
int end,
OrderByComparator<Group> orderByComparator) |
int |
getUserGroupGroupsCount(long userGroupId) |
long[] |
getUserGroupPrimaryKeys(long groupId)
Returns the userGroupIds of the user groups associated with the group.
|
List<Group> |
getUserGroups(long userId) |
List<Group> |
getUserGroups(long userId,
boolean inherit)
Returns all the user's site groups and immediate organization groups,
optionally including the user's inherited organization groups and user
groups.
|
List<Group> |
getUserGroups(long userId,
boolean inherit,
int start,
int end)
Returns an ordered range of all the user's site groups and immediate
organization groups, optionally including the user's inherited
organization groups and user groups.
|
List<Group> |
getUserGroups(long userId,
int start,
int end) |
List<Group> |
getUserGroups(long userId,
int start,
int end,
OrderByComparator<Group> orderByComparator) |
int |
getUserGroupsCount(long userId) |
List<Group> |
getUserGroupsGroups(List<UserGroup> userGroups)
Returns the groups associated with the user groups.
|
List<Group> |
getUserGroupsRelatedGroups(List<UserGroup> userGroups)
Returns all the groups related to the user groups.
|
List<Group> |
getUserOrganizationsGroups(long userId,
int start,
int end)
Returns the range of all groups associated with the user's organization
groups, including the ancestors of the organization groups, unless portal
property
organizations.membership.strict is set to
true . |
Group |
getUserPersonalSiteGroup(long companyId)
Returns the default user's personal site group.
|
long[] |
getUserPrimaryKeys(long groupId)
Returns the userIds of the users associated with the group.
|
List<Group> |
getUserSitesGroups(long userId) |
List<Group> |
getUserSitesGroups(long userId,
boolean includeAdministrative) |
boolean |
hasOrganizationGroup(long organizationId,
long groupId) |
boolean |
hasOrganizationGroups(long organizationId) |
boolean |
hasRoleGroup(long roleId,
long groupId) |
boolean |
hasRoleGroups(long roleId) |
boolean |
hasStagingGroup(long liveGroupId)
Returns
true if the live group has a staging group. |
boolean |
hasUserGroup(long userId,
long groupId) |
boolean |
hasUserGroup(long userId,
long groupId,
boolean inherit)
Returns
true if the user is immediately associated with the
group, or optionally if the user is associated with the group via the
user's organizations, inherited organizations, or user groups. |
boolean |
hasUserGroupGroup(long userGroupId,
long groupId) |
boolean |
hasUserGroupGroups(long userGroupId) |
boolean |
hasUserGroups(long userId) |
boolean |
isLiveGroupActive(Group group) |
Group |
loadFetchGroup(long companyId,
String groupKey)
Returns the group with the matching group key by first searching the
system groups and then using the finder cache.
|
Group |
loadGetGroup(long companyId,
String groupKey)
Returns the group with the matching group key.
|
void |
rebuildTree(long companyId)
Rebuilds the group tree.
|
List<Group> |
search(long companyId,
LinkedHashMap<String,Object> params,
int start,
int end)
Returns an ordered range of all the company's groups, optionally
including the user's inherited organization groups and user groups.
|
List<Group> |
search(long companyId,
long[] classNameIds,
long parentGroupId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end)
Returns an ordered range of all the groups belonging to the parent group
that match the class name IDs and keywords, optionally including the
user's inherited organization groups and user groups.
|
List<Group> |
search(long companyId,
long[] classNameIds,
long parentGroupId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator<Group> obc)
Returns an ordered range of all the groups belonging to the parent group
that match the class name IDs and keywords, optionally including the
user's inherited organization groups and user groups.
|
List<Group> |
search(long companyId,
long[] classNameIds,
long parentGroupId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end)
Returns an ordered range of all the groups belonging to the parent group
that match the class name IDs, name, and description, optionally
including the user's inherited organization groups and user groups.
|
List<Group> |
search(long companyId,
long[] classNameIds,
long parentGroupId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end,
OrderByComparator<Group> obc)
Returns an ordered range of all the groups belonging to the parent group
that match the class name IDs, name, and description, optionally
including the user's inherited organization groups and user groups.
|
List<Group> |
search(long companyId,
long[] classNameIds,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end)
Returns an ordered range of all the groups that match the class name IDs
and keywords, optionally including the user's inherited organization
groups and user groups.
|
List<Group> |
search(long companyId,
long[] classNameIds,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator<Group> obc)
Returns an ordered range of all the groups that match the class name IDs
and keywords, optionally including the user's inherited organization
groups and user groups.
|
List<Group> |
search(long companyId,
long[] classNameIds,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end)
Returns an ordered range of all the groups that match the class name IDs,
name, and description, optionally including the user's inherited
organization groups and user groups.
|
List<Group> |
search(long companyId,
long[] classNameIds,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end,
OrderByComparator<Group> obc)
Returns an ordered range of all the groups that match the class name IDs,
name, and description, optionally including the user's inherited
organization groups and user groups.
|
List<Group> |
search(long companyId,
long parentGroupId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end)
Returns an ordered range of all the groups belonging to the parent group
that match the keywords, optionally including the user's inherited
organization groups and user groups.
|
List<Group> |
search(long companyId,
long parentGroupId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator<Group> obc)
Returns an ordered range of all the groups belonging to the parent group
that match the keywords, optionally including the user's inherited
organization groups and user groups.
|
List<Group> |
search(long companyId,
long parentGroupId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end)
Returns an ordered range of all the site groups belonging to the parent
group and organization groups that match the name and description,
optionally including the user's inherited organization groups and user
groups.
|
List<Group> |
search(long companyId,
long parentGroupId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end,
OrderByComparator<Group> obc)
Returns an ordered range of all the site groups belonging to the parent
group and organization groups that match the name and description,
optionally including the user's inherited organization groups and user
groups.
|
List<Group> |
search(long companyId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end)
Returns an ordered range of all the groups that match the keywords,
optionally including the user's inherited organization groups and user
groups.
|
List<Group> |
search(long companyId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator<Group> obc)
Returns an ordered range of all the groups that match the keywords,
optionally including the user's inherited organization groups and user
groups.
|
List<Group> |
search(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end)
Returns an ordered range of all the site groups and organization groups
that match the name and description, optionally including the user's
inherited organization groups and user groups.
|
List<Group> |
search(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end,
OrderByComparator<Group> obc)
Returns an ordered range of all the site groups and organization groups
that match the name and description, optionally including the user's
inherited organization groups and user groups.
|
int |
searchCount(long companyId,
long[] classNameIds,
long parentGroupId,
String keywords,
LinkedHashMap<String,Object> params)
Returns the number of groups belonging to the parent group that match the
class name IDs, and keywords, optionally including the user's inherited
organization groups and user groups.
|
int |
searchCount(long companyId,
long[] classNameIds,
long parentGroupId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator)
Returns the number of groups belonging to the parent group that match the
class name IDs, name, and description, optionally including the user's
inherited organization groups and user groups.
|
int |
searchCount(long companyId,
long[] classNameIds,
String keywords,
LinkedHashMap<String,Object> params)
Returns the number of groups that match the class name IDs, and keywords,
optionally including the user's inherited organization groups and user
groups.
|
int |
searchCount(long companyId,
long[] classNameIds,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator)
Returns the number of groups that match the class name IDs, name, and
description, optionally including the user's inherited organization
groups and user groups.
|
int |
searchCount(long companyId,
long parentGroupId,
String keywords,
LinkedHashMap<String,Object> params)
Returns the number of groups belonging to the parent group that match the
keywords, optionally including the user's inherited organization groups
and user groups.
|
int |
searchCount(long companyId,
long parentGroupId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator)
Returns the number of groups belonging to the parent group and immediate
organization groups that match the name and description, optionally
including the user's inherited organization groups and user groups.
|
int |
searchCount(long companyId,
String keywords,
LinkedHashMap<String,Object> params)
Returns the number of groups that match the keywords, optionally
including the user's inherited organization groups and user groups.
|
int |
searchCount(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator)
Returns the number of groups and immediate organization groups that match
the name and description, optionally including the user's inherited
organization groups and user groups.
|
void |
setOrganizationGroups(long organizationId,
long[] groupIds) |
void |
setRoleGroups(long roleId,
long[] groupIds) |
void |
setUserGroupGroups(long userGroupId,
long[] groupIds) |
void |
setUserGroups(long userId,
long[] groupIds) |
void |
unsetRoleGroups(long roleId,
long[] groupIds)
Removes the groups from the role.
|
void |
unsetUserGroups(long userId,
long[] groupIds)
Removes the user from the groups.
|
void |
updateAsset(long userId,
Group group,
long[] assetCategoryIds,
String[] assetTagNames)
Updates the group's asset replacing categories and tag names.
|
Group |
updateFriendlyURL(long groupId,
String friendlyURL)
Updates the group's friendly URL.
|
Group |
updateGroup(Group group)
Updates the group in the database or adds it if it does not yet exist.
|
Group |
updateGroup(long groupId,
long parentGroupId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
int type,
boolean manualMembership,
int membershipRestriction,
String friendlyURL,
boolean inheritContent,
boolean active,
ServiceContext serviceContext) |
Group |
updateGroup(long groupId,
long parentGroupId,
String name,
String description,
int type,
boolean manualMembership,
int membershipRestriction,
String friendlyURL,
boolean inheritContent,
boolean active,
ServiceContext serviceContext)
Deprecated.
As of Wilberforce (7.0.x), replaced by
updateGroup(long, long, Map, Map, int, boolean, int, String,
boolean, boolean, ServiceContext) |
Group |
updateGroup(long groupId,
String typeSettings)
Updates the group's type settings.
|
Group |
updateSite(long groupId,
boolean site)
Associates the group with a main site if the group is an organization.
|
@Indexable(type=REINDEX) Group addGroup(Group group)
group
- the groupGroup addGroup(long userId, long parentGroupId, String className, long classPK, long liveGroupId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean site, boolean inheritContent, boolean active, ServiceContext serviceContext) throws PortalException
PortalException
Group addGroup(long userId, long parentGroupId, String className, long classPK, long liveGroupId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean site, boolean active, ServiceContext serviceContext) throws PortalException
PortalException
@Deprecated Group addGroup(long userId, long parentGroupId, String className, long classPK, long liveGroupId, String name, String description, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean site, boolean active, ServiceContext serviceContext) throws PortalException
addGroup(long,
long, String, long, long, Map, Map, int, boolean, int,
String, boolean, boolean, ServiceContext)
userId
- the primary key of the group's creator/ownerparentGroupId
- the primary key of the parent groupclassName
- the entity's class nameclassPK
- the primary key of the entity's instanceliveGroupId
- the primary key of the live groupname
- the entity's namedescription
- the group's description (optionally
null
)type
- the group's type. For more information see GroupConstants
.manualMembership
- whether manual membership is allowed for the
groupmembershipRestriction
- 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 siteactive
- whether the group is activeserviceContext
- 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.PortalException
- if a portal exception occuredvoid addOrganizationGroup(long organizationId, Group group)
void addOrganizationGroup(long organizationId, long groupId)
void addOrganizationGroups(long organizationId, List<Group> groups)
void addOrganizationGroups(long organizationId, long[] groupIds)
void addRoleGroup(long roleId, Group group)
void addRoleGroup(long roleId, long groupId)
void addRoleGroups(long roleId, List<Group> groups)
void addRoleGroups(long roleId, long[] groupIds)
void addUserGroup(long userId, Group group)
void addUserGroup(long userId, long groupId)
void addUserGroupGroup(long userGroupId, Group group)
void addUserGroupGroup(long userGroupId, long groupId)
void addUserGroupGroups(long userGroupId, List<Group> groups)
void addUserGroupGroups(long userGroupId, long[] groupIds)
void addUserGroups(long userId, List<Group> groups)
void addUserGroups(long userId, long[] groupIds)
@Transactional(propagation=SUPPORTS, readOnly=true) void checkCompanyGroup(long companyId) throws PortalException
companyId
- the primary key of the companyPortalException
- if a portal exception occurredGroup checkScopeGroup(Layout layout, long userId) throws PortalException
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) void checkSystemGroups(long companyId) throws PortalException
companyId
- the primary key of the companyPortalException
- if a portal exception occurredvoid clearOrganizationGroups(long organizationId)
void clearRoleGroups(long roleId)
void clearUserGroupGroups(long userGroupId)
void clearUserGroups(long userId)
@Transactional(enabled=false) Group createGroup(long groupId)
groupId
- the primary key for the new group@Indexable(type=DELETE) Group deleteGroup(Group group) throws PortalException
group
- the groupPortalException
@Indexable(type=DELETE) Group deleteGroup(long groupId) throws PortalException
groupId
- the primary key of the groupPortalException
- if a group with the primary key could not be foundvoid deleteOrganizationGroup(long organizationId, Group group)
void deleteOrganizationGroup(long organizationId, long groupId)
void deleteOrganizationGroups(long organizationId, List<Group> groups)
void deleteOrganizationGroups(long organizationId, long[] groupIds)
PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
deletePersistedModel
in interface PersistedModelLocalService
PortalException
void deleteRoleGroup(long roleId, Group group)
void deleteRoleGroup(long roleId, long groupId)
void deleteRoleGroups(long roleId, List<Group> groups)
void deleteRoleGroups(long roleId, long[] groupIds)
void deleteUserGroup(long userId, Group group)
void deleteUserGroup(long userId, long groupId)
void deleteUserGroupGroup(long userGroupId, Group group)
void deleteUserGroupGroup(long userGroupId, long groupId)
void deleteUserGroupGroups(long userGroupId, List<Group> groups)
void deleteUserGroupGroups(long userGroupId, long[] groupIds)
void deleteUserGroups(long userId, List<Group> groups)
void deleteUserGroups(long userId, long[] groupIds)
void disableStaging(long groupId) throws PortalException
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) DynamicQuery dynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic query@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic query@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the queryvoid enableStaging(long groupId) throws PortalException
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) Group fetchCompanyGroup(long companyId)
companyId
- the primary key of the companynull
if a matching group
could not be found@Transactional(propagation=SUPPORTS, readOnly=true) Group fetchFriendlyURLGroup(long companyId, String friendlyURL)
companyId
- the primary key of the companyfriendlyURL
- the friendly URLnull
if a
matching group could not be found@ThreadLocalCachable @Transactional(propagation=SUPPORTS, readOnly=true) Group fetchGroup(long groupId)
@Skip @Transactional(propagation=SUPPORTS, readOnly=true) Group fetchGroup(long companyId, String groupKey)
companyId
- the primary key of the companygroupKey
- the group keynull
if a matching group could not be found@Transactional(propagation=SUPPORTS, readOnly=true) Group fetchGroupByUuidAndCompanyId(String uuid, long companyId)
uuid
- the group's UUIDcompanyId
- the primary key of the companynull
if a matching group could not be found@Transactional(propagation=SUPPORTS, readOnly=true) Group fetchStagingGroup(long liveGroupId)
@Transactional(propagation=SUPPORTS, readOnly=true) Group fetchUserGroup(long companyId, long userId)
@Transactional(propagation=SUPPORTS, readOnly=true) Group fetchUserPersonalSiteGroup(long companyId) throws PortalException
companyId
- the primary key of the companynull
if a
matching group could not be foundPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) List<Long> getActiveGroupIds(long userId)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getActiveGroups(long companyId, boolean active)
companyId
- the primary key of the companyactive
- whether to return only active groups, or only inactive
groups@Transactional(propagation=SUPPORTS, readOnly=true) Group getCompanyGroup(long companyId) throws PortalException
companyId
- the primary key of the companyPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getCompanyGroups(long companyId, int start, int end)
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.
companyId
- the primary key of the companystart
- the lower bound of the range of groups to returnend
- the upper bound of the range of groups to return (not
inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) int getCompanyGroupsCount(long companyId)
companyId
- the primary key of the company@Transactional(propagation=SUPPORTS, readOnly=true) Group getFriendlyURLGroup(long companyId, String friendlyURL) throws PortalException
companyId
- the primary key of the companyfriendlyURL
- the group's friendlyURLPortalException
- if a portal exception occurred@ThreadLocalCachable @Transactional(propagation=SUPPORTS, readOnly=true) Group getGroup(long groupId) throws PortalException
groupId
- the primary key of the groupPortalException
- if a group with the primary key could not be found@Skip @Transactional(propagation=SUPPORTS, readOnly=true) Group getGroup(long companyId, String groupKey) throws PortalException
companyId
- the primary key of the companygroupKey
- the group keyPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Group getGroupByUuidAndCompanyId(String uuid, long companyId) throws PortalException
uuid
- the group's UUIDcompanyId
- the primary key of the companyPortalException
- if a matching group could not be found@Deprecated @Transactional(propagation=SUPPORTS, readOnly=true) String getGroupDescriptiveName(Group group, Locale locale) throws PortalException
Group.getDescriptiveName(Locale)
PortalException
@Deprecated @Transactional(propagation=SUPPORTS, readOnly=true) String getGroupDescriptiveName(long groupId, Locale locale) throws PortalException
Group.getDescriptiveName(Locale)
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getGroups(int start, int end)
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.
start
- the lower bound of the range of groupsend
- the upper bound of the range of groups (not inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getGroups(long companyId, long parentGroupId, boolean site)
companyId
- the primary key of the companyparentGroupId
- the primary key of the parent groupsite
- whether the group is to be associated with a main sitenull
if no matches were
found@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getGroups(long companyId, long parentGroupId, boolean site, boolean inheritContent)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getGroups(long companyId, long parentGroupId, boolean site, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getGroups(long companyId, long parentGroupId, String name, boolean site, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getGroups(long companyId, String treePath, boolean site)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getGroups(long companyId, String className, long parentGroupId)
companyId
- the primary key of the companyclassName
- the class name of the groupparentGroupId
- the primary key of the parent groupnull
if no matches were
found@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getGroups(long companyId, String className, long parentGroupId, int start, int end)
companyId
- the primary key of the companyclassName
- the class name of the groupparentGroupId
- the primary key of the parent groupstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getGroups(long[] groupIds) throws PortalException
groupIds
- the primary keys of the groupsPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getGroupsCount()
@Transactional(propagation=SUPPORTS, readOnly=true) int getGroupsCount(long companyId, long parentGroupId, boolean site)
companyId
- the primary key of the companyparentGroupId
- the primary key of the parent groupsite
- whether the group is to be associated with a main site@Transactional(propagation=SUPPORTS, readOnly=true) int getGroupsCount(long companyId, long parentGroupId, String name, boolean site)
@Transactional(propagation=SUPPORTS, readOnly=true) int getGroupsCount(long companyId, String className, long parentGroupId)
companyId
- the primary key of the companyclassName
- the class name of the groupparentGroupId
- the primary key of the parent group@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) Group getLayoutGroup(long companyId, long plid) throws PortalException
companyId
- the primary key of the companyplid
- the primary key of the layoutPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Group getLayoutPrototypeGroup(long companyId, long layoutPrototypeId) throws PortalException
companyId
- the primary key of the companylayoutPrototypeId
- the primary key of the layout prototypePortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Group getLayoutSetPrototypeGroup(long companyId, long layoutSetPrototypeId) throws PortalException
companyId
- the primary key of the companylayoutSetPrototypeId
- the primary key of the layout set prototypePortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getLayoutsGroups(long companyId, long parentGroupId, boolean site, boolean active, int start, int end, OrderByComparator<Group> obc)
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.
companyId
- the primary key of the companyparentGroupId
- the primary key of the parent groupsite
- whether the group is to be associated with a main siteactive
- whether to return only active groups, or only inactive
groupsstart
- the lower bound of the range of groups to returnend
- the upper bound of the range of groups to return (not
inclusive)obc
- the comparator to order the groups (optionally
null
)obc
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getLayoutsGroups(long companyId, long parentGroupId, boolean site, int start, int end, OrderByComparator<Group> obc)
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.
companyId
- the primary key of the companyparentGroupId
- the primary key of the parent groupsite
- whether the group is to be associated with a main sitestart
- the lower bound of the range of groups to returnend
- the upper bound of the range of groups to return (not
inclusive)obc
- the comparator to order the groups (optionally
null
)obc
@Transactional(propagation=SUPPORTS, readOnly=true) int getLayoutsGroupsCount(long companyId, long parentGroupId, boolean site)
companyId
- the primary key of the companyparentGroupId
- the primary key of the parent groupsite
- whether the group is to be associated with a main site@Transactional(propagation=SUPPORTS, readOnly=true) int getLayoutsGroupsCount(long companyId, long parentGroupId, boolean site, boolean active)
companyId
- the primary key of the companyparentGroupId
- the primary key of the parent groupsite
- whether the group is to be associated with a main siteactive
- whether to return only active groups, or only inactive
groups@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getLiveGroups()
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getNoLayoutsGroups(String className, boolean privateLayout, int start, int end)
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.
className
- the entity's class nameprivateLayout
- whether to include groups with private layout sets
or non-private layout setsstart
- the lower bound of the range of groups to returnend
- the upper bound of the range of groups to return (not
inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getNullFriendlyURLGroups()
null
or empty friendly
URLs.null
or empty friendly
URLs@Transactional(propagation=SUPPORTS, readOnly=true) Group getOrganizationGroup(long companyId, long organizationId) throws PortalException
companyId
- the primary key of the companyorganizationId
- the primary key of the organizationPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getOrganizationGroups(long organizationId)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getOrganizationGroups(long organizationId, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getOrganizationGroups(long organizationId, int start, int end, OrderByComparator<Group> orderByComparator)
@Transactional(propagation=SUPPORTS, readOnly=true) int getOrganizationGroupsCount(long organizationId)
@Transactional(propagation=SUPPORTS, readOnly=true) long[] getOrganizationPrimaryKeys(long groupId)
groupId
- the groupId of the group@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getOrganizationsGroups(List<Organization> organizations)
organizations
- the organizations@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getOrganizationsRelatedGroups(List<Organization> organizations)
organizations
- the organizationsString getOSGiServiceIdentifier()
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getParentGroups(long groupId) throws PortalException
groupId
- the primary key of the groupPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
getPersistedModel
in interface PersistedModelLocalService
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getRoleGroups(long roleId)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getRoleGroups(long roleId, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getRoleGroups(long roleId, int start, int end, OrderByComparator<Group> orderByComparator)
@Transactional(propagation=SUPPORTS, readOnly=true) int getRoleGroupsCount(long roleId)
@Transactional(propagation=SUPPORTS, readOnly=true) long[] getRolePrimaryKeys(long groupId)
groupId
- the groupId of the group@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getStagedSites()
@Transactional(propagation=SUPPORTS, readOnly=true) Group getStagingGroup(long liveGroupId) throws PortalException
liveGroupId
- the primary key of the live groupPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Group getUserGroup(long companyId, long userId) throws PortalException
companyId
- the primary key of the companyuserId
- the primary key of the userPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Group getUserGroupGroup(long companyId, long userGroupId) throws PortalException
UserGroup
entity.companyId
- the primary key of the companyuserGroupId
- the primary key of the user groupPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserGroupGroups(long userGroupId)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserGroupGroups(long userGroupId, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserGroupGroups(long userGroupId, int start, int end, OrderByComparator<Group> orderByComparator)
@Transactional(propagation=SUPPORTS, readOnly=true) int getUserGroupGroupsCount(long userGroupId)
@Transactional(propagation=SUPPORTS, readOnly=true) long[] getUserGroupPrimaryKeys(long groupId)
groupId
- the groupId of the group@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserGroups(long userId)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserGroups(long userId, boolean inherit) throws PortalException
userId
- the primary key of the userinherit
- whether to include the user's inherited organization
groups and user groupsPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserGroups(long userId, boolean inherit, int start, int end) throws PortalException
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.
userId
- the primary key of the userinherit
- whether to include the user's inherited organization
groups and user groupsstart
- the lower bound of the range of groups to returnend
- the upper bound of the range of groups to return (not
inclusive)PortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserGroups(long userId, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserGroups(long userId, int start, int end, OrderByComparator<Group> orderByComparator) throws PortalException
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) int getUserGroupsCount(long userId)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserGroupsGroups(List<UserGroup> userGroups) throws PortalException
userGroups
- the user groupsPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserGroupsRelatedGroups(List<UserGroup> userGroups)
userGroups
- the user groups@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserOrganizationsGroups(long userId, int start, int end) throws PortalException
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.
userId
- the primary key of the userstart
- the lower bound of the range of groups to considerend
- the upper bound of the range of groups to consider (not
inclusive)PortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Group getUserPersonalSiteGroup(long companyId) throws PortalException
companyId
- the primary key of the companyPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) long[] getUserPrimaryKeys(long groupId)
groupId
- the groupId of the group@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserSitesGroups(long userId) throws PortalException
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserSitesGroups(long userId, boolean includeAdministrative) throws PortalException
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasOrganizationGroup(long organizationId, long groupId)
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasOrganizationGroups(long organizationId)
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasRoleGroup(long roleId, long groupId)
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasRoleGroups(long roleId)
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasStagingGroup(long liveGroupId)
true
if the live group has a staging group.liveGroupId
- the primary key of the live grouptrue
if the live group has a staging group;
false
otherwise@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasUserGroup(long userId, long groupId)
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasUserGroup(long userId, long groupId, boolean inherit)
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.userId
- the primary key of the usergroupId
- the primary key of the groupinherit
- whether to include organization groups and user groups to
which the user belongs in the determinationtrue
if the user is associated with the group;
false
otherwise@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasUserGroupGroup(long userGroupId, long groupId)
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasUserGroupGroups(long userGroupId)
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasUserGroups(long userId)
@Skip @Transactional(propagation=SUPPORTS, readOnly=true) boolean isLiveGroupActive(Group group)
@Transactional(propagation=SUPPORTS, readOnly=true) Group loadFetchGroup(long companyId, String groupKey)
companyId
- the primary key of the companygroupKey
- the group keynull
if a matching group could not be found@Transactional(propagation=SUPPORTS, readOnly=true) Group loadGetGroup(long companyId, String groupKey) throws PortalException
companyId
- the primary key of the companygroupKey
- the group keyPortalException
- if a portal exception occurredvoid rebuildTree(long companyId) throws PortalException
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.
companyId
- the primary key of the group's companyPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> search(long companyId, LinkedHashMap<String,Object> params, int start, int end)
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.
companyId
- the primary key of the companyparams
- 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 returnend
- the upper bound of the range of groups to return (not
inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> search(long companyId, long parentGroupId, String keywords, LinkedHashMap<String,Object> params, int start, int end)
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.
companyId
- the primary key of the companyparentGroupId
- the primary key of the parent groupkeywords
- 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 returnend
- the upper bound of the range of groups to return (not
inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> search(long companyId, long parentGroupId, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Group> obc)
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.
companyId
- the primary key of the companyparentGroupId
- the primary key of the parent groupkeywords
- 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 returnend
- the upper bound of the range of groups to return (not
inclusive)obc
- the comparator to order the groups (optionally
null
)obc
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> search(long companyId, long parentGroupId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end)
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.
companyId
- the primary key of the companyparentGroupId
- the primary key of the parent groupname
- 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 returnend
- the upper bound of the range of groups to return (not
inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> search(long companyId, long parentGroupId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> obc)
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.
companyId
- the primary key of the companyparentGroupId
- the primary key of the parent groupname
- 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 returnend
- the upper bound of the range of groups to return (not
inclusive)obc
- the comparator to order the groups (optionally
null
)obc
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> search(long companyId, long[] classNameIds, long parentGroupId, String keywords, LinkedHashMap<String,Object> params, int start, int end)
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.
companyId
- the primary key of the companyclassNameIds
- the primary keys of the class names of the entities
the groups are related to (optionally null
)parentGroupId
- the primary key of the parent groupkeywords
- 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 returnend
- the upper bound of the range of groups to return (not
inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> search(long companyId, long[] classNameIds, long parentGroupId, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Group> obc)
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.
companyId
- the primary key of the companyclassNameIds
- the primary keys of the class names of the entities
the groups are related to (optionally null
)parentGroupId
- the primary key of the parent groupkeywords
- 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 returnend
- the upper bound of the range of groups to return (not
inclusive)obc
- the comparator to order the groups (optionally
null
)obc
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> search(long companyId, long[] classNameIds, long parentGroupId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end)
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.
companyId
- the primary key of the companyclassNameIds
- the primary keys of the class names of the entities
the groups are related to (optionally null
)parentGroupId
- the primary key of the parent groupname
- 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 returnend
- the upper bound of the range of groups to return (not
inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> search(long companyId, long[] classNameIds, long parentGroupId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> obc)
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.
companyId
- the primary key of the companyclassNameIds
- the primary keys of the class names of the entities
the groups are related to (optionally null
)parentGroupId
- the primary key of the parent groupname
- 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 returnend
- the upper bound of the range of groups to return (not
inclusive)obc
- the comparator to order the groups (optionally
null
)obc
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> search(long companyId, long[] classNameIds, String keywords, LinkedHashMap<String,Object> params, int start, int end)
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.
companyId
- the primary key of the companyclassNameIds
- 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 returnend
- the upper bound of the range of groups to return (not
inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> search(long companyId, long[] classNameIds, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Group> obc)
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.
companyId
- the primary key of the companyclassNameIds
- 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 returnend
- the upper bound of the range of groups to return (not
inclusive)obc
- the comparator to order the groups (optionally
null
)obc
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> search(long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end)
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.
companyId
- the primary key of the companyclassNameIds
- 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 returnend
- the upper bound of the range of groups to return (not
inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> search(long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> obc)
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.
companyId
- the primary key of the companyclassNameIds
- 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 returnend
- the upper bound of the range of groups to return (not
inclusive)obc
- the comparator to order the groups (optionally
null
)obc
@ThreadLocalCachable @Transactional(propagation=SUPPORTS, readOnly=true) List<Group> search(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end)
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.
companyId
- the primary key of the companykeywords
- 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 returnend
- the upper bound of the range of groups to return (not
inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> search(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Group> obc)
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.
companyId
- the primary key of the companykeywords
- 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 returnend
- the upper bound of the range of groups to return (not
inclusive)obc
- the comparator to order the groups (optionally
null
)obc
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> search(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end)
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.
companyId
- the primary key of the companyname
- 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 returnend
- the upper bound of the range of groups to return (not
inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> search(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> obc)
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.
companyId
- the primary key of the companyname
- 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 returnend
- the upper bound of the range of groups to return (not
inclusive)obc
- the comparator to order the groups (optionally
null
)obc
@ThreadLocalCachable @Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, long parentGroupId, String keywords, LinkedHashMap<String,Object> params)
companyId
- the primary key of the companyparentGroupId
- the primary key of the parent groupkeywords
- 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
.@ThreadLocalCachable @Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, long parentGroupId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator)
companyId
- the primary key of the companyparentGroupId
- the primary key of the parent groupname
- 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.@ThreadLocalCachable @Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, long[] classNameIds, long parentGroupId, String keywords, LinkedHashMap<String,Object> params)
companyId
- the primary key of the companyclassNameIds
- the primary keys of the class names of the entities
the groups are related to (optionally null
)parentGroupId
- the primary key of the parent groupkeywords
- 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
.@ThreadLocalCachable @Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, long[] classNameIds, long parentGroupId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator)
companyId
- the primary key of the companyclassNameIds
- the primary keys of the class names of the entities
the groups are related to (optionally null
)parentGroupId
- the primary key of the parent groupname
- 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.@ThreadLocalCachable @Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, long[] classNameIds, String keywords, LinkedHashMap<String,Object> params)
companyId
- the primary key of the companyclassNameIds
- 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
.@ThreadLocalCachable @Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator)
companyId
- the primary key of the companyclassNameIds
- 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.@ThreadLocalCachable @Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, String keywords, LinkedHashMap<String,Object> params)
companyId
- the primary key of the companykeywords
- 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
.@ThreadLocalCachable @Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator)
companyId
- the primary key of the companyname
- 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.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)
roleId
- the primary key of the rolegroupIds
- the primary keys of the groupsvoid unsetUserGroups(long userId, long[] groupIds)
userId
- the primary key of the usergroupIds
- the primary keys of the groupsvoid updateAsset(long userId, Group group, long[] assetCategoryIds, String[] assetTagNames) throws PortalException
userId
- the primary key of the usergroup
- the groupassetCategoryIds
- the primary keys of the asset categories
(optionally null
)assetTagNames
- the asset tag names (optionally null
)PortalException
- if a portal exception occurredGroup updateFriendlyURL(long groupId, String friendlyURL) throws PortalException
groupId
- the primary key of the groupfriendlyURL
- the group's new friendlyURL (optionally
null
)PortalException
- if a portal exception occurred@Indexable(type=REINDEX) Group updateGroup(Group group)
group
- the groupGroup updateGroup(long groupId, long parentGroupId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean inheritContent, boolean active, ServiceContext serviceContext) throws PortalException
PortalException
@Deprecated Group updateGroup(long groupId, long parentGroupId, String name, String description, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean inheritContent, boolean active, ServiceContext serviceContext) throws PortalException
updateGroup(long, long, Map, Map, int, boolean, int, String,
boolean, boolean, ServiceContext)
groupId
- the primary key of the groupparentGroupId
- the primary key of the parent groupname
- the name's keydescription
- 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
groupmembershipRestriction
- 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
groupactive
- whether the group is activeserviceContext
- the service context to be applied (optionally
null
). Can set asset category IDs and asset tag
names for the group.PortalException
- if a portal exception occurredGroup updateGroup(long groupId, String typeSettings) throws PortalException
groupId
- the primary key of the grouptypeSettings
- the group's new type settings (optionally
null
)PortalException
- if a portal exception occurredGroup updateSite(long groupId, boolean site) throws PortalException
groupId
- the primary key of the groupsite
- whether the group is to be associated with a main sitePortalException
- if a portal exception occurred