Interface GroupLocalService
- All Superinterfaces:
BaseLocalService
,CTService<Group>
,PersistedModelLocalService
- All Known Implementing Classes:
GroupLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddGroup
(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) 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) Adds the group to the database.boolean
addOrganizationGroup
(long organizationId, long groupId) boolean
addOrganizationGroup
(long organizationId, Group group) boolean
addOrganizationGroups
(long organizationId, long[] groupIds) boolean
addOrganizationGroups
(long organizationId, List<Group> groups) addOrUpdateGroup
(String externalReferenceCode, 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) boolean
addRoleGroup
(long roleId, long groupId) boolean
addRoleGroup
(long roleId, Group group) boolean
addRoleGroups
(long roleId, long[] groupIds) boolean
addRoleGroups
(long roleId, List<Group> groups) boolean
addUserGroup
(long userId, long groupId) boolean
addUserGroup
(long userId, Group group) boolean
addUserGroupGroup
(long userGroupId, long groupId) boolean
addUserGroupGroup
(long userGroupId, Group group) boolean
addUserGroupGroups
(long userGroupId, long[] groupIds) boolean
addUserGroupGroups
(long userGroupId, List<Group> groups) boolean
addUserGroups
(long userId, long[] groupIds) boolean
addUserGroups
(long userId, List<Group> groups) void
checkCompanyGroup
(long companyId) Adds a company group if it does not exist.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) createGroup
(long groupId) Creates a new group with the primary key.createPersistedModel
(Serializable primaryKeyObj) deleteGroup
(long groupId) Deletes the group with the primary key from the database.deleteGroup
(Group group) Deletes the group from the database.void
deleteOrganizationGroup
(long organizationId, long groupId) void
deleteOrganizationGroup
(long organizationId, Group group) void
deleteOrganizationGroups
(long organizationId, long[] groupIds) void
deleteOrganizationGroups
(long organizationId, List<Group> groups) deletePersistedModel
(PersistedModel persistedModel) void
deleteRoleGroup
(long roleId, long groupId) void
deleteRoleGroup
(long roleId, Group group) void
deleteRoleGroups
(long roleId, long[] groupIds) void
deleteRoleGroups
(long roleId, List<Group> groups) void
deleteUserGroup
(long userId, long groupId) void
deleteUserGroup
(long userId, Group group) void
deleteUserGroupGroup
(long userGroupId, long groupId) void
deleteUserGroupGroup
(long userGroupId, Group group) void
deleteUserGroupGroups
(long userGroupId, long[] groupIds) void
deleteUserGroupGroups
(long userGroupId, List<Group> groups) void
deleteUserGroups
(long userId, long[] groupIds) void
deleteUserGroups
(long userId, List<Group> groups) void
disableStaging
(long groupId) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <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) fetchCompanyGroup
(long companyId) Returns the company's group.fetchFriendlyURLGroup
(long companyId, String friendlyURL) Returns the group with the matching friendly URL.fetchGroup
(long groupId) fetchGroup
(long companyId, long classNameId, long classPK) 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.fetchGroupByExternalReferenceCode
(String externalReferenceCode, long companyId) fetchGroupByUuidAndCompanyId
(String uuid, long companyId) Returns the group with the matching UUID and company.fetchStagingGroup
(long liveGroupId) fetchUserGroup
(long companyId, long userId) fetchUserPersonalSiteGroup
(long companyId) Returns the default user's personal site group.getActiveGroupIds
(long userId) getActiveGroups
(long companyId, boolean active) Returns all the active or inactive groups associated with the company.getActiveGroups
(long companyId, boolean site, boolean active, int start, int end, OrderByComparator<Group> orderByComparator) Returns the active or inactive groups associated with the company and, optionally, the main site.getActiveGroups
(long companyId, boolean active, int start, int end, OrderByComparator<Group> orderByComparator) Returns the active or inactive groups associated with the company.int
getActiveGroupsCount
(long companyId, boolean active) Returns the number of active or inactive groups associated with the company.int
getActiveGroupsCount
(long companyId, boolean active, boolean site) Returns the number of active or inactive groups associated with the company.getCompanyGroup
(long companyId) Returns the company 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.getFriendlyURLGroup
(long companyId, String friendlyURL) Returns the group with the matching friendly URL.getGroup
(long groupId) Returns the group with the primary key.Returns the group with the matching group key.getGroupByExternalReferenceCode
(String externalReferenceCode, long companyId) getGroupByUuidAndCompanyId
(String uuid, long companyId) Returns the group with the matching UUID and company.getGroupIds
(long companyId, boolean active) getGroups
(int start, int end) Returns a range of all the groups.getGroups
(long[] groupIds) Returns the groups with the matching primary keys.getGroups
(long companyId, long parentGroupId, boolean site) Returns all the groups that are direct children of the parent group.getGroups
(long companyId, long parentGroupId, boolean site, boolean inheritContent) getGroups
(long companyId, long parentGroupId, boolean site, int start, int end) Returns all the groups that are direct children of the parent group with the matching className.Returns a range of all the groups that are direct children of the parent group with the matching className.int
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.getLayoutGroup
(long companyId, long plid) Returns the group associated with the layout.getLayoutPrototypeGroup
(long companyId, long layoutPrototypeId) Returns the group associated with the layout prototype.getLayoutSetPrototypeGroup
(long companyId, long layoutSetPrototypeId) Returns the group associated with the layout set prototype.getLayoutsGroups
(long companyId, long parentGroupId, boolean site, boolean active, int start, int end, OrderByComparator<Group> orderByComparator) Returns a range of all groups that are children of the parent group and that have at least one layout.getLayoutsGroups
(long companyId, long parentGroupId, boolean site, int start, int end, OrderByComparator<Group> orderByComparator) 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 layoutint
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 layoutReturns all live groups.getOrganizationGroup
(long companyId, long organizationId) Returns the specified organization group.getOrganizationGroups
(long organizationId) getOrganizationGroups
(long organizationId, int start, int end) 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.getOrganizationsGroups
(List<Organization> organizations) Returns the specified organization groups.getOrganizationsRelatedGroups
(List<Organization> organizations) Returns all the groups related to the organizations.Returns the OSGi service identifier.getParentGroups
(long groupId) Returns the group followed by all its parent groups ordered by closest ancestor.getPersistedModel
(Serializable primaryKeyObj) getRoleGroups
(long roleId) getRoleGroups
(long roleId, int start, int end) 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.getStagingGroup
(long liveGroupId) Returns the staging group.getUserGroup
(long companyId, long userId) Returns the group directly associated with the user.getUserGroupGroup
(long companyId, long userGroupId) Returns the specified "user group" group.getUserGroupGroups
(long userGroupId) getUserGroupGroups
(long userGroupId, int start, int end) 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.getUserGroups
(long userId) 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.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.getUserGroups
(long userId, int start, int end) getUserGroups
(long userId, int start, int end, OrderByComparator<Group> orderByComparator) int
getUserGroupsCount
(long userId) getUserGroupsGroups
(List<UserGroup> userGroups) Returns the groups associated with the user groups.getUserGroupsRelatedGroups
(List<UserGroup> userGroups) Returns all the groups related to the user groups.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 propertyorganizations.membership.strict
is set totrue
.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.getUserSitesGroups
(long userId) getUserSitesGroups
(long userId, boolean includeAdministrative) getUserSitesGroups
(long userId, int start, int end) boolean
hasOrganizationGroup
(long organizationId, long groupId) boolean
hasOrganizationGroups
(long organizationId) boolean
hasRoleGroup
(long roleId, long groupId) boolean
hasRoleGroups
(long roleId) boolean
hasStagingGroup
(long liveGroupId) Returnstrue
if the live group has a staging group.boolean
hasUserGroup
(long userId, long groupId) boolean
hasUserGroup
(long userId, long groupId, boolean inherit) Returnstrue
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) 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.loadGetGroup
(long companyId, String groupKey) Returns the group with the matching group key.void
rebuildTree
(long companyId) Rebuilds the group tree.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.search
(long companyId, long[] classNameIds, long parentGroupId, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> orderByComparator) 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.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.search
(long companyId, long[] classNameIds, long parentGroupId, String keywords, LinkedHashMap<String, Object> params, int start, int end, OrderByComparator<Group> orderByComparator) 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.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.search
(long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> orderByComparator) 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.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.search
(long companyId, long[] classNameIds, String keywords, LinkedHashMap<String, Object> params, int start, int end, OrderByComparator<Group> orderByComparator) 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.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.search
(long companyId, long parentGroupId, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> orderByComparator) 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.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.search
(long companyId, long parentGroupId, String keywords, LinkedHashMap<String, Object> params, int start, int end, OrderByComparator<Group> orderByComparator) 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.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.search
(long companyId, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> orderByComparator) 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.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.search
(long companyId, String keywords, LinkedHashMap<String, Object> params, int start, int end, OrderByComparator<Group> orderByComparator) Returns an ordered range of all the groups that match the keywords, optionally including the user's inherited organization groups and user groups.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.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, 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, 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[] 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 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, 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, 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.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.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.updateFriendlyURL
(long groupId, String friendlyURL) Updates the group's friendly URL.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) updateGroup
(long groupId, String typeSettings) Updates the group's type settings.updateGroup
(Group group) Updates the group in the database or adds it if it does not yet exist.updateSite
(long groupId, boolean site) Associates the group with a main site if the group is an organization.<R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<CTPersistence<Group>, R, E> updateUnsafeFunction) void
validateRemote
(long groupId, String remoteAddress, int remotePort, String remotePathContext, boolean secureConnection, long remoteGroupId) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addGroup
Adds the group to the database. Also notifies the appropriate model listeners.Important: Inspect GroupLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
group
- the group- Returns:
- the group that was added
-
addGroup
Group addGroup(long userId, long parentGroupId, String className, long classPK, long liveGroupId, Map<Locale, String> nameMap, Map<Locale, throws PortalExceptionString> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean site, boolean inheritContent, boolean active, ServiceContext serviceContext) - Throws:
PortalException
-
addGroup
Group addGroup(long userId, long parentGroupId, String className, long classPK, long liveGroupId, Map<Locale, String> nameMap, Map<Locale, throws PortalExceptionString> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean site, boolean active, ServiceContext serviceContext) - Throws:
PortalException
-
addOrganizationGroup
-
addOrganizationGroup
boolean addOrganizationGroup(long organizationId, long groupId) -
addOrganizationGroups
-
addOrganizationGroups
boolean addOrganizationGroups(long organizationId, long[] groupIds) -
addOrUpdateGroup
Group addOrUpdateGroup(String externalReferenceCode, long userId, long parentGroupId, String className, long classPK, long liveGroupId, Map<Locale, String> nameMap, Map<Locale, throws ExceptionString> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean site, boolean inheritContent, boolean active, ServiceContext serviceContext) - Throws:
Exception
-
addRoleGroup
-
addRoleGroup
boolean addRoleGroup(long roleId, long groupId) -
addRoleGroups
-
addRoleGroups
boolean addRoleGroups(long roleId, long[] groupIds) -
addUserGroup
-
addUserGroup
boolean addUserGroup(long userId, long groupId) -
addUserGroupGroup
-
addUserGroupGroup
boolean addUserGroupGroup(long userGroupId, long groupId) -
addUserGroupGroups
-
addUserGroupGroups
boolean addUserGroupGroups(long userGroupId, long[] groupIds) -
addUserGroups
-
addUserGroups
boolean 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
- 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
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
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteGroup
Deletes the group from the database. Also notifies the appropriate model listeners.Important: Inspect GroupLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
group
- the group- Returns:
- the group that was removed
- Throws:
PortalException
-
deleteGroup
Deletes the group with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect GroupLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- 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
-
deleteOrganizationGroup
void deleteOrganizationGroup(long organizationId, long groupId) -
deleteOrganizationGroups
-
deleteOrganizationGroups
void deleteOrganizationGroups(long organizationId, long[] groupIds) -
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteRoleGroup
-
deleteRoleGroup
void deleteRoleGroup(long roleId, long groupId) -
deleteRoleGroups
-
deleteRoleGroups
void deleteRoleGroups(long roleId, long[] groupIds) -
deleteUserGroup
-
deleteUserGroup
void deleteUserGroup(long userId, long groupId) -
deleteUserGroupGroup
-
deleteUserGroupGroup
void deleteUserGroupGroup(long userGroupId, long groupId) -
deleteUserGroupGroups
-
deleteUserGroupGroups
void deleteUserGroupGroups(long userGroupId, long[] groupIds) -
deleteUserGroups
-
deleteUserGroups
void deleteUserGroups(long userId, long[] groupIds) -
disableStaging
- Throws:
PortalException
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
dynamicQuery
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.GroupModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.GroupModelImpl
.- Parameters:
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 (optionallynull
)- 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 queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
enableStaging
- Throws:
PortalException
-
fetchCompanyGroup
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, String friendlyURL) Returns the group with the matching friendly URL.- Parameters:
companyId
- the primary key of the companyfriendlyURL
- 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
@Transactional(propagation=SUPPORTS, readOnly=true) Group fetchGroup(long companyId, long classNameId, long classPK) -
fetchGroup
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 companygroupKey
- the group key- Returns:
- the group with the group key and associated company, or
null
if a matching group could not be found
-
fetchGroupByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) Group fetchGroupByExternalReferenceCode(String externalReferenceCode, long companyId) -
fetchGroupByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) Group fetchGroupByUuidAndCompanyId(String uuid, long companyId) Returns the group with the matching UUID and company.- Parameters:
uuid
- the group's UUIDcompanyId
- the primary key of the company- Returns:
- the matching group, or
null
if a matching group could not be found
-
fetchStagingGroup
-
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
-
getActiveGroups
@Transactional(propagation=SUPPORTS, readOnly=true) 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 companyactive
- whether to return only active groups or only inactive groups- Returns:
- the active or inactive groups
-
getActiveGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getActiveGroups(long companyId, boolean site, boolean active, int start, int end, OrderByComparator<Group> orderByComparator) Returns the active or inactive groups associated with the company and, optionally, the main site.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the companysite
- whether the group is 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)orderByComparator
- the comparator to order the groups (optionallynull
)- Returns:
- the active or inactive groups
-
getActiveGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getActiveGroups(long companyId, boolean active, int start, int end, OrderByComparator<Group> orderByComparator) Returns the active or inactive groups associated with the company.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the companyactive
- 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)orderByComparator
- the comparator to order the groups (optionallynull
)- Returns:
- the active or inactive groups
-
getActiveGroupsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getActiveGroupsCount(long companyId, boolean active) Returns the number of active or inactive groups associated with the company.- Parameters:
companyId
- the primary key of the companyactive
- whether to count only active groups or only inactive groups- Returns:
- the number of active or inactive groups
-
getActiveGroupsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getActiveGroupsCount(long companyId, boolean active, boolean site) Returns the number of active or inactive groups associated with the company.- Parameters:
companyId
- the primary key of the companyactive
- whether to count only active groups or only inactive groupssite
- whether the group is to be associated with a main site- Returns:
- the number of active or inactive groups
-
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) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
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)- Returns:
- the range of groups associated with the company
-
getCompanyGroupsCount
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, String friendlyURL) throws PortalException Returns the group with the matching friendly URL.- Parameters:
companyId
- the primary key of the companyfriendlyURL
- 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
@Transactional(enabled=false) Group getGroup(long companyId, String groupKey) throws PortalException Returns the group with the matching group key.- Parameters:
companyId
- the primary key of the companygroupKey
- the group key- Returns:
- the group with the group key
- Throws:
PortalException
- if a portal exception occurred
-
getGroupByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) Group getGroupByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Throws:
PortalException
-
getGroupByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) Group getGroupByUuidAndCompanyId(String uuid, long companyId) throws PortalException Returns the group with the matching UUID and company.- Parameters:
uuid
- the group's UUIDcompanyId
- the primary key of the company- Returns:
- the matching group
- Throws:
PortalException
- if a matching group could not be found
-
getGroupIds
@Transactional(propagation=SUPPORTS, readOnly=true) List<Long> getGroupIds(long companyId, boolean active) -
getGroups
Returns a range of all the groups.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.GroupModelImpl
.- Parameters:
start
- the lower bound of the range of groupsend
- the upper bound of the range of groups (not inclusive)- Returns:
- the range of groups
-
getGroups
@Transactional(propagation=SUPPORTS, readOnly=true) 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 companyparentGroupId
- the primary key of the parent groupsite
- 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) List<Group> getGroups(long companyId, long parentGroupId, boolean site, boolean inheritContent) -
getGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getGroups(long companyId, long parentGroupId, boolean site, int start, int end) -
getGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getGroups(long companyId, long parentGroupId, String name, boolean site, int start, int end) -
getGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getGroups(long companyId, String treePath, boolean site) -
getGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getGroups(long companyId, String className, long parentGroupId) Returns all the groups that are direct children of the parent group with the matching className.- Parameters:
companyId
- the primary key of the companyclassName
- the class name of the groupparentGroupId
- the primary key of the parent group- Returns:
- the matching groups, or
null
if no matches were found
-
getGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getGroups(long companyId, String className, long parentGroupId, int start, int end) Returns a range of all the groups that are direct children of the parent group with the matching className.- Parameters:
companyId
- the primary key of the 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)- Returns:
- the range of matching groups
-
getGroups
@Transactional(propagation=SUPPORTS, readOnly=true) 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
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 companyparentGroupId
- the primary key of the parent groupsite
- 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, String name, boolean site) -
getGroupsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getGroupsCount(long companyId, String className, long parentGroupId) Returns the number of groups that are direct children of the parent group with the matching className.- Parameters:
companyId
- the primary key of the companyclassName
- the class name of the groupparentGroupId
- 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 companyplid
- 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 companylayoutPrototypeId
- 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 companylayoutSetPrototypeId
- 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) List<Group> getLayoutsGroups(long companyId, long parentGroupId, boolean site, boolean active, int start, int end, OrderByComparator<Group> orderByComparator) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
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)orderByComparator
- the comparator to order the groups (optionallynull
)- Returns:
- the range of matching groups ordered by comparator
orderByComparator
-
getLayoutsGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getLayoutsGroups(long companyId, long parentGroupId, boolean site, int start, int end, OrderByComparator<Group> orderByComparator) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
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)orderByComparator
- the comparator to order the groups (optionallynull
)- Returns:
- the range of matching groups ordered by comparator
orderByComparator
-
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 companyparentGroupId
- the primary key of the parent groupsite
- 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 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- Returns:
- the number of matching groups
-
getLiveGroups
Returns all live groups.- Returns:
- all live groups
-
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 companyorganizationId
- 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) List<Group> getOrganizationGroups(long organizationId) -
getOrganizationGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getOrganizationGroups(long organizationId, int start, int end) -
getOrganizationGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getOrganizationGroups(long organizationId, int start, int end, OrderByComparator<Group> orderByComparator) -
getOrganizationGroupsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getOrganizationGroupsCount(long organizationId) -
getOrganizationPrimaryKeys
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) List<Group> getOrganizationsGroups(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) List<Group> getOrganizationsRelatedGroups(List<Organization> organizations) Returns all the groups related to the organizations.- Parameters:
organizations
- the organizations- Returns:
- the groups related to the organizations
-
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getParentGroups
@Transactional(propagation=SUPPORTS, readOnly=true) 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(Serializable primaryKeyObj) throws PortalException - Specified by:
getPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
getRoleGroups
-
getRoleGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getRoleGroups(long roleId, int start, int end) -
getRoleGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getRoleGroups(long roleId, int start, int end, OrderByComparator<Group> orderByComparator) -
getRoleGroupsCount
-
getRolePrimaryKeys
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
-
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 companyuserId
- 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 theUserGroup
entity.- Parameters:
companyId
- the primary key of the companyuserGroupId
- 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) List<Group> getUserGroupGroups(long userGroupId) -
getUserGroupGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserGroupGroups(long userGroupId, int start, int end) -
getUserGroupGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserGroupGroups(long userGroupId, int start, int end, OrderByComparator<Group> orderByComparator) -
getUserGroupGroupsCount
-
getUserGroupPrimaryKeys
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
-
getUserGroups
@Transactional(propagation=SUPPORTS, readOnly=true) 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 userinherit
- 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) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
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)- 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) List<Group> getUserGroups(long userId, int start, int end) -
getUserGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserGroups(long userId, int start, int end, OrderByComparator<Group> orderByComparator) throws PortalException - Throws:
PortalException
-
getUserGroupsCount
-
getUserGroupsGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserGroupsGroups(List<UserGroup> userGroups) throws PortalException Returns the groups associated with the user groups.- Parameters:
userGroups
- the user groups- Returns:
- the groups associated with the user groups
- Throws:
PortalException
- if a portal exception occurred
-
getUserGroupsRelatedGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserGroupsRelatedGroups(List<UserGroup> userGroups) Returns all the groups related to the user groups.- Parameters:
userGroups
- the user groups- Returns:
- the groups related to the user groups
-
getUserOrganizationsGroups
@Transactional(propagation=SUPPORTS, readOnly=true) 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 propertyorganizations.membership.strict
is set totrue
.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
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)- 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
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) List<Group> getUserSitesGroups(long userId) throws PortalException - Throws:
PortalException
-
getUserSitesGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserSitesGroups(long userId, boolean includeAdministrative) throws PortalException - Throws:
PortalException
-
getUserSitesGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserSitesGroups(long userId, int start, int end) 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
-
hasRoleGroups
-
hasStagingGroup
Returnstrue
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
-
hasUserGroup
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasUserGroup(long userId, long groupId, boolean inherit) Returnstrue
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 usergroupId
- the primary key of the groupinherit
- 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
-
hasUserGroups
-
isLiveGroupActive
-
loadFetchGroup
@Transactional(propagation=SUPPORTS, readOnly=true) Group loadFetchGroup(long companyId, String groupKey) Returns the group with the matching group key by first searching the system groups and then using the finder cache.- Parameters:
companyId
- the primary key of the companygroupKey
- 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, String groupKey) throws PortalException Returns the group with the matching group key.- Parameters:
companyId
- the primary key of the companygroupKey
- the group key- Returns:
- the group with the group key and associated company
- Throws:
PortalException
- if a portal exception occurred
-
rebuildTree
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) List<Group> search(long companyId, LinkedHashMap<String, Object> params, int start, int end) Returns an ordered range of all the company's groups, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the companyparams
- the finder params (optionallynull
). 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 seeGroupFinder
.start
- the lower bound of the range of groups to returnend
- 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) List<Group> search(long companyId, long parentGroupId, String keywords, LinkedHashMap<String, Object> params, int start, int end) Returns an ordered range of all the groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
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 (optionallynull
)params
- the finder params (optionallynull
). 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 seeGroupFinder
.start
- the lower bound of the range of groups to returnend
- 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) List<Group> search(long companyId, long parentGroupId, String keywords, LinkedHashMap<String, Object> params, int start, int end, OrderByComparator<Group> orderByComparator) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
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 (optionallynull
)params
- the finder params (optionallynull
). 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 seeGroupFinder
.start
- the lower bound of the range of groups to returnend
- the upper bound of the range of groups to return (not inclusive)orderByComparator
- the comparator to order the groups (optionallynull
)- Returns:
- the matching groups ordered by comparator
orderByComparator
-
search
@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) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the companyparentGroupId
- the primary key of the parent groupname
- the group's name (optionallynull
)description
- the group's description (optionallynull
)params
- the finder params (optionallynull
). 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 seeGroupFinder
.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)- Returns:
- the matching groups ordered by name
-
search
@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> orderByComparator) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the companyparentGroupId
- the primary key of the parent groupname
- the group's name (optionallynull
)description
- the group's description (optionallynull
)params
- the finder params (optionallynull
). 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 seeGroupFinder
.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)orderByComparator
- the comparator to order the groups (optionallynull
)- Returns:
- the matching groups ordered by comparator
orderByComparator
-
search
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> search(long companyId, long[] classNameIds, long parentGroupId, String keywords, LinkedHashMap<String, Object> params, int start, int end) Returns an ordered range of all the groups belonging to the parent group that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the companyclassNameIds
- the primary keys of the class names of the entities the groups are related to (optionallynull
)parentGroupId
- the primary key of the parent groupkeywords
- the keywords (space separated), which may occur in the sites's name, or description (optionallynull
)params
- the finder params (optionallynull
). 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 seeGroupFinder
.start
- the lower bound of the range of groups to returnend
- 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) List<Group> search(long companyId, long[] classNameIds, long parentGroupId, String keywords, LinkedHashMap<String, Object> params, int start, int end, OrderByComparator<Group> orderByComparator) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the companyclassNameIds
- the primary keys of the class names of the entities the groups are related to (optionallynull
)parentGroupId
- the primary key of the parent groupkeywords
- the keywords (space separated), which may occur in the sites's name, or description (optionallynull
)params
- the finder params (optionallynull
). 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 seeGroupFinder
.start
- the lower bound of the range of groups to returnend
- the upper bound of the range of groups to return (not inclusive)orderByComparator
- the comparator to order the groups (optionallynull
)- Returns:
- the matching groups ordered by comparator
orderByComparator
-
search
@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) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the companyclassNameIds
- the primary keys of the class names of the entities the groups are related to (optionallynull
)parentGroupId
- the primary key of the parent groupname
- the group's name (optionallynull
)description
- the group's description (optionallynull
)params
- the finder params (optionallynull
). 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 seeGroupFinder
.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)- Returns:
- the matching groups ordered by name
-
search
@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> orderByComparator) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the companyclassNameIds
- the primary keys of the class names of the entities the groups are related to (optionallynull
)parentGroupId
- the primary key of the parent groupname
- the group's name (optionallynull
)description
- the group's description (optionallynull
)params
- the finder params (optionallynull
). 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 seeGroupFinder
.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)orderByComparator
- the comparator to order the groups (optionallynull
)- Returns:
- the matching groups ordered by comparator
orderByComparator
-
search
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> search(long companyId, long[] classNameIds, String keywords, LinkedHashMap<String, Object> params, int start, int end) Returns an ordered range of all the groups that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the companyclassNameIds
- the primary keys of the class names of the entities the groups are related to (optionallynull
)keywords
- the keywords (space separated), which may occur in the sites's name, or description (optionallynull
)params
- the finder params (optionallynull
). 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 seeGroupFinder
.start
- the lower bound of the range of groups to returnend
- 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) List<Group> search(long companyId, long[] classNameIds, String keywords, LinkedHashMap<String, Object> params, int start, int end, OrderByComparator<Group> orderByComparator) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the companyclassNameIds
- the primary keys of the class names of the entities the groups are related to (optionallynull
)keywords
- the keywords (space separated), which may occur in the sites's name, or description (optionallynull
)params
- the finder params (optionallynull
). 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 seeGroupFinder
.start
- the lower bound of the range of groups to returnend
- the upper bound of the range of groups to return (not inclusive)orderByComparator
- the comparator to order the groups (optionallynull
)- Returns:
- the matching groups ordered by comparator
orderByComparator
-
search
@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) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the companyclassNameIds
- the primary keys of the class names of the entities the groups are related to (optionallynull
)name
- the group's name (optionallynull
)description
- the group's description (optionallynull
)params
- the finder params (optionallynull
). 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 seeGroupFinder
.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)- Returns:
- the matching groups ordered by name
-
search
@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> orderByComparator) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the companyclassNameIds
- the primary keys of the class names of the entities the groups are related to (optionallynull
)name
- the group's name (optionallynull
)description
- the group's description (optionallynull
)params
- the finder params (optionallynull
). 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 seeGroupFinder
.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)orderByComparator
- the comparator to order the groups (optionallynull
)- Returns:
- the matching groups ordered by comparator
orderByComparator
-
search
@ThreadLocalCachable @Transactional(propagation=SUPPORTS, readOnly=true) List<Group> search(long companyId, String keywords, LinkedHashMap<String, Object> params, int start, int end) Returns an ordered range of all the groups that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the companykeywords
- the keywords (space separated), which may occur in the sites's name, or description (optionallynull
)params
- the finder params (optionallynull
). 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 seeGroupFinder
.start
- the lower bound of the range of groups to returnend
- 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) List<Group> search(long companyId, String keywords, LinkedHashMap<String, Object> params, int start, int end, OrderByComparator<Group> orderByComparator) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the companykeywords
- the keywords (space separated), which may occur in the sites's name, or description (optionallynull
)params
- the finder params (optionallynull
). 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 seeGroupFinder
.start
- the lower bound of the range of groups to returnend
- the upper bound of the range of groups to return (not inclusive)orderByComparator
- the comparator to order the groups (optionallynull
)- Returns:
- the matching groups ordered by comparator
orderByComparator
-
search
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> search(long companyId, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator, int start, int end) Returns an ordered range of all the site groups and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the companyname
- the group's name (optionallynull
)description
- the group's description (optionallynull
)params
- the finder params (optionallynull
). 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 seeGroupFinder
.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)- Returns:
- the matching groups ordered by name
-
search
@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> orderByComparator) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the companyname
- the group's name (optionallynull
)description
- the group's description (optionallynull
)params
- the finder params (optionallynull
). 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 seeGroupFinder
.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)orderByComparator
- the comparator to order the groups (optionallynull
)- Returns:
- the matching groups ordered by comparator
orderByComparator
-
searchCount
@ThreadLocalCachable @Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, long parentGroupId, String keywords, LinkedHashMap<String, Object> params) Returns the number of groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.- Parameters:
companyId
- the primary key of the companyparentGroupId
- the primary key of the parent groupkeywords
- the keywords (space separated), which may occur in the sites's name, or description (optionallynull
)params
- the finder params (optionallynull
). 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 seeGroupFinder
.- Returns:
- the number of matching groups
-
searchCount
@ThreadLocalCachable @Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, long parentGroupId, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator) Returns the number of groups belonging to the parent group and immediate organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.- Parameters:
companyId
- the primary key of the companyparentGroupId
- the primary key of the parent groupname
- the group's name (optionallynull
)description
- the group's description (optionallynull
)params
- the finder params (optionallynull
). 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 seeGroupFinder
.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, String keywords, LinkedHashMap<String, Object> params) Returns the number of groups belonging to the parent group that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.- Parameters:
companyId
- the primary key of the companyclassNameIds
- the primary keys of the class names of the entities the groups are related to (optionallynull
)parentGroupId
- the primary key of the parent groupkeywords
- the keywords (space separated), which may occur in the sites's name, or description (optionallynull
)params
- the finder params (optionallynull
). 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 seeGroupFinder
.- Returns:
- the number of matching groups
-
searchCount
@ThreadLocalCachable @Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, long[] classNameIds, long parentGroupId, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator) Returns the number of groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.- Parameters:
companyId
- the primary key of the companyclassNameIds
- the primary keys of the class names of the entities the groups are related to (optionallynull
)parentGroupId
- the primary key of the parent groupname
- the group's name (optionallynull
)description
- the group's description (optionallynull
)params
- the finder params (optionallynull
). 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 seeGroupFinder
.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, String keywords, LinkedHashMap<String, Object> params) Returns the number of groups that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.- Parameters:
companyId
- the primary key of the companyclassNameIds
- the primary keys of the class names of the entities the groups are related to (optionallynull
)keywords
- the keywords (space separated), which may occur in the sites's name, or description (optionallynull
)params
- the finder params (optionallynull
). 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 seeGroupFinder
.- Returns:
- the number of matching groups
-
searchCount
@ThreadLocalCachable @Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator) Returns the number of groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.- Parameters:
companyId
- the primary key of the companyclassNameIds
- the primary keys of the class names of the entities the groups are related to (optionallynull
)name
- the group's name (optionallynull
)description
- the group's description (optionallynull
)params
- the finder params (optionallynull
). 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 seeGroupFinder
.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, String keywords, LinkedHashMap<String, Object> params) Returns the number of groups that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.- Parameters:
companyId
- the primary key of the companykeywords
- the keywords (space separated), which may occur in the sites's name, or description (optionallynull
)params
- the finder params (optionallynull
). 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 seeGroupFinder
.- Returns:
- the number of matching groups
-
searchCount
@ThreadLocalCachable @Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator) Returns the number of groups and immediate organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.- Parameters:
companyId
- the primary key of the companyname
- the group's name (optionallynull
)description
- the group's description (optionallynull
)params
- the finder params (optionallynull
). 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 seeGroupFinder
.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 rolegroupIds
- 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 usergroupIds
- the primary keys of the groups
-
updateAsset
void updateAsset(long userId, Group group, long[] assetCategoryIds, String[] assetTagNames) throws PortalException Updates the group's asset replacing categories and tag names.- Parameters:
userId
- the primary key of the usergroup
- the groupassetCategoryIds
- the primary keys of the asset categories (optionallynull
)assetTagNames
- the asset tag names (optionallynull
)- Throws:
PortalException
- if a portal exception occurred
-
updateFriendlyURL
Updates the group's friendly URL.- Parameters:
groupId
- the primary key of the groupfriendlyURL
- the group's new friendlyURL (optionallynull
)- Returns:
- the group
- Throws:
PortalException
- if a portal exception occurred
-
updateGroup
Updates the group in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect GroupLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
group
- the group- Returns:
- the group that was updated
-
updateGroup
Group updateGroup(long groupId, long parentGroupId, Map<Locale, String> nameMap, Map<Locale, throws PortalExceptionString> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean inheritContent, boolean active, ServiceContext serviceContext) - Throws:
PortalException
-
updateGroup
Updates the group's type settings.- Parameters:
groupId
- the primary key of the grouptypeSettings
- the group's new type settings (optionallynull
)- Returns:
- the group
- Throws:
PortalException
- if a portal exception occurred
-
updateSite
Associates the group with a main site if the group is an organization.- Parameters:
groupId
- the primary key of the groupsite
- whether the group is to be associated with a main site- Returns:
- the group
- Throws:
PortalException
- if a portal exception occurred
-
validateRemote
void validateRemote(long groupId, String remoteAddress, int remotePort, String remotePathContext, boolean secureConnection, long remoteGroupId) throws PortalException - Throws:
PortalException
-
getCTPersistence
- Specified by:
getCTPersistence
in interfaceCTService<Group>
-
getModelClass
- Specified by:
getModelClass
in interfaceCTService<Group>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<Group>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceCTService<Group>
- Throws:
E extends Throwable
-