Interface GroupService
- All Superinterfaces:
BaseService
- All Known Implementing Classes:
GroupServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddGroup
(long parentGroupId, 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 parentGroupId, long liveGroupId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean site, boolean active, ServiceContext serviceContext) addOrUpdateGroup
(String externalReferenceCode, long parentGroupId, 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) void
addRoleGroups
(long roleId, long[] groupIds) Adds the groups to the role.void
checkRemoteStagingGroup
(long groupId) Checks that the current user is permitted to use the group for Remote Staging.void
deleteGroup
(long groupId) Deletes the group.void
disableStaging
(long groupId) void
enableStaging
(long groupId) fetchGroupByExternalReferenceCode
(String externalReferenceCode, long companyId) getCompanyGroup
(long companyId) Returns the company group.getGroup
(long groupId) Returns the group with the primary key.Returns the group with the name.getGroupDisplayURL
(long groupId, boolean privateLayout, boolean secureConnection) Returns the group's display URL.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, int start, int end) Returns all the groups that are direct children of the parent group.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.getGtGroups
(long gtGroupId, long companyId, long parentGroupId, boolean site, int size) getManageableSiteGroups
(Collection<Portlet> portlets, int max) Returns a range of all the site groups for which the user has control panel access.getOrganizationsGroups
(List<Organization> organizations) Returns the groups associated with the organizations.Returns the OSGi service identifier.getUserGroup
(long companyId, long userId) Returns the group directly associated with the user.getUserGroupsGroups
(List<UserGroup> userGroups) Returns the groups associated with 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
.getUserSitesGroups
(long userId, int start, int end) getUserSitesGroups
(long userId, String[] classNames, int max) Returns the user's groups "sites" associated with the group entity class names, including the Control Panel group if the user is permitted to view the Control Panel.getUserSitesGroups
(String[] classNames, int max) Returns the guest or current user's groups "sites" associated with the group entity class names, including the Control Panel group if the user is permitted to view the Control Panel.int
Returns the number of the guest or current user's groups "sites" associated with the group entity class names, including the Control Panel group if the user is permitted to view the Control Panel.boolean
hasUserGroup
(long userId, long groupId) Returnstrue
if the user is associated with the group, including the user's inherited organizations 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) 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 site groups and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.int
searchCount
(long companyId, long[] classNameIds, String keywords, LinkedHashMap<String, Object> params) int
searchCount
(long companyId, String name, String description, String[] params) Returns the number of groups and organization groups that match the name and description, optionally including the user's inherited organizations and user groups.void
setRoleGroups
(long roleId, long[] groupIds) Sets the groups associated with the role, removing and adding associations as necessary.void
unsetRoleGroups
(long roleId, long[] groupIds) Removes the groups from the role.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.void
updateStagedPortlets
(long groupId, Map<String, String> stagedPortletIds)
-
Method Details
-
addGroup
Group addGroup(long parentGroupId, 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 parentGroupId, 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
-
addOrUpdateGroup
Group addOrUpdateGroup(String externalReferenceCode, long parentGroupId, 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
-
addRoleGroups
Adds the groups to the role.- Parameters:
roleId
- the primary key of the rolegroupIds
- the primary keys of the groups- Throws:
PortalException
- if a portal exception occurred
-
checkRemoteStagingGroup
Checks that the current user is permitted to use the group for Remote Staging.- Parameters:
groupId
- the primary key of the group- Throws:
PortalException
- if a portal exception occurred
-
deleteGroup
Deletes the group.The group is unstaged and its assets and resources including layouts, membership requests, subscriptions, teams, blogs, bookmarks, calendar events, image gallery, journals, message boards, polls, and wikis are also deleted.
- Parameters:
groupId
- the primary key of the group- Throws:
PortalException
- if a portal exception occurred
-
disableStaging
- Throws:
PortalException
-
enableStaging
- Throws:
PortalException
-
fetchGroupByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) Group fetchGroupByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Throws:
PortalException
-
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
-
getGroup
@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 with the primary key
- Throws:
PortalException
- if a portal exception occurred
-
getGroup
@Transactional(propagation=SUPPORTS, readOnly=true) Group getGroup(long companyId, String groupKey) throws PortalException Returns the group with the name.- 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
-
getGroupDisplayURL
@Transactional(propagation=SUPPORTS, readOnly=true) String getGroupDisplayURL(long groupId, boolean privateLayout, boolean secureConnection) throws PortalException Returns the group's display URL.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout set is private to the groupsecureConnection
- whether the generated URL uses a secure connection- Returns:
- the group's display URL
- Throws:
PortalException
- if a group with the primary key could not be found or if a portal exception occurred
-
getGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getGroups(long companyId, long parentGroupId, boolean site) throws PortalException 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 - Throws:
PortalException
- if a portal exception occurred
-
getGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getGroups(long companyId, long parentGroupId, boolean site, int start, int end) throws PortalException 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 sitestart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)- Returns:
- the matching groups, or
null
if no matches were found - Throws:
PortalException
- if a portal exception occurred
-
getGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getGroups(long companyId, long parentGroupId, String name, boolean site, int start, int end) throws PortalException - Throws:
PortalException
-
getGroupsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getGroupsCount(long companyId, long parentGroupId, boolean site) throws PortalException 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
- Throws:
PortalException
-
getGroupsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getGroupsCount(long companyId, long parentGroupId, String name, boolean site) throws PortalException - Throws:
PortalException
-
getGroupsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getGroupsCount(long companyId, String className, long parentGroupId) throws PortalException 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
- Throws:
PortalException
-
getGtGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getGtGroups(long gtGroupId, long companyId, long parentGroupId, boolean site, int size) throws PortalException - Throws:
PortalException
-
getManageableSiteGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getManageableSiteGroups(Collection<Portlet> portlets, int max) throws PortalException Returns a range of all the site groups for which the user has control panel access.- Parameters:
portlets
- the portlets to managemax
- the upper bound of the range of groups to consider (not inclusive)- Returns:
- the range of site groups for which the user has Control Panel access
- Throws:
PortalException
- if a portal exception occurred
-
getOrganizationsGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getOrganizationsGroups(List<Organization> organizations) throws PortalException Returns the groups associated with the organizations.- Parameters:
organizations
- the organizations- Returns:
- the groups associated with the organizations
- Throws:
PortalException
- if a portal exception occurred
-
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
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
-
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
-
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 organizations
- Throws:
PortalException
- if a portal exception occurred
-
getUserSitesGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserSitesGroups() throws PortalException- Throws:
PortalException
-
getUserSitesGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserSitesGroups(long userId, int start, int end) throws PortalException - Throws:
PortalException
-
getUserSitesGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserSitesGroups(long userId, String[] classNames, int max) throws PortalException Returns the user's groups "sites" associated with the group entity class names, including the Control Panel group if the user is permitted to view the Control Panel.- Class name "User" includes the user's layout set group.
- Class name "Organization" includes the user's immediate organization groups and inherited organization groups.
- Class name "Group" includes the user's immediate organization groups and site groups.
-
A
classNames
value ofnull
includes the user's layout set group, organization groups, inherited organization groups, and site groups.
- Parameters:
userId
- the primary key of the userclassNames
- the group entity class names (optionallynull
). For more information seegetUserSitesGroups(long, String[], int)
.max
- the maximum number of groups to return- Returns:
- the user's groups "sites"
- Throws:
PortalException
- if a portal exception occurred
-
getUserSitesGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserSitesGroups(String[] classNames, int max) throws PortalException Returns the guest or current user's groups "sites" associated with the group entity class names, including the Control Panel group if the user is permitted to view the Control Panel.- Class name "User" includes the user's layout set group.
- Class name "Organization" includes the user's immediate organization groups and inherited organization groups.
- Class name "Group" includes the user's immediate organization groups and site groups.
-
A
classNames
value ofnull
includes the user's layout set group, organization groups, inherited organization groups, and site groups.
- Parameters:
classNames
- the group entity class names (optionallynull
). For more information seegetUserSitesGroups(long, String[], int)
.max
- the maximum number of groups to return- Returns:
- the user's groups "sites"
- Throws:
PortalException
- if a portal exception occurred
-
getUserSitesGroupsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getUserSitesGroupsCount() throws PortalExceptionReturns the number of the guest or current user's groups "sites" associated with the group entity class names, including the Control Panel group if the user is permitted to view the Control Panel.- Returns:
- the number of user's groups "sites"
- Throws:
PortalException
- if a portal exception occurred
-
hasUserGroup
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasUserGroup(long userId, long groupId) throws PortalException Returnstrue
if the user is associated with the group, including the user's inherited organizations and user groups. System and staged groups are not included.- Parameters:
userId
- the primary key of the usergroupId
- the primary key of the group- Returns:
true
if the user is associated with the group;false
otherwise- Throws:
PortalException
- if a portal exception occurred
-
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) throws PortalException- Throws:
PortalException
-
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) throws PortalException- Throws:
PortalException
-
search
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> search(long companyId, String name, String description, String[] params, int start, int end) throws PortalException 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
.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
- Throws:
PortalException
- if a portal exception occurred
-
searchCount
@Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, long[] classNameIds, String keywords, LinkedHashMap<String, Object> params) -
searchCount
@Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, String name, String description, String[] params) Returns the number of groups and organization groups that match the name and description, optionally including the user's inherited organizations 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 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
.- Returns:
- the number of matching groups
-
setRoleGroups
Sets the groups associated with the role, removing and adding associations as necessary.- Parameters:
roleId
- the primary key of the rolegroupIds
- the primary keys of the groups- Throws:
PortalException
- if a portal exception occurred
-
unsetRoleGroups
Removes the groups from the role.- Parameters:
roleId
- the primary key of the rolegroupIds
- the primary keys of the groups- 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
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
-
updateStagedPortlets
- Throws:
PortalException
-