com.liferay.portal.service
Interface UserGroupService

All Superinterfaces:

BaseService

All Known Implementing Classes:

UserGroupServiceWrapper

@ProviderType
@AccessControlled
@JSONWebService
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface UserGroupService
extends BaseService

Provides the remote service interface for UserGroup. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

See Also:

UserGroupServiceUtil, UserGroupServiceBaseImpl, com.liferay.portal.service.impl.UserGroupServiceImpl

Method Summary

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
UserGroup	addUserGroup(String name, String description) Deprecated. As of 6.2.0, replaced by addUserGroup(String, String, ServiceContext)
UserGroup	addUserGroup(String name, String description, ServiceContext serviceContext) Adds a user group.
void	deleteUserGroup(long userGroupId) Deletes the user group.
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
UserGroup	getUserGroup(long userGroupId) Returns the user group with the primary key.
UserGroup	getUserGroup(String name) Returns the user group with the name.
List<UserGroup>	getUserUserGroups(long userId) Returns all the user groups to which the user belongs.
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
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.
UserGroup	updateUserGroup(long userGroupId, String name, String description) Deprecated. As of 6.2.0, replaced by updateUserGroup(long, String, String, ServiceContext)
UserGroup	updateUserGroup(long userGroupId, String name, String description, ServiceContext serviceContext) Updates the user group.

Method Detail

getBeanIdentifier

String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addGroupUserGroups

void addGroupUserGroups(long groupId,
                        long[] userGroupIds)
                        throws PortalException,
                               SystemException

Adds the user groups to the group.

Parameters:

groupId - the primary key of the group

userGroupIds - the primary keys of the user groups

Throws:

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

SystemException - if a system exception occurred

addTeamUserGroups

void addTeamUserGroups(long teamId,
                       long[] userGroupIds)
                       throws PortalException,
                              SystemException

Adds the user groups to the team

Parameters:

teamId - the primary key of the team

userGroupIds - the primary keys of the user groups

Throws:

PortalException - if a team or user group with the primary key could not be found, or if the user did not have permission to assign team members

SystemException - if a system exception occurred

addUserGroup

UserGroup addUserGroup(String name,
                       String description)
                       throws PortalException,
                              SystemException

Deprecated. As of 6.2.0, 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:

PortalException - if the user group's information was invalid or if the user did not have permission to add the user group

SystemException - if a system exception occurred

addUserGroup

UserGroup addUserGroup(String name,
                       String description,
                       ServiceContext serviceContext)
                       throws PortalException,
                              SystemException

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:

PortalException - if the user group's information was invalid or if the user did not have permission to add the user group

SystemException - if a system exception occurred

deleteUserGroup

void deleteUserGroup(long userGroupId)
                     throws PortalException,
                            SystemException

Deletes the user group.

Parameters:

userGroupId - the primary key of the user group

Throws:

PortalException - if a user group with the primary key could not be found, if the user did not have permission to delete the user group, or if the user group had a workflow in approved status

SystemException - if a system exception occurred

getUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserGroup getUserGroup(long userGroupId)
                       throws PortalException,
                              SystemException

Returns the user group with the primary key.

Parameters:

userGroupId - the primary key of the user group

Returns:

Returns the user group with the primary key

Throws:

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

SystemException - if a system exception occurred

getUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserGroup getUserGroup(String name)
                       throws PortalException,
                              SystemException

Returns the user group with the name.

Parameters:

name - the user group's name

Returns:

Returns the user group with the name

Throws:

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

SystemException - if a system exception occurred

getUserUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getUserUserGroups(long userId)
                                  throws PortalException,
                                         SystemException

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:

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

SystemException - if a system exception occurred

unsetGroupUserGroups

void unsetGroupUserGroups(long groupId,
                          long[] userGroupIds)
                          throws PortalException,
                                 SystemException

Removes the user groups from the group.

Parameters:

groupId - the primary key of the group

userGroupIds - the primary keys of the user groups

Throws:

PortalException - if the user did not have permission to assign group members

SystemException - if a system exception occurred

unsetTeamUserGroups

void unsetTeamUserGroups(long teamId,
                         long[] userGroupIds)
                         throws PortalException,
                                SystemException

Removes the user groups from the team.

Parameters:

teamId - the primary key of the team

userGroupIds - the primary keys of the user groups

Throws:

PortalException - if the user did not have permission to assign team members

SystemException - if a system exception occurred

updateUserGroup

UserGroup updateUserGroup(long userGroupId,
                          String name,
                          String description)
                          throws PortalException,
                                 SystemException

Deprecated. As of 6.2.0, 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:

PortalException - if a user group with the primary key was not found, if the new information was invalid, or if the user did not have permission to update the user group information

SystemException - if a system exception occurred

updateUserGroup

UserGroup updateUserGroup(long userGroupId,
                          String name,
                          String description,
                          ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException

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:

PortalException - if a user group with the primary key was not found, if the new information was invalid, or if the user did not have permission to update the user group information

SystemException - if a system exception occurred