com.liferay.portal.service

Class GroupServiceWrapper

java.lang.Object

com.liferay.portal.service.GroupServiceWrapper

All Implemented Interfaces:

BaseService, GroupService, ServiceWrapper<GroupService>

@ProviderType
public class GroupServiceWrapper
extends java.lang.Object
implements GroupService, ServiceWrapper<GroupService>

Provides a wrapper for GroupService.

Author:

Brian Wing Shun Chan

See Also:

GroupService

Generated:

Constructor Summary

Constructors

Constructor and Description
GroupServiceWrapper(GroupService groupService)

Method Summary

Methods

Modifier and Type	Method and Description
Group	addGroup(long parentGroupId, long liveGroupId, java.lang.String name, java.lang.String description, int type, boolean manualMembership, int membershipRestriction, java.lang.String friendlyURL, boolean site, boolean active, ServiceContext serviceContext) Adds a group.
Group	addGroup(long parentGroupId, java.lang.String name, java.lang.String description, int type, java.lang.String friendlyURL, boolean site, boolean active, ServiceContext serviceContext) Deprecated. As of 6.2.0, replaced by addGroup(long, long, String, String, int, boolean, int, String, boolean, boolean, ServiceContext)
Group	addGroup(java.lang.String name, java.lang.String description, int type, java.lang.String friendlyURL, boolean site, boolean active, ServiceContext serviceContext) Deprecated. As of 6.2.0, replaced by addGroup(long, String, String, int, String, boolean, boolean, 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)
java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
Group	getCompanyGroup(long companyId) Returns the company group.
Group	getGroup(long groupId) Returns the group with the primary key.
Group	getGroup(long companyId, java.lang.String name) Returns the group with the name.
java.util.List<Group>	getGroups(long companyId, long parentGroupId, boolean site) Returns all the groups that are direct children of the parent group.
java.util.List<Group>	getManageableSiteGroups(java.util.Collection<Portlet> portlets, int max) Returns a range of all the site groups for which the user has control panel access.
java.util.List<Group>	getManageableSites(java.util.Collection<Portlet> portlets, int max) Deprecated. As of 6.2.0, replaced by getManageableSiteGroups(Collection, int)
java.util.List<Group>	getOrganizationsGroups(java.util.List<Organization> organizations) Returns the groups associated with the organizations.
Group	getUserGroup(long companyId, long userId) Returns the group associated with the user.
java.util.List<Group>	getUserGroupsGroups(java.util.List<UserGroup> userGroups) Returns the groups associated with the user groups.
java.util.List<Group>	getUserOrganizationsGroups(long userId, int start, int end) Returns the range of all groups associated with the user's organization groups, including the ancestors of the organization groups, unless portal property organizations.membership.strict is set to true.
java.util.List<Group>	getUserPlaces(long userId, java.lang.String[] classNames, boolean includeControlPanel, int max) Deprecated. As of 6.2.0, replaced by getUserSitesGroups(long, String[], boolean, int)
java.util.List<Group>	getUserPlaces(long userId, java.lang.String[] classNames, int max) Deprecated. As of 6.2.0, replaced by getUserSitesGroups(long, String[], int)
java.util.List<Group>	getUserPlaces(java.lang.String[] classNames, int max) Deprecated. As of 6.2.0, replaced by getUserSitesGroups( String[], int)
int	getUserPlacesCount() Deprecated. As of 6.2.0, replaced by getUserSitesGroupsCount()
java.util.List<Group>	getUserSites() Deprecated. As of 6.2.0, replaced by getUserSitesGroups()
java.util.List<Group>	getUserSitesGroups()
java.util.List<Group>	getUserSitesGroups(long userId, java.lang.String[] classNames, boolean includeControlPanel, int max)
java.util.List<Group>	getUserSitesGroups(long userId, java.lang.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.
java.util.List<Group>	getUserSitesGroups(java.lang.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	getUserSitesGroupsCount() 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.
GroupService	getWrappedGroupService() Deprecated. As of 6.1.0, replaced by getWrappedService()
GroupService	getWrappedService()
boolean	hasUserGroup(long userId, long groupId) Returns true if the user is associated with the group, including the user's inherited organizations and user groups.
java.util.List<Group>	search(long companyId, long[] classNameIds, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, OrderByComparator obc)
java.util.List<Group>	search(long companyId, long[] classNameIds, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator, int start, int end, OrderByComparator obc)
java.util.List<Group>	search(long companyId, java.lang.String name, java.lang.String description, java.lang.String[] params, 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.
int	searchCount(long companyId, java.lang.String name, java.lang.String description, java.lang.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	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
void	setRoleGroups(long roleId, long[] groupIds) Sets the groups associated with the role, removing and adding associations as necessary.
void	setWrappedGroupService(GroupService groupService) Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portal.service.GroupService)
void	setWrappedService(GroupService groupService)
void	unsetRoleGroups(long roleId, long[] groupIds) Removes the groups from the role.
Group	updateFriendlyURL(long groupId, java.lang.String friendlyURL) Updates the group's friendly URL.
Group	updateGroup(long groupId, long parentGroupId, java.lang.String name, java.lang.String description, int type, boolean manualMembership, int membershipRestriction, java.lang.String friendlyURL, boolean active, ServiceContext serviceContext) Updates the group.
Group	updateGroup(long groupId, java.lang.String typeSettings) Updates the group's type settings.
void	updateStagedPortlets(long groupId, java.util.Map<java.lang.String,java.lang.String> stagedPortletIds)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GroupServiceWrapper

public GroupServiceWrapper(GroupService groupService)

Method Detail

getBeanIdentifier

public java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Specified by:

getBeanIdentifier in interface GroupService

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Specified by:

setBeanIdentifier in interface GroupService

Parameters:

beanIdentifier - the Spring bean ID for this bean

addGroup

public Group addGroup(long parentGroupId,
             long liveGroupId,
             java.lang.String name,
             java.lang.String description,
             int type,
             boolean manualMembership,
             int membershipRestriction,
             java.lang.String friendlyURL,
             boolean site,
             boolean active,
             ServiceContext serviceContext)
               throws PortalException,
                      SystemException

Adds a group.

Specified by:

addGroup in interface GroupService

Parameters:

parentGroupId - the primary key of the parent group

liveGroupId - the primary key of the live group

name - the entity's name

description - the group's description (optionally null)

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

friendlyURL - the group's friendlyURL (optionally null)

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

active - whether the group is active

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

Returns:

the group

Throws:

PortalException - if the user did not have permission to add the group, if a creator could not be found, if the group's information was invalid, if a layout could not be found, or if a valid friendly URL could not be created for the group

SystemException - if a system exception occurred

addGroup

public Group addGroup(long parentGroupId,
             java.lang.String name,
             java.lang.String description,
             int type,
             java.lang.String friendlyURL,
             boolean site,
             boolean active,
             ServiceContext serviceContext)
               throws PortalException,
                      SystemException

Deprecated. As of 6.2.0, replaced by addGroup(long, long, String, String, int, boolean, int, String, boolean, boolean, ServiceContext)

Adds the group using the group default live group ID.

Specified by:

addGroup in interface GroupService

Parameters:

parentGroupId - the primary key of the parent group

name - the entity's name

description - the group's description (optionally null)

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

friendlyURL - the group's friendlyURL

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

active - whether the group is active

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

Returns:

the group

Throws:

PortalException - if the user did not have permission to add the group, if a creator could not be found, if the group's information was invalid, if a layout could not be found, or if a valid friendly URL could not be created for the group

SystemException - if a system exception occurred

addGroup

public Group addGroup(java.lang.String name,
             java.lang.String description,
             int type,
             java.lang.String friendlyURL,
             boolean site,
             boolean active,
             ServiceContext serviceContext)
               throws PortalException,
                      SystemException

Deprecated. As of 6.2.0, replaced by addGroup(long, String, String, int, String, boolean, boolean, ServiceContext)

Specified by:

addGroup in interface GroupService

Throws:

PortalException

SystemException

addRoleGroups

public void addRoleGroups(long roleId,
                 long[] groupIds)
                   throws PortalException,
                          SystemException

Adds the groups to the role.

Specified by:

addRoleGroups in interface GroupService

Parameters:

roleId - the primary key of the role

groupIds - the primary keys of the groups

Throws:

PortalException - if the user did not have permission to update the role

SystemException - if a system exception occurred

checkRemoteStagingGroup

public void checkRemoteStagingGroup(long groupId)
                             throws PortalException,
                                    SystemException

Checks that the current user is permitted to use the group for Remote Staging.

Specified by:

checkRemoteStagingGroup in interface GroupService

Parameters:

groupId - the primary key of the group

Throws:

PortalException - if a group with the primary key could not be found, if the current user did not have permission to view the group, or if the group's company was different from the current user's company

SystemException - if a system exception occurred

deleteGroup

public void deleteGroup(long groupId)
                 throws PortalException,
                        SystemException

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, shopping related entities, software catalog, and wikis are also deleted.

Specified by:

deleteGroup in interface GroupService

Parameters:

groupId - the primary key of the group

Throws:

PortalException - if the user did not have permission to delete the group or its assets or resources, if a group with the primary key could not be found, or if the group was a system group

SystemException - if a system exception occurred

disableStaging

public void disableStaging(long groupId)
                    throws PortalException,
                           SystemException

Specified by:

disableStaging in interface GroupService

Throws:

PortalException

SystemException

enableStaging

public void enableStaging(long groupId)
                   throws PortalException,
                          SystemException

Specified by:

enableStaging in interface GroupService

Throws:

PortalException

SystemException

getCompanyGroup

public Group getCompanyGroup(long companyId)
                      throws PortalException,
                             SystemException

Returns the company group.

Specified by:

getCompanyGroup in interface GroupService

Parameters:

companyId - the primary key of the company

Returns:

the group associated with the company

Throws:

PortalException - if a matching group could not be found

SystemException - if a system exception occurred

getGroup

public Group getGroup(long groupId)
               throws PortalException,
                      SystemException

Returns the group with the primary key.

Specified by:

getGroup in interface GroupService

Parameters:

groupId - the primary key of the group

Returns:

the group with the primary key

Throws:

PortalException - if a group with the primary key could not be found or if the current user did not have permission to view the group

SystemException - if a system exception occurred

getGroup

public Group getGroup(long companyId,
             java.lang.String name)
               throws PortalException,
                      SystemException

Returns the group with the name.

Specified by:

getGroup in interface GroupService

Parameters:

companyId - the primary key of the company

name - the group's name

Returns:

the group with the name

Throws:

PortalException - if a matching group could not be found or if the current user did not have permission to view the group

SystemException - if a system exception occurred

getGroups

public java.util.List<Group> getGroups(long companyId,
                              long parentGroupId,
                              boolean site)
                                throws PortalException,
                                       SystemException

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

Specified by:

getGroups in interface GroupService

Parameters:

companyId - the primary key of the company

parentGroupId - the primary key of the parent group

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

Returns:

the matching groups, or null if no matches were found

Throws:

PortalException - if the user did not have permission to view the group or if a portal exception occurred

SystemException - if a system exception occurred

getManageableSiteGroups

public java.util.List<Group> getManageableSiteGroups(java.util.Collection<Portlet> portlets,
                                            int max)
                                              throws PortalException,
                                                     SystemException

Returns a range of all the site groups for which the user has control panel access.

Specified by:

getManageableSiteGroups in interface GroupService

Parameters:

portlets - the portlets to manage

max - 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

SystemException - if a system exception occurred

getManageableSites

public java.util.List<Group> getManageableSites(java.util.Collection<Portlet> portlets,
                                       int max)
                                         throws PortalException,
                                                SystemException

Deprecated. As of 6.2.0, replaced by getManageableSiteGroups(Collection, int)

Returns a range of all the site groups for which the user has control panel access.

Specified by:

getManageableSites in interface GroupService

Parameters:

portlets - the portlets to manage

max - 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

SystemException - if a system exception occurred

getOrganizationsGroups

public java.util.List<Group> getOrganizationsGroups(java.util.List<Organization> organizations)
                                             throws PortalException,
                                                    SystemException

Returns the groups associated with the organizations.

Specified by:

getOrganizationsGroups in interface GroupService

Parameters:

organizations - the organizations

Returns:

the groups associated with the organizations

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

getUserGroup

public Group getUserGroup(long companyId,
                 long userId)
                   throws PortalException,
                          SystemException

Returns the group associated with the user.

Specified by:

getUserGroup in interface GroupService

Parameters:

companyId - the primary key of the company

userId - the primary key of the user

Returns:

the group associated with the user

Throws:

PortalException - if a matching group could not be found or if the current user did not have permission to view the group

SystemException - if a system exception occurred

getUserGroupsGroups

public java.util.List<Group> getUserGroupsGroups(java.util.List<UserGroup> userGroups)
                                          throws PortalException,
                                                 SystemException

Returns the groups associated with the user groups.

Specified by:

getUserGroupsGroups in interface GroupService

Parameters:

userGroups - the user groups

Returns:

the groups associated with the user groups

Throws:

PortalException - if any one of the user group's group could not be found

SystemException - if a system exception occurred

getUserOrganizationsGroups

public java.util.List<Group> getUserOrganizationsGroups(long userId,
                                               int start,
                                               int end)
                                                 throws PortalException,
                                                        SystemException

Returns the range of all groups associated with the user's organization groups, including the ancestors of the organization groups, unless portal property organizations.membership.strict is set to true.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Specified by:

getUserOrganizationsGroups in interface GroupService

Parameters:

userId - the primary key of the user

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

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

Returns:

the range of groups associated with the user's organizations

Throws:

PortalException - if a user with the primary key could not be found or if another portal exception occurred

SystemException - if a system exception occurred

getUserPlaces

public java.util.List<Group> getUserPlaces(long userId,
                                  java.lang.String[] classNames,
                                  boolean includeControlPanel,
                                  int max)
                                    throws PortalException,
                                           SystemException

Deprecated. As of 6.2.0, replaced by getUserSitesGroups(long, String[], boolean, int)

Specified by:

getUserPlaces in interface GroupService

Throws:

PortalException

SystemException

getUserPlaces

public java.util.List<Group> getUserPlaces(long userId,
                                  java.lang.String[] classNames,
                                  int max)
                                    throws PortalException,
                                           SystemException

Deprecated. As of 6.2.0, replaced by getUserSitesGroups(long, String[], int)

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 of null includes the user's layout set group, organization groups, inherited organization groups, and site groups.

Specified by:

getUserPlaces in interface GroupService

Parameters:

userId - the primary key of the user

classNames - the group entity class names (optionally null). For more information see getUserSitesGroups(long, String[], int)

max - the maximum number of groups to return

Returns:

the user's groups "sites"

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

getUserPlaces

public java.util.List<Group> getUserPlaces(java.lang.String[] classNames,
                                  int max)
                                    throws PortalException,
                                           SystemException

Deprecated. As of 6.2.0, replaced by getUserSitesGroups( String[], int)

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 of null includes the user's layout set group, organization groups, inherited organization groups, and site groups.

Specified by:

getUserPlaces in interface GroupService

Parameters:

classNames - the group entity class names (optionally null). For more information see getUserSitesGroups(String[], int)

max - the maximum number of groups to return

Returns:

the user's groups "sites"

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

getUserPlacesCount

public int getUserPlacesCount()
                       throws PortalException,
                              SystemException

Deprecated. As of 6.2.0, replaced by getUserSitesGroupsCount()

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.

Specified by:

getUserPlacesCount in interface GroupService

Returns:

the number of user's groups "sites"

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

getUserSites

public java.util.List<Group> getUserSites()
                                   throws PortalException,
                                          SystemException

Deprecated. As of 6.2.0, replaced by getUserSitesGroups()

Returns the guest or current user's layout set group, organization groups, inherited organization groups, and site groups.

Specified by:

getUserSites in interface GroupService

Returns:

the user's layout set group, organization groups, and inherited organization groups, and site groups

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

getUserSitesGroups

public java.util.List<Group> getUserSitesGroups()
                                         throws PortalException,
                                                SystemException

Specified by:

getUserSitesGroups in interface GroupService

Throws:

PortalException

SystemException

getUserSitesGroups

public java.util.List<Group> getUserSitesGroups(long userId,
                                       java.lang.String[] classNames,
                                       boolean includeControlPanel,
                                       int max)
                                         throws PortalException,
                                                SystemException

Specified by:

getUserSitesGroups in interface GroupService

Throws:

PortalException

SystemException

getUserSitesGroups

public java.util.List<Group> getUserSitesGroups(long userId,
                                       java.lang.String[] classNames,
                                       int max)
                                         throws PortalException,
                                                SystemException

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 of null includes the user's layout set group, organization groups, inherited organization groups, and site groups.

Specified by:

getUserSitesGroups in interface GroupService

Parameters:

userId - the primary key of the user

classNames - the group entity class names (optionally null). For more information see getUserSitesGroups(long, String[], boolean, int)

max - the maximum number of groups to return

Returns:

the user's groups "sites"

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

getUserSitesGroups

public java.util.List<Group> getUserSitesGroups(java.lang.String[] classNames,
                                       int max)
                                         throws PortalException,
                                                SystemException

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 of null includes the user's layout set group, organization groups, inherited organization groups, and site groups.

Specified by:

getUserSitesGroups in interface GroupService

Parameters:

classNames - the group entity class names (optionally null). For more information see getUserSitesGroups(long, String[], boolean, int)

max - the maximum number of groups to return

Returns:

the user's groups "sites"

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

getUserSitesGroupsCount

public int getUserSitesGroupsCount()
                            throws PortalException,
                                   SystemException

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.

Specified by:

getUserSitesGroupsCount in interface GroupService

Returns:

the number of user's groups "sites"

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

hasUserGroup

public boolean hasUserGroup(long userId,
                   long groupId)
                     throws PortalException,
                            SystemException

Returns true if the user is associated with the group, including the user's inherited organizations and user groups. System and staged groups are not included.

Specified by:

hasUserGroup in interface GroupService

Parameters:

userId - the primary key of the user

groupId - the primary key of the group

Returns:

true if the user is associated with the group; false otherwise

Throws:

PortalException - if the current user did not have permission to view the user or group members

SystemException - if a system exception occurred

search

public java.util.List<Group> search(long companyId,
                           long[] classNameIds,
                           java.lang.String keywords,
                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                           int start,
                           int end,
                           OrderByComparator obc)
                             throws PortalException,
                                    SystemException

Specified by:

search in interface GroupService

Throws:

PortalException

SystemException

search

public java.util.List<Group> search(long companyId,
                           long[] classNameIds,
                           java.lang.String name,
                           java.lang.String description,
                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                           boolean andOperator,
                           int start,
                           int end,
                           OrderByComparator obc)
                             throws PortalException,
                                    SystemException

Specified by:

search in interface GroupService

Throws:

PortalException

SystemException

search

public java.util.List<Group> search(long companyId,
                           java.lang.String name,
                           java.lang.String description,
                           java.lang.String[] params,
                           int start,
                           int end)
                             throws PortalException,
                                    SystemException

Returns an ordered range of all the site groups and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Specified by:

search in interface GroupService

Parameters:

companyId - the primary key of the company

name - the group's name (optionally null)

description - the group's description (optionally null)

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

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

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

Returns:

the matching groups ordered by name

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

searchCount

public int searchCount(long companyId,
              java.lang.String name,
              java.lang.String description,
              java.lang.String[] params)
                throws SystemException

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.

Specified by:

searchCount in interface GroupService

Parameters:

companyId - the primary key of the company

name - the group's name (optionally null)

description - the group's description (optionally null)

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

Returns:

the number of matching groups

Throws:

SystemException - if a system exception occurred

setRoleGroups

public void setRoleGroups(long roleId,
                 long[] groupIds)
                   throws PortalException,
                          SystemException

Sets the groups associated with the role, removing and adding associations as necessary.

Specified by:

setRoleGroups in interface GroupService

Parameters:

roleId - the primary key of the role

groupIds - the primary keys of the groups

Throws:

PortalException - if the user did not have permission to update update the role

SystemException - if a system exception occurred

unsetRoleGroups

public void unsetRoleGroups(long roleId,
                   long[] groupIds)
                     throws PortalException,
                            SystemException

Removes the groups from the role.

Specified by:

unsetRoleGroups in interface GroupService

Parameters:

roleId - the primary key of the role

groupIds - the primary keys of the groups

Throws:

PortalException - if the user did not have permission to update the role

SystemException - if a system exception occurred

updateFriendlyURL

public Group updateFriendlyURL(long groupId,
                      java.lang.String friendlyURL)
                        throws PortalException,
                               SystemException

Updates the group's friendly URL.

Specified by:

updateFriendlyURL in interface GroupService

Parameters:

groupId - the primary key of the group

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

Returns:

the group

Throws:

PortalException - if the user did not have permission to update the group, if a group with the primary key could not be found, or if a valid friendly URL could not be created for the group

SystemException - if a system exception occurred

updateGroup

public Group updateGroup(long groupId,
                long parentGroupId,
                java.lang.String name,
                java.lang.String description,
                int type,
                boolean manualMembership,
                int membershipRestriction,
                java.lang.String friendlyURL,
                boolean active,
                ServiceContext serviceContext)
                  throws PortalException,
                         SystemException

Updates the group.

Specified by:

updateGroup in interface GroupService

Parameters:

groupId - the primary key of the group

parentGroupId - the primary key of the parent group

name - the group's new name

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

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

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

active - whether the group is active

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

Returns:

the group

Throws:

PortalException - if the user did not have permission to update the group, if a group with the primary key could not be found, if the friendly URL was invalid or could one not be created

SystemException - if a system exception occurred

updateGroup

public Group updateGroup(long groupId,
                java.lang.String typeSettings)
                  throws PortalException,
                         SystemException

Updates the group's type settings.

Specified by:

updateGroup in interface GroupService

Parameters:

groupId - the primary key of the group

typeSettings - the group's new type settings (optionally null)

Returns:

the group

Throws:

PortalException - if the user did not have permission to update the group or if a group with the primary key could not be found

SystemException - if a system exception occurred

updateStagedPortlets

public void updateStagedPortlets(long groupId,
                        java.util.Map<java.lang.String,java.lang.String> stagedPortletIds)
                          throws PortalException,
                                 SystemException

Specified by:

updateStagedPortlets in interface GroupService

Throws:

PortalException

SystemException

getWrappedGroupService

public GroupService getWrappedGroupService()

Deprecated. As of 6.1.0, replaced by getWrappedService()

setWrappedGroupService

public void setWrappedGroupService(GroupService groupService)

Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portal.service.GroupService)

getWrappedService

public GroupService getWrappedService()

Specified by:

getWrappedService in interface ServiceWrapper<GroupService>

setWrappedService

public void setWrappedService(GroupService groupService)

Specified by:

setWrappedService in interface ServiceWrapper<GroupService>