Package ca.corefacility.bioinformatics.irida.service.user

Interface UserGroupService

All Superinterfaces:

CRUDService<java.lang.Long,UserGroup>

All Known Implementing Classes:

UserGroupServiceImpl

public interface UserGroupService
extends CRUDService<java.lang.Long,UserGroup>

Service for working with UserGroups.

Method Summary

Modifier and Type	Method	Description
UserGroupJoin	addUserToGroup(User user, UserGroup userGroup, UserGroupJoin.UserGroupRole role)	Add a user to the group with the specified role.
UserGroupJoin	changeUserGroupRole(User user, UserGroup userGroup, UserGroupJoin.UserGroupRole role)	Change the role for the User in the UserGroup.
org.springframework.data.domain.Page<UserGroupJoin>	filterUsersByUsername(java.lang.String username, UserGroup userGroup, int page, int size, org.springframework.data.domain.Sort sort)	Filter the list of users in the UserGroup by username.
java.util.Collection<UserGroupProjectJoin>	getProjectsWithUserGroup(UserGroup userGroup)	Get all of the projects with group.
org.springframework.data.domain.Page<UserGroupProjectJoin>	getUserGroupsForProject(java.lang.String searchName, Project project, int page, int size, org.springframework.data.domain.Sort sort)	Get a page of UserGroupProjectJoin for a specific Project .
java.util.List<UserGroup>	getUserGroupsNotOnProject(Project project, java.lang.String filter)	Get a collection of UserGroup that aren't already on a Project.
java.util.Collection<UserGroupJoin>	getUsersForGroup(UserGroup userGroup)	Get all of the users in the group.
java.util.List<User>	getUsersNotInGroup(UserGroup userGroup, java.lang.String filter)	Get the set of User that are not currently in the UserGroup.
void	removeUserFromGroup(User user, UserGroup userGroup)	Remove the User from the UserGroup.

Methods inherited from interface ca.corefacility.bioinformatics.irida.service.CRUDService

count, create, delete, exists, findAll, findRevisions, findRevisions, list, list, list, read, readMultiple, search, search, update, updateFields, updateMultiple

Method Detail

getUsersForGroup

java.util.Collection<UserGroupJoin> getUsersForGroup(UserGroup userGroup)

Get all of the users in the group.

Parameters:

userGroup - the group to get users for.

Returns:

the users in the group.

getProjectsWithUserGroup

java.util.Collection<UserGroupProjectJoin> getProjectsWithUserGroup(UserGroup userGroup)

Get all of the projects with group.

Parameters:

userGroup - the group to get projects for.

Returns:

the projects linked to the group.

addUserToGroup

UserGroupJoin addUserToGroup(User user,
                             UserGroup userGroup,
                             UserGroupJoin.UserGroupRole role)

Add a user to the group with the specified role.

Parameters:

user - the user to add to the group

userGroup - the group to add the user to

role - the role that the user should have in the group

Returns:

the relationship created between the user and group.

changeUserGroupRole

UserGroupJoin changeUserGroupRole(User user,
                                  UserGroup userGroup,
                                  UserGroupJoin.UserGroupRole role)
                           throws UserGroupWithoutOwnerException

Change the role for the User in the UserGroup.

Parameters:

user - the user to change

userGroup - the group to change

role - the new role

Returns:

the modified relationship

Throws:

UserGroupWithoutOwnerException - when the user group doesn't have an owner as a result of the role change.

removeUserFromGroup

void removeUserFromGroup(User user,
                         UserGroup userGroup)
                  throws UserGroupWithoutOwnerException

Remove the User from the UserGroup.

Parameters:

user - the user to remove

userGroup - the group from which to remove the user.

Throws:

UserGroupWithoutOwnerException - when the user group doesn't have an owner as a result of the removal.

filterUsersByUsername

org.springframework.data.domain.Page<UserGroupJoin> filterUsersByUsername(java.lang.String username,
                                                                          UserGroup userGroup,
                                                                          int page,
                                                                          int size,
                                                                          org.springframework.data.domain.Sort sort)

Filter the list of users in the UserGroup by username.

Parameters:

username - the username string to filter on

userGroup - the user group to filter for

page - the current page

size - the size of the page

sort - the properties to sort on

Returns:

a page of UserGroupJoin.

getUsersNotInGroup

java.util.List<User> getUsersNotInGroup(UserGroup userGroup,
                                        java.lang.String filter)

Get the set of User that are not currently in the UserGroup.

Parameters:

userGroup - the group to get the set of non-members

filter - the search string to filter users by

Returns:

the list of users not in the group.

getUserGroupsForProject

org.springframework.data.domain.Page<UserGroupProjectJoin> getUserGroupsForProject(java.lang.String searchName,
                                                                                   Project project,
                                                                                   int page,
                                                                                   int size,
                                                                                   org.springframework.data.domain.Sort sort)

Get a page of UserGroupProjectJoin for a specific Project .

Parameters:

searchName - the name to search with.

project - the project

page - the current page

size - the size of the page

sort - the properties to sort on

Returns:

a page of UserGroupProjectJoin.

getUserGroupsNotOnProject

java.util.List<UserGroup> getUserGroupsNotOnProject(Project project,
                                                    java.lang.String filter)

Get a collection of UserGroup that aren't already on a Project.

Parameters:

project - the project

filter - the name to filter on

Returns:

the groups not already on the project.