Package ca.corefacility.bioinformatics.irida.service

Interface ProjectSubscriptionService

All Superinterfaces:

CRUDService<java.lang.Long,ProjectSubscription>

All Known Implementing Classes:

ProjectSubscriptionServiceImpl

public interface ProjectSubscriptionService
extends CRUDService<java.lang.Long,ProjectSubscription>

A specialized service layer for project subscriptions.

Method Summary

Modifier and Type	Method	Description
ProjectSubscription	addProjectSubscriptionForProjectAndUser(Project project, User user)	Create a new project subscription associated with a Project and User.
java.util.List<Project>	getProjectsForUserWithEmailSubscriptions(User user)	Get a List of all Projects that a given User is subscribed to.
org.springframework.data.domain.Page<ProjectSubscription>	getProjectSubscriptionsForUser(User user, int page, int size, org.springframework.data.domain.Sort sort)	Get a page of project subscriptions associated with a user.
java.util.List<User>	getUsersWithEmailSubscriptions()	Get a List of all Users that are subscribed to any Projects.
void	removeProjectSubscriptionForProjectAndUser(Project project, User user)	Remove the project subscription associated with a Project and User.

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

getProjectSubscriptionsForUser

org.springframework.data.domain.Page<ProjectSubscription> getProjectSubscriptionsForUser(User user,
                                                                                         int page,
                                                                                         int size,
                                                                                         org.springframework.data.domain.Sort sort)

Get a page of project subscriptions associated with a user.

Parameters:

user - the user to show project subscriptions for

page - the current page of results

size - the number of results on the page

sort - the sort properties

Returns:

Page of ProjectSubscriptions

getUsersWithEmailSubscriptions

java.util.List<User> getUsersWithEmailSubscriptions()

Get a List of all Users that are subscribed to any Projects.

Returns:

A List of Users

getProjectsForUserWithEmailSubscriptions

java.util.List<Project> getProjectsForUserWithEmailSubscriptions(User user)

Get a List of all Projects that a given User is subscribed to.

Parameters:

user - the user to show project subscriptions for

Returns:

A List of Projects

addProjectSubscriptionForProjectAndUser

ProjectSubscription addProjectSubscriptionForProjectAndUser(Project project,
                                                            User user)

Create a new project subscription associated with a Project and User.

Parameters:

project - the project

user - the user

Returns:

The newly created project subscription

removeProjectSubscriptionForProjectAndUser

void removeProjectSubscriptionForProjectAndUser(Project project,
                                                User user)

Remove the project subscription associated with a Project and User.

Parameters:

project - the project

user - the user