com.liferay.portal.service.impl

Class UserGroupServiceImpl

Object

com.liferay.portal.kernel.service.BaseServiceImpl

com.liferay.portal.service.base.UserGroupServiceBaseImpl

com.liferay.portal.service.impl.UserGroupServiceImpl

All Implemented Interfaces:

com.liferay.portal.kernel.module.framework.service.IdentifiableOSGiService, com.liferay.portal.kernel.service.BaseService, com.liferay.portal.kernel.service.UserGroupService

public class UserGroupServiceImpl
extends UserGroupServiceBaseImpl

Provides the remote service for accessing, adding, deleting, and updating user groups. Its methods include permission checks.

Author:

Charles May

Field Summary

Fields inherited from class com.liferay.portal.service.base.UserGroupServiceBaseImpl

counterLocalService, expandoRowLocalService, expandoRowPersistence, exportImportConfigurationFinder, exportImportConfigurationLocalService, exportImportConfigurationPersistence, exportImportConfigurationService, exportImportLocalService, exportImportService, groupFinder, groupLocalService, groupPersistence, groupService, layoutFinder, layoutLocalService, layoutPersistence, layoutService, resourceLocalService, teamFinder, teamLocalService, teamPersistence, teamService, userFinder, userGroupFinder, userGroupGroupRoleFinder, userGroupGroupRoleLocalService, userGroupGroupRolePersistence, userGroupGroupRoleService, userGroupLocalService, userGroupPersistence, userGroupService, userLocalService, userPersistence, userService

Fields inherited from class com.liferay.portal.kernel.service.BaseServiceImpl

ANONYMOUS_NAMES, JRUN_ANONYMOUS, ORACLE_ANONYMOUS, SUN_ANONYMOUS, WEBLOGIC_ANONYMOUS

Constructor Summary

Constructors

