com.liferay.portal.kernel.service

Interface UserGroupService

All Superinterfaces:

BaseService

All Known Implementing Classes:

UserGroupServiceWrapper

@AccessControlled
 @JSONWebService
 @ProviderType
 @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.

Author:

Brian Wing Shun Chan

See Also:

UserGroupServiceUtil

{$generated.description}

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
UserGroup	addUserGroup(String name, String description, ServiceContext serviceContext) Adds a user group.
void	deleteUserGroup(long userGroupId) Deletes the user group.
UserGroup	fetchUserGroup(long userGroupId) Fetches the user group with the primary key.
List<UserGroup>	getGtUserGroups(long gtUserGroupId, long companyId, long parentUserGroupId, int size)
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
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>	getUserGroups(long companyId)
List<UserGroup>	getUserGroups(long companyId, String name, int start, int end)
int	getUserGroupsCount(long companyId, String name)
List<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.
UserGroup	updateUserGroup(long userGroupId, String name, String description, ServiceContext serviceContext) Updates the user group.

Method Detail

addGroupUserGroups

void addGroupUserGroups(long groupId,
                        long[] userGroupIds)
                 throws 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:

PortalException

addTeamUserGroups

void addTeamUserGroups(long teamId,
                       long[] userGroupIds)
                throws 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:

PortalException

addUserGroup

UserGroup addUserGroup(String name,
                       String description,
                       ServiceContext serviceContext)
                throws 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:

PortalException

deleteUserGroup

void deleteUserGroup(long userGroupId)
              throws PortalException

Deletes the user group.

Parameters:

userGroupId - the primary key of the user group

Throws:

PortalException

fetchUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserGroup fetchUserGroup(long userGroupId)
                                                                                     throws 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:

PortalException

getGtUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getGtUserGroups(long gtUserGroupId,
                                                                                                   long companyId,
                                                                                                   long parentUserGroupId,
                                                                                                   int size)

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserGroup getUserGroup(long userGroupId)
                                                                                   throws 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:

PortalException

getUserGroup

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

Returns the user group with the name.

Parameters:

name - the user group's name

Returns:

the user group with the name

Throws:

PortalException

getUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getUserGroups(long companyId)
                                                                                          throws PortalException

Throws:

PortalException

getUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getUserGroups(long companyId,
                                                                                                 String name,
                                                                                                 int start,
                                                                                                 int end)

getUserGroupsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserGroupsCount(long companyId,
                                                                                          String name)

getUserUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getUserUserGroups(long userId)
                                                                                              throws 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:

PortalException

unsetGroupUserGroups

void unsetGroupUserGroups(long groupId,
                          long[] userGroupIds)
                   throws 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:

PortalException

unsetTeamUserGroups

void unsetTeamUserGroups(long teamId,
                         long[] userGroupIds)
                  throws 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:

PortalException

updateUserGroup

UserGroup updateUserGroup(long userGroupId,
                          String name,
                          String description,
                          ServiceContext serviceContext)
                   throws 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:

PortalException