Class GroupLocalServiceUtil
com.liferay.portal.service.impl.GroupLocalServiceImpl
and
is an access point for service operations in application layer code running
on the local server. Methods of this service will not have security checks
based on the propagated JAAS credentials because this service can only be
accessed from within the same VM.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic Group
addGroup
(long userId, long parentGroupId, String className, long classPK, long liveGroupId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean site, boolean inheritContent, boolean active, ServiceContext serviceContext) static Group
addGroup
(long userId, long parentGroupId, String className, long classPK, long liveGroupId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean site, boolean active, ServiceContext serviceContext) static Group
Adds the group to the database.static boolean
addOrganizationGroup
(long organizationId, long groupId) static boolean
addOrganizationGroup
(long organizationId, Group group) static boolean
addOrganizationGroups
(long organizationId, long[] groupIds) static boolean
addOrganizationGroups
(long organizationId, List<Group> groups) static Group
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) static boolean
addRoleGroup
(long roleId, long groupId) static boolean
addRoleGroup
(long roleId, Group group) static boolean
addRoleGroups
(long roleId, long[] groupIds) static boolean
addRoleGroups
(long roleId, List<Group> groups) static boolean
addUserGroup
(long userId, long groupId) static boolean
addUserGroup
(long userId, Group group) static boolean
addUserGroupGroup
(long userGroupId, long groupId) static boolean
addUserGroupGroup
(long userGroupId, Group group) static boolean
addUserGroupGroups
(long userGroupId, long[] groupIds) static boolean
addUserGroupGroups
(long userGroupId, List<Group> groups) static boolean
addUserGroups
(long userId, long[] groupIds) static boolean
addUserGroups
(long userId, List<Group> groups) static void
checkCompanyGroup
(long companyId) Adds a company group if it does not exist.static Group
checkScopeGroup
(Layout layout, long userId) static void
checkSystemGroups
(long companyId) Creates systems groups and other related data needed by the system on the very first startup.static void
clearOrganizationGroups
(long organizationId) static void
clearRoleGroups
(long roleId) static void
clearUserGroupGroups
(long userGroupId) static void
clearUserGroups
(long userId) static Group
createGroup
(long groupId) Creates a new group with the primary key.static PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static Group
deleteGroup
(long groupId) Deletes the group with the primary key from the database.static Group
deleteGroup
(Group group) Deletes the group from the database.static void
deleteOrganizationGroup
(long organizationId, long groupId) static void
deleteOrganizationGroup
(long organizationId, Group group) static void
deleteOrganizationGroups
(long organizationId, long[] groupIds) static void
deleteOrganizationGroups
(long organizationId, List<Group> groups) static PersistedModel
deletePersistedModel
(PersistedModel persistedModel) static void
deleteRoleGroup
(long roleId, long groupId) static void
deleteRoleGroup
(long roleId, Group group) static void
deleteRoleGroups
(long roleId, long[] groupIds) static void
deleteRoleGroups
(long roleId, List<Group> groups) static void
deleteUserGroup
(long userId, long groupId) static void
deleteUserGroup
(long userId, Group group) static void
deleteUserGroupGroup
(long userGroupId, long groupId) static void
deleteUserGroupGroup
(long userGroupId, Group group) static void
deleteUserGroupGroups
(long userGroupId, long[] groupIds) static void
deleteUserGroupGroups
(long userGroupId, List<Group> groups) static void
deleteUserGroups
(long userId, long[] groupIds) static void
deleteUserGroups
(long userId, List<Group> groups) static void
disableStaging
(long groupId) static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static DynamicQuery
static <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.static <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.static long
dynamicQueryCount
(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static long
dynamicQueryCount
(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.static void
enableStaging
(long groupId) static Group
fetchCompanyGroup
(long companyId) Returns the company's group.static Group
fetchFriendlyURLGroup
(long companyId, String friendlyURL) Returns the group with the matching friendly URL.static Group
fetchGroup
(long groupId) static Group
fetchGroup
(long companyId, long classNameId, long classPK) static Group
fetchGroup
(long companyId, String groupKey) Returns the group with the matching group key by first searching the system groups and then using the finder cache.static Group
fetchGroupByExternalReferenceCode
(String externalReferenceCode, long companyId) static Group
fetchGroupByUuidAndCompanyId
(String uuid, long companyId) Returns the group with the matching UUID and company.static Group
fetchStagingGroup
(long liveGroupId) static Group
fetchUserGroup
(long companyId, long userId) static Group
fetchUserPersonalSiteGroup
(long companyId) Returns the default user's personal site group.static ActionableDynamicQuery
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.static int
getActiveGroupsCount
(long companyId, boolean active) Returns the number of active or inactive groups associated with the company.static int
getActiveGroupsCount
(long companyId, boolean active, boolean site) Returns the number of active or inactive groups associated with the company.static Group
getCompanyGroup
(long companyId) Returns the company group.getCompanyGroups
(long companyId, int start, int end) Returns a range of all the groups associated with the company.static int
getCompanyGroupsCount
(long companyId) Returns the number of groups associated with the company.static Group
getFriendlyURLGroup
(long companyId, String friendlyURL) Returns the group with the matching friendly URL.static Group
getGroup
(long groupId) Returns the group with the primary key.static Group
Returns the group with the matching group key.static Group
getGroupByExternalReferenceCode
(String externalReferenceCode, long companyId) static Group
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.static int
Returns the number of groups.static int
getGroupsCount
(long companyId, long parentGroupId, boolean site) Returns the number of groups that are direct children of the parent group.static int
getGroupsCount
(long companyId, long parentGroupId, String name, boolean site) static int
getGroupsCount
(long companyId, String className, long parentGroupId) Returns the number of groups that are direct children of the parent group with the matching className.static Group
getLayoutGroup
(long companyId, long plid) Returns the group associated with the layout.static Group
getLayoutPrototypeGroup
(long companyId, long layoutPrototypeId) Returns the group associated with the layout prototype.static Group
getLayoutSetPrototypeGroup
(long companyId, long layoutSetPrototypeId) Returns the group associated with the layout set prototype.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.static int
getLayoutsGroupsCount
(long companyId, long parentGroupId, boolean site) Returns the number of groups that are children or the parent group and that have at least one layoutstatic 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 layoutReturns all live groups.static Group
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) static int
getOrganizationGroupsCount
(long organizationId) static 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.static String
Returns the OSGi service identifier.getParentGroups
(long groupId) Returns the group followed by all its parent groups ordered by closest ancestor.static PersistedModel
getPersistedModel
(Serializable primaryKeyObj) getRoleGroups
(long roleId) getRoleGroups
(long roleId, int start, int end) getRoleGroups
(long roleId, int start, int end, OrderByComparator<Group> orderByComparator) static int
getRoleGroupsCount
(long roleId) static long[]
getRolePrimaryKeys
(long groupId) Returns the roleIds of the roles associated with the group.static GroupLocalService
static Group
getStagingGroup
(long liveGroupId) Returns the staging group.static Group
getUserGroup
(long companyId, long userId) Returns the group directly associated with the user.static Group
getUserGroupGroup
(long companyId, long userGroupId) Returns the specified "user group" group.getUserGroupGroups
(long userGroupId) getUserGroupGroups
(long userGroupId, int start, int end) getUserGroupGroups
(long userGroupId, int start, int end, OrderByComparator<Group> orderByComparator) static int
getUserGroupGroupsCount
(long userGroupId) static long[]
getUserGroupPrimaryKeys
(long groupId) Returns the userGroupIds of the user groups associated with the group.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) static 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
.static Group
getUserPersonalSiteGroup
(long companyId) Returns the default user's personal site group.static long[]
getUserPrimaryKeys
(long groupId) Returns the userIds of the users associated with the group.getUserSitesGroups
(long userId) getUserSitesGroups
(long userId, boolean includeAdministrative) getUserSitesGroups
(long userId, int start, int end) static boolean
hasOrganizationGroup
(long organizationId, long groupId) static boolean
hasOrganizationGroups
(long organizationId) static boolean
hasRoleGroup
(long roleId, long groupId) static boolean
hasRoleGroups
(long roleId) static boolean
hasStagingGroup
(long liveGroupId) Returnstrue
if the live group has a staging group.static boolean
hasUserGroup
(long userId, long groupId) static 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.static boolean
hasUserGroupGroup
(long userGroupId, long groupId) static boolean
hasUserGroupGroups
(long userGroupId) static boolean
hasUserGroups
(long userId) static boolean
isLiveGroupActive
(Group group) static Group
loadFetchGroup
(long companyId, String groupKey) Returns the group with the matching group key by first searching the system groups and then using the finder cache.static Group
loadGetGroup
(long companyId, String groupKey) Returns the group with the matching group key.static void
rebuildTree
(long companyId) Rebuilds the group tree.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.static int
searchCount
(long companyId, long[] classNameIds, long parentGroupId, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator) Returns the number of groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.static int
searchCount
(long companyId, long[] classNameIds, long parentGroupId, String keywords, LinkedHashMap<String, Object> params) Returns the number of groups belonging to the parent group that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups.static int
searchCount
(long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator) Returns the number of groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.static int
searchCount
(long companyId, long[] classNameIds, String keywords, LinkedHashMap<String, Object> params) Returns the number of groups that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups.static int
searchCount
(long companyId, long parentGroupId, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator) Returns the number of groups belonging to the parent group and immediate organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.static int
searchCount
(long companyId, long parentGroupId, String keywords, LinkedHashMap<String, Object> params) Returns the number of groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups.static int
searchCount
(long companyId, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator) Returns the number of groups and immediate organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.static int
searchCount
(long companyId, String keywords, LinkedHashMap<String, Object> params) Returns the number of groups that match the keywords, optionally including the user's inherited organization groups and user groups.static void
setOrganizationGroups
(long organizationId, long[] groupIds) static void
setRoleGroups
(long roleId, long[] groupIds) static void
setService
(GroupLocalService service) static void
setUserGroupGroups
(long userGroupId, long[] groupIds) static void
setUserGroups
(long userId, long[] groupIds) static void
unsetRoleGroups
(long roleId, long[] groupIds) Removes the groups from the role.static void
unsetUserGroups
(long userId, long[] groupIds) Removes the user from the groups.static void
updateAsset
(long userId, Group group, long[] assetCategoryIds, String[] assetTagNames) Updates the group's asset replacing categories and tag names.static Group
updateFriendlyURL
(long groupId, String friendlyURL) Updates the group's friendly URL.static Group
updateGroup
(long groupId, long parentGroupId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean inheritContent, boolean active, ServiceContext serviceContext) static Group
updateGroup
(long groupId, String typeSettings) Updates the group's type settings.static Group
updateGroup
(Group group) Updates the group in the database or adds it if it does not yet exist.static Group
updateSite
(long groupId, boolean site) Associates the group with a main site if the group is an organization.static void
validateRemote
(long groupId, String remoteAddress, int remotePort, String remotePathContext, boolean secureConnection, long remoteGroupId)
-
Constructor Details
-
GroupLocalServiceUtil
public GroupLocalServiceUtil()
-
-
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
public static 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
public static 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
public static boolean addOrganizationGroup(long organizationId, long groupId) -
addOrganizationGroups
-
addOrganizationGroups
public static boolean addOrganizationGroups(long organizationId, long[] groupIds) -
addOrUpdateGroup
public static 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
public static boolean addRoleGroup(long roleId, long groupId) -
addRoleGroups
-
addRoleGroups
public static boolean addRoleGroups(long roleId, long[] groupIds) -
addUserGroup
-
addUserGroup
public static boolean addUserGroup(long userId, long groupId) -
addUserGroupGroup
-
addUserGroupGroup
public static boolean addUserGroupGroup(long userGroupId, long groupId) -
addUserGroupGroups
-
addUserGroupGroups
public static boolean addUserGroupGroups(long userGroupId, long[] groupIds) -
addUserGroups
-
addUserGroups
public static boolean addUserGroups(long userId, long[] groupIds) -
checkCompanyGroup
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
Creates systems groups and other related data needed by the system on the very first startup. Also takes care of creating the Control Panel groups and layouts.- Parameters:
companyId
- the primary key of the company- Throws:
PortalException
- if a portal exception occurred
-
clearOrganizationGroups
public static void clearOrganizationGroups(long organizationId) -
clearRoleGroups
public static void clearRoleGroups(long roleId) -
clearUserGroupGroups
public static void clearUserGroupGroups(long userGroupId) -
clearUserGroups
public static void clearUserGroups(long userId) -
createGroup
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
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - 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
public static void deleteOrganizationGroup(long organizationId, long groupId) -
deleteOrganizationGroups
-
deleteOrganizationGroups
public static void deleteOrganizationGroups(long organizationId, long[] groupIds) -
deletePersistedModel
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - Throws:
PortalException
-
deleteRoleGroup
-
deleteRoleGroup
public static void deleteRoleGroup(long roleId, long groupId) -
deleteRoleGroups
-
deleteRoleGroups
public static void deleteRoleGroups(long roleId, long[] groupIds) -
deleteUserGroup
-
deleteUserGroup
public static void deleteUserGroup(long userId, long groupId) -
deleteUserGroupGroup
-
deleteUserGroupGroup
public static void deleteUserGroupGroup(long userGroupId, long groupId) -
deleteUserGroupGroups
-
deleteUserGroupGroups
public static void deleteUserGroupGroups(long userGroupId, long[] groupIds) -
deleteUserGroups
-
deleteUserGroups
public static void deleteUserGroups(long userId, long[] groupIds) -
disableStaging
- Throws:
PortalException
-
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
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
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.Useful when paginating results. Returns a maximum of
end - start
instances.start
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
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
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
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
-
fetchGroup
-
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
-
fetchGroupByUuidAndCompanyId
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
-
fetchUserPersonalSiteGroup
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
-
getActiveGroupIds
-
getActiveGroups
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
public static 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
public static 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
public static int getActiveGroupsCount(long companyId, boolean active) Returns the number of active or inactive groups associated with the company.- Parameters:
companyId
- the primary key of the companyactive
- whether to count only active groups or only inactive groups- Returns:
- the number of active or inactive groups
-
getActiveGroupsCount
public static int getActiveGroupsCount(long companyId, boolean active, boolean site) Returns the number of active or inactive groups associated with the company.- Parameters:
companyId
- the primary key of the 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
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
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
public static int getCompanyGroupsCount(long companyId) Returns the number of groups associated with the company.- Parameters:
companyId
- the primary key of the company- Returns:
- the number of groups associated with the company
-
getFriendlyURLGroup
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
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
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
public static Group getGroupByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Throws:
PortalException
-
getGroupByUuidAndCompanyId
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
-
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
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
-
getGroups
-
getGroups
-
getGroups
-
getGroups
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
public static List<Group> getGroups(long companyId, String className, long parentGroupId, int start, int end) Returns a range of all the groups that are direct children of the parent group with the matching className.- Parameters:
companyId
- the primary key of the 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
Returns the groups with the matching primary keys.- Parameters:
groupIds
- the primary keys of the groups- Returns:
- the groups with the primary keys
- Throws:
PortalException
- if a portal exception occurred
-
getGroupsCount
public static int getGroupsCount()Returns the number of groups.- Returns:
- the number of groups
-
getGroupsCount
public static int getGroupsCount(long companyId, long parentGroupId, boolean site) Returns the number of groups that are direct children of the parent group.- Parameters:
companyId
- the primary key of the 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
-
getGroupsCount
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
-
getLayoutGroup
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
public static Group getLayoutPrototypeGroup(long companyId, long layoutPrototypeId) throws PortalException Returns the group associated with the layout prototype.- Parameters:
companyId
- the primary key of the companylayoutPrototypeId
- the primary key of the layout prototype- Returns:
- the group associated with the layout prototype
- Throws:
PortalException
- if a portal exception occurred
-
getLayoutSetPrototypeGroup
public static Group getLayoutSetPrototypeGroup(long companyId, long layoutSetPrototypeId) throws PortalException Returns the group associated with the layout set prototype.- Parameters:
companyId
- the primary key of the 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
public static 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
public static 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
public static int getLayoutsGroupsCount(long companyId, long parentGroupId, boolean site) Returns the number of groups that are children or the parent group and that have at least one layout- Parameters:
companyId
- the primary key of the 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
public static int getLayoutsGroupsCount(long companyId, long parentGroupId, boolean site, boolean active) Returns the number of groups that are children or the parent group and that have at least one layout- Parameters:
companyId
- the primary key of the 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
public static 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
-
getOrganizationGroups
-
getOrganizationGroups
public static List<Group> getOrganizationGroups(long organizationId, int start, int end, OrderByComparator<Group> orderByComparator) -
getOrganizationGroupsCount
public static int getOrganizationGroupsCount(long organizationId) -
getOrganizationPrimaryKeys
public static long[] getOrganizationPrimaryKeys(long groupId) Returns the organizationIds of the organizations associated with the group.- Parameters:
groupId
- the groupId of the group- Returns:
- long[] the organizationIds of organizations associated with the group
-
getOrganizationsGroups
Returns the specified organization groups.- Parameters:
organizations
- the organizations- Returns:
- the groups associated with the organizations
-
getOrganizationsRelatedGroups
Returns all the groups related to the organizations.- Parameters:
organizations
- the organizations- Returns:
- the groups related to the organizations
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getParentGroups
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
- Throws:
PortalException
-
getRoleGroups
-
getRoleGroups
-
getRoleGroups
public static List<Group> getRoleGroups(long roleId, int start, int end, OrderByComparator<Group> orderByComparator) -
getRoleGroupsCount
public static int getRoleGroupsCount(long roleId) -
getRolePrimaryKeys
public static long[] getRolePrimaryKeys(long groupId) Returns the roleIds of the roles associated with the group.- Parameters:
groupId
- the groupId of the group- Returns:
- long[] the roleIds of roles associated with the group
-
getStagedSites
-
getStagingGroup
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
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
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
-
getUserGroupGroups
-
getUserGroupGroups
public static List<Group> getUserGroupGroups(long userGroupId, int start, int end, OrderByComparator<Group> orderByComparator) -
getUserGroupGroupsCount
public static int getUserGroupGroupsCount(long userGroupId) -
getUserGroupPrimaryKeys
public static long[] getUserGroupPrimaryKeys(long groupId) Returns the userGroupIds of the user groups associated with the group.- Parameters:
groupId
- the groupId of the group- Returns:
- long[] the userGroupIds of user groups associated with the group
-
getUserGroups
-
getUserGroups
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
public static List<Group> getUserGroups(long userId, boolean inherit, int start, int end) throws PortalException Returns an ordered range of all the user's site groups and immediate organization groups, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.Useful when paginating results. Returns a maximum of
end - start
instances.start
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
-
getUserGroups
public static List<Group> getUserGroups(long userId, int start, int end, OrderByComparator<Group> orderByComparator) throws PortalException - Throws:
PortalException
-
getUserGroupsCount
public static int getUserGroupsCount(long userId) -
getUserGroupsGroups
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
Returns all the groups related to the user groups.- Parameters:
userGroups
- the user groups- Returns:
- the groups related to the user groups
-
getUserOrganizationsGroups
public static List<Group> getUserOrganizationsGroups(long userId, int start, int end) throws PortalException Returns the range of all groups associated with the user's organization groups, including the ancestors of the organization groups, unless portal 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
Returns the default user's personal site group.- Parameters:
companyId
- the primary key of the company- Returns:
- the default user's personal site group
- Throws:
PortalException
- if a portal exception occurred
-
getUserPrimaryKeys
public static long[] getUserPrimaryKeys(long groupId) Returns the userIds of the users associated with the group.- Parameters:
groupId
- the groupId of the group- Returns:
- long[] the userIds of users associated with the group
-
getUserSitesGroups
- Throws:
PortalException
-
getUserSitesGroups
public static List<Group> getUserSitesGroups(long userId, boolean includeAdministrative) throws PortalException - Throws:
PortalException
-
getUserSitesGroups
public static List<Group> getUserSitesGroups(long userId, int start, int end) throws PortalException - Throws:
PortalException
-
hasOrganizationGroup
public static boolean hasOrganizationGroup(long organizationId, long groupId) -
hasOrganizationGroups
public static boolean hasOrganizationGroups(long organizationId) -
hasRoleGroup
public static boolean hasRoleGroup(long roleId, long groupId) -
hasRoleGroups
public static boolean hasRoleGroups(long roleId) -
hasStagingGroup
public static boolean hasStagingGroup(long liveGroupId) 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
public static boolean hasUserGroup(long userId, long groupId) -
hasUserGroup
public static 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
public static boolean hasUserGroupGroup(long userGroupId, long groupId) -
hasUserGroupGroups
public static boolean hasUserGroupGroups(long userGroupId) -
hasUserGroups
public static boolean hasUserGroups(long userId) -
isLiveGroupActive
-
loadFetchGroup
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
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
public static List<Group> search(long companyId, LinkedHashMap<String, Object> params, int start, int end) Returns an ordered range of all the company's groups, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.Useful when paginating results. Returns a maximum of
end - start
instances.start
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
public static List<Group> search(long companyId, long parentGroupId, String keywords, LinkedHashMap<String, Object> params, int start, int end) Returns an ordered range of all the groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.Useful when paginating results. Returns a maximum of
end - start
instances.start
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
public static 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
public static List<Group> search(long companyId, long parentGroupId, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator, int start, int end) Returns an ordered range of all the site groups belonging to the parent group and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.Useful when paginating results. Returns a maximum of
end - start
instances.start
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
public static List<Group> search(long companyId, long parentGroupId, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> 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
public static List<Group> search(long companyId, long[] classNameIds, long parentGroupId, String keywords, LinkedHashMap<String, Object> params, int start, int end) Returns an ordered range of all the groups belonging to the parent group that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.Useful when paginating results. Returns a maximum of
end - start
instances.start
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
public static 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
public static List<Group> search(long companyId, long[] classNameIds, long parentGroupId, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator, int start, int end) Returns an ordered range of all the groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.Useful when paginating results. Returns a maximum of
end - start
instances.start
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
public static List<Group> search(long companyId, long[] classNameIds, long parentGroupId, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> 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
public static List<Group> search(long companyId, long[] classNameIds, String keywords, LinkedHashMap<String, Object> params, int start, int end) Returns an ordered range of all the groups that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.Useful when paginating results. Returns a maximum of
end - start
instances.start
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
public static 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
public static List<Group> search(long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator, int start, int end) Returns an ordered range of all the groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.Useful when paginating results. Returns a maximum of
end - start
instances.start
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
public static List<Group> search(long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> 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
public static List<Group> search(long companyId, String keywords, LinkedHashMap<String, Object> params, int start, int end) Returns an ordered range of all the groups that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.Useful when paginating results. Returns a maximum of
end - start
instances.start
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
public static 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
public static List<Group> search(long companyId, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator, int start, int end) Returns an ordered range of all the site groups and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.Useful when paginating results. Returns a maximum of
end - start
instances.start
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
public static 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
public static int searchCount(long companyId, long parentGroupId, String keywords, LinkedHashMap<String, Object> params) Returns the number of groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.- Parameters:
companyId
- the primary key of the 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
public static int searchCount(long companyId, long parentGroupId, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator) Returns the number of groups belonging to the parent group and immediate organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.- Parameters:
companyId
- the primary key of the 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
public static int searchCount(long companyId, long[] classNameIds, long parentGroupId, String keywords, LinkedHashMap<String, Object> params) Returns the number of groups belonging to the parent group that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.- Parameters:
companyId
- the primary key of the 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
public static int searchCount(long companyId, long[] classNameIds, long parentGroupId, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator) Returns the number of groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.- Parameters:
companyId
- the primary key of the 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
public static int searchCount(long companyId, long[] classNameIds, String keywords, LinkedHashMap<String, Object> params) Returns the number of groups that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.- Parameters:
companyId
- the primary key of the 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
public static int searchCount(long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator) Returns the number of groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.- Parameters:
companyId
- the primary key of the 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
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
public static int searchCount(long companyId, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator) Returns the number of groups and immediate organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.- Parameters:
companyId
- the primary key of the 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
public static void setOrganizationGroups(long organizationId, long[] groupIds) -
setRoleGroups
public static void setRoleGroups(long roleId, long[] groupIds) -
setUserGroupGroups
public static void setUserGroupGroups(long userGroupId, long[] groupIds) -
setUserGroups
public static void setUserGroups(long userId, long[] groupIds) -
unsetRoleGroups
public static void unsetRoleGroups(long roleId, long[] groupIds) Removes the groups from the role.- Parameters:
roleId
- the primary key of the rolegroupIds
- the primary keys of the groups
-
unsetUserGroups
public static void unsetUserGroups(long userId, long[] groupIds) Removes the user from the groups.- Parameters:
userId
- the primary key of the usergroupIds
- the primary keys of the groups
-
updateAsset
public static void updateAsset(long userId, Group group, long[] assetCategoryIds, String[] assetTagNames) throws PortalException Updates the group's asset replacing categories and tag names.- Parameters:
userId
- the primary key of the 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
public static 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
public static void validateRemote(long groupId, String remoteAddress, int remotePort, String remotePathContext, boolean secureConnection, long remoteGroupId) throws PortalException - Throws:
PortalException
-
getService
-
setService
-