Constructor and Description
UserGroupServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	addGroupUserGroups(long groupId, long[] userGroupIds) Adds the user groups to the group.
void	addTeamUserGroups(long teamId, long[] userGroupIds) Adds the user groups to the team
com.liferay.portal.kernel.model.UserGroup	addUserGroup(String name, String description) Deprecated. As of Newton (6.2.x), replaced by addUserGroup(String, String, ServiceContext)
com.liferay.portal.kernel.model.UserGroup	addUserGroup(String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a user group.
void	deleteUserGroup(long userGroupId) Deletes the user group.
com.liferay.portal.kernel.model.UserGroup	fetchUserGroup(long userGroupId) Fetches the user group with the primary key.
protected List<com.liferay.portal.kernel.model.UserGroup>	filterUserGroups(List<com.liferay.portal.kernel.model.UserGroup> userGroups)
List<com.liferay.portal.kernel.model.UserGroup>	getGtUserGroups(long gtUserGroupId, long companyId, long parentUserGroupId, int size)
com.liferay.portal.kernel.model.UserGroup	getUserGroup(long userGroupId) Returns the user group with the primary key.
com.liferay.portal.kernel.model.UserGroup	getUserGroup(String name) Returns the user group with the name.
List<com.liferay.portal.kernel.model.UserGroup>	getUserGroups(long companyId)
List<com.liferay.portal.kernel.model.UserGroup>	getUserGroups(long companyId, String name, int start, int end)
int	getUserGroupsCount(long companyId, String name)
List<com.liferay.portal.kernel.model.UserGroup>	getUserUserGroups(long userId) Returns all the user groups to which the user belongs.
void	unsetGroupUserGroups(long groupId, long[] userGroupIds) Removes the user groups from the group.
void	unsetTeamUserGroups(long teamId, long[] userGroupIds) Removes the user groups from the team.
com.liferay.portal.kernel.model.UserGroup	updateUserGroup(long userGroupId, String name, String description) Deprecated. As of Newton (6.2.x), replaced by updateUserGroup(long, String, String, ServiceContext)
com.liferay.portal.kernel.model.UserGroup	updateUserGroup(long userGroupId, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the user group.

Methods inherited from class com.liferay.portal.service.base.UserGroupServiceBaseImpl

afterPropertiesSet, destroy, getCounterLocalService, getExpandoRowLocalService, getExpandoRowPersistence, getExportImportConfigurationFinder, getExportImportConfigurationLocalService, getExportImportConfigurationPersistence, getExportImportConfigurationService, getExportImportLocalService, getExportImportService, getGroupFinder, getGroupLocalService, getGroupPersistence, getGroupService, getLayoutFinder, getLayoutLocalService, getLayoutPersistence, getLayoutService, getModelClass, getModelClassName, getOSGiServiceIdentifier, getResourceLocalService, getTeamFinder, getTeamLocalService, getTeamPersistence, getTeamService, getUserFinder, getUserGroupFinder, getUserGroupGroupRoleFinder, getUserGroupGroupRoleLocalService, getUserGroupGroupRolePersistence, getUserGroupGroupRoleService, getUserGroupLocalService, getUserGroupPersistence, getUserGroupService, getUserLocalService, getUserPersistence, getUserService, runSQL, setCounterLocalService, setExpandoRowLocalService, setExpandoRowPersistence, setExportImportConfigurationFinder, setExportImportConfigurationLocalService, setExportImportConfigurationPersistence, setExportImportConfigurationService, setExportImportLocalService, setExportImportService, setGroupFinder, setGroupLocalService, setGroupPersistence, setGroupService, setLayoutFinder, setLayoutLocalService, setLayoutPersistence, setLayoutService, setResourceLocalService, setTeamFinder, setTeamLocalService, setTeamPersistence, setTeamService, setUserFinder, setUserGroupFinder, setUserGroupGroupRoleFinder, setUserGroupGroupRoleLocalService, setUserGroupGroupRolePersistence, setUserGroupGroupRoleService, setUserGroupLocalService, setUserGroupPersistence, setUserGroupService, setUserLocalService, setUserPersistence, setUserService

Methods inherited from class com.liferay.portal.kernel.service.BaseServiceImpl

getClassLoader, getGuestOrUser, getGuestOrUserId, getPermissionChecker, getUser, getUserId

Methods inherited from class Object

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

Constructor Detail

UserGroupServiceImpl

public UserGroupServiceImpl()

Method Detail

addGroupUserGroups

public void addGroupUserGroups(long groupId,
                               long[] userGroupIds)
                        throws com.liferay.portal.kernel.exception.PortalException

Adds the user groups to the group.

Parameters:

groupId - the primary key of the group

userGroupIds - the primary keys of the user groups

Throws:

com.liferay.portal.kernel.exception.PortalException

addTeamUserGroups

public void addTeamUserGroups(long teamId,
                              long[] userGroupIds)
                       throws com.liferay.portal.kernel.exception.PortalException

Adds the user groups to the team

Parameters:

teamId - the primary key of the team

userGroupIds - the primary keys of the user groups

Throws:

com.liferay.portal.kernel.exception.PortalException

addUserGroup

@Deprecated
public com.liferay.portal.kernel.model.UserGroup addUserGroup(String name,
                                                                          String description)
                                                                   throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Newton (6.2.x), replaced by addUserGroup(String, String, ServiceContext)

Adds a user group.

This method handles the creation and bookkeeping of the user group, including its resources, metadata, and internal data structures.

Parameters:

name - the user group's name

description - the user group's description

Returns:

the user group

Throws:

com.liferay.portal.kernel.exception.PortalException

addUserGroup

public com.liferay.portal.kernel.model.UserGroup addUserGroup(String name,
                                                              String description,
                                                              com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                       throws com.liferay.portal.kernel.exception.PortalException

Adds a user group.

This method handles the creation and bookkeeping of the user group, including its resources, metadata, and internal data structures.

Parameters:

name - the user group's name

description - the user group's description

serviceContext - the service context to be applied (optionally null). Can set expando bridge attributes for the user group.

Returns:

the user group

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteUserGroup

public void deleteUserGroup(long userGroupId)
                     throws com.liferay.portal.kernel.exception.PortalException

Deletes the user group.

Parameters:

userGroupId - the primary key of the user group

Throws:

com.liferay.portal.kernel.exception.PortalException

fetchUserGroup

public com.liferay.portal.kernel.model.UserGroup fetchUserGroup(long userGroupId)
                                                         throws com.liferay.portal.kernel.exception.PortalException

Fetches the user group with the primary key.

Parameters:

userGroupId - the primary key of the user group

Returns:

the user group with the primary key

Throws:

com.liferay.portal.kernel.exception.PortalException

getGtUserGroups

public List<com.liferay.portal.kernel.model.UserGroup> getGtUserGroups(long gtUserGroupId,
                                                                       long companyId,
                                                                       long parentUserGroupId,
                                                                       int size)

getUserGroup

public com.liferay.portal.kernel.model.UserGroup getUserGroup(long userGroupId)
                                                       throws com.liferay.portal.kernel.exception.PortalException

Returns the user group with the primary key.

Parameters:

userGroupId - the primary key of the user group

Returns:

the user group with the primary key

Throws:

com.liferay.portal.kernel.exception.PortalException

getUserGroup

public com.liferay.portal.kernel.model.UserGroup getUserGroup(String name)
                                                       throws com.liferay.portal.kernel.exception.PortalException

Returns the user group with the name.

Parameters:

name - the user group's name

Returns:

the user group with the name

Throws:

com.liferay.portal.kernel.exception.PortalException

getUserGroups

public List<com.liferay.portal.kernel.model.UserGroup> getUserGroups(long companyId)
                                                              throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getUserGroups

public List<com.liferay.portal.kernel.model.UserGroup> getUserGroups(long companyId,
                                                                     String name,
                                                                     int start,
                                                                     int end)

getUserGroupsCount

public int getUserGroupsCount(long companyId,
                              String name)

getUserUserGroups

public List<com.liferay.portal.kernel.model.UserGroup> getUserUserGroups(long userId)
                                                                  throws com.liferay.portal.kernel.exception.PortalException

Returns all the user groups to which the user belongs.

Parameters:

userId - the primary key of the user

Returns:

the user groups to which the user belongs

Throws:

com.liferay.portal.kernel.exception.PortalException

unsetGroupUserGroups

public void unsetGroupUserGroups(long groupId,
                                 long[] userGroupIds)
                          throws com.liferay.portal.kernel.exception.PortalException

Removes the user groups from the group.

Parameters:

groupId - the primary key of the group

userGroupIds - the primary keys of the user groups

Throws:

com.liferay.portal.kernel.exception.PortalException

unsetTeamUserGroups

public void unsetTeamUserGroups(long teamId,
                                long[] userGroupIds)
                         throws com.liferay.portal.kernel.exception.PortalException

Removes the user groups from the team.

Parameters:

teamId - the primary key of the team

userGroupIds - the primary keys of the user groups

Throws:

com.liferay.portal.kernel.exception.PortalException

updateUserGroup

@Deprecated
public com.liferay.portal.kernel.model.UserGroup updateUserGroup(long userGroupId,
                                                                             String name,
                                                                             String description)
                                                                      throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Newton (6.2.x), replaced by updateUserGroup(long, String, String, ServiceContext)

Updates the user group.

Parameters:

userGroupId - the primary key of the user group

name - the user group's name

description - the the user group's description

Returns:

the user group

Throws:

com.liferay.portal.kernel.exception.PortalException

updateUserGroup

public com.liferay.portal.kernel.model.UserGroup updateUserGroup(long userGroupId,
                                                                 String name,
                                                                 String description,
                                                                 com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                          throws com.liferay.portal.kernel.exception.PortalException

Updates the user group.

Parameters:

userGroupId - the primary key of the user group

name - the user group's name

description - the the user group's description

serviceContext - the service context to be applied (optionally null). Can set expando bridge attributes for the user group.

Returns:

the user group

Throws:

com.liferay.portal.kernel.exception.PortalException

filterUserGroups

protected List<com.liferay.portal.kernel.model.UserGroup> filterUserGroups(List<com.liferay.portal.kernel.model.UserGroup> userGroups)
                                                                    throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException