Package ca.corefacility.bioinformatics.irida.ria.web.services

Class UIProjectUserGroupsService

java.lang.Object

ca.corefacility.bioinformatics.irida.ria.web.services.UIProjectUserGroupsService

@Component
public class UIProjectUserGroupsService
extends java.lang.Object

UI Service to handle requests for project user groups.

Constructor Summary

Constructors

Constructor	Description
UIProjectUserGroupsService(ProjectService projectService, UserGroupService userGroupService, org.springframework.context.MessageSource messageSource)

Method Summary

Modifier and Type	Method	Description
java.lang.String	addUserGroupToProject(java.lang.Long projectId, NewMemberRequest request, java.util.Locale locale)	Add a UserGroup to the current Project
java.util.List<UserGroup>	getAvailableUserGroupsForProject(java.lang.Long projectId, java.lang.String query)	Get a list of UserGroups that are not on the current Project
TableResponse<ProjectUserGroupsTableModel>	getUserGroupsForProject(java.lang.Long projectId, TableRequest request)	Get a table page of ProjectUserGroupsTableModel
java.lang.String	removeUserGroupFromProject(long projectId, long groupId, java.util.Locale locale)	Remove a UserGroup from a Project
java.lang.String	updateUserGroupMetadataRoleOnProject(java.lang.Long projectId, java.lang.Long groupId, java.lang.String metadataRole, java.util.Locale locale)	Update the ProjectMetadataRole of a UserGroup on the current Project
java.lang.String	updateUserGroupRoleOnProject(java.lang.Long projectId, java.lang.Long groupId, java.lang.String role, java.util.Locale locale)	Update the ProjectRole of a UserGroup on the current Project

Methods inherited from class java.lang.Object

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

Constructor Detail

UIProjectUserGroupsService

public UIProjectUserGroupsService(ProjectService projectService,
                                  UserGroupService userGroupService,
                                  org.springframework.context.MessageSource messageSource)

Method Detail

getUserGroupsForProject

public TableResponse<ProjectUserGroupsTableModel> getUserGroupsForProject(java.lang.Long projectId,
                                                                          TableRequest request)

Get a table page of ProjectUserGroupsTableModel

Parameters:

projectId - Identifier for a Project

request - TableRequest details about the current page of the table

Returns:

TableResponse

removeUserGroupFromProject

public java.lang.String removeUserGroupFromProject(long projectId,
                                                   long groupId,
                                                   java.util.Locale locale)

Remove a UserGroup from a Project

Parameters:

projectId - Identifier for a Project

groupId - Identifier for an UserGroup

locale - current users Locale

Returns:

message to user about the result of removing the user group

getAvailableUserGroupsForProject

public java.util.List<UserGroup> getAvailableUserGroupsForProject(java.lang.Long projectId,
                                                                  java.lang.String query)

Get a list of UserGroups that are not on the current Project

Parameters:

projectId - Identifier for the current Project

query - Filter string to search the existing UserGroups by

Returns:

List of UserGroup

addUserGroupToProject

public java.lang.String addUserGroupToProject(java.lang.Long projectId,
                                              NewMemberRequest request,
                                              java.util.Locale locale)

Add a UserGroup to the current Project

Parameters:

projectId - Identifier for a Project

request - Identifier for an UserGroup

locale - Current users Locale

Returns:

message to user about the outcome of adding the user group to the project

updateUserGroupRoleOnProject

public java.lang.String updateUserGroupRoleOnProject(java.lang.Long projectId,
                                                     java.lang.Long groupId,
                                                     java.lang.String role,
                                                     java.util.Locale locale)
                                              throws UIProjectWithoutOwnerException,
                                                     UIConstraintViolationException

Update the ProjectRole of a UserGroup on the current Project

Parameters:

projectId - Identifier for a Project

groupId - Identifier for an UserGroup

role - Role to update the user group to

locale - Current users Locale

Returns:

message to user about the result of the update

Throws:

UIProjectWithoutOwnerException - thrown when updating the role will result in the project to have no owner

UIConstraintViolationException - thrown when updating the project role to owner and the metadata role is not set to the highest level

updateUserGroupMetadataRoleOnProject

public java.lang.String updateUserGroupMetadataRoleOnProject(java.lang.Long projectId,
                                                             java.lang.Long groupId,
                                                             java.lang.String metadataRole,
                                                             java.util.Locale locale)
                                                      throws UIConstraintViolationException

Update the ProjectMetadataRole of a UserGroup on the current Project

Parameters:

projectId - Identifier for a Project

groupId - Identifier for an UserGroup

metadataRole - metadata role to update for the group

locale - Current users Locale

Returns:

message to user about the result of the update

Throws:

UIConstraintViolationException - if a project owners metadata role is set to anything other than the highest level