Package ca.corefacility.bioinformatics.irida.service.impl

Class AnnouncementServiceImpl

java.lang.Object

ca.corefacility.bioinformatics.irida.service.impl.CRUDServiceImpl<java.lang.Long,Announcement>

ca.corefacility.bioinformatics.irida.service.impl.AnnouncementServiceImpl

All Implemented Interfaces:

AnnouncementService, CRUDService<java.lang.Long,Announcement>

@Service
public class AnnouncementServiceImpl
extends CRUDServiceImpl<java.lang.Long,Announcement>
implements AnnouncementService

Service for managing @{link Announcements}

Field Summary

Fields inherited from class ca.corefacility.bioinformatics.irida.service.impl.CRUDServiceImpl

CREATED_DATE_SORT_PROPERTY, repository, validator, valueType

Constructor Summary

Constructors

Constructor	Description
AnnouncementServiceImpl(AnnouncementRepository announcementRepository, AnnouncementUserJoinRepository announcementUserJoinRepository, UserRepository userRepository, javax.validation.Validator validator)

Method Summary

Modifier and Type	Method	Description
java.util.Map<Announcement,java.lang.Long>	countReadsForAllAnnouncements()	Get a map where the keys are Announcements and the values are Integers representing the number of Users who have read that announcement.
java.lang.Long	countReadsForOneAnnouncement(Announcement announcement)	Get a count of the number of Users who have read Announcement
Announcement	create(Announcement announcement)	Create a new object in the persistence store.
void	delete(java.lang.Long id)	Delete the object with the specified identifier from the database.
java.util.List<Announcement>	getAllAnnouncements()	Get a list of all of the Announcements that currently exist
java.util.List<Announcement>	getAnnouncementsCreatedByUser(User user)	Get a list of Announcements created by specific admin User
java.util.List<AnnouncementUserReadDetails>	getAnnouncementsForUser(User user)	Get a list of Announcements that have been read and unread by User
java.util.List<AnnouncementUserJoin>	getReadAnnouncementsForUser(User user)	Get a list of Announcements that have been read by User
java.util.List<AnnouncementUserJoin>	getReadUsersForAnnouncement(Announcement announcement)	Get all of the Joins describing users that have comfirmed they've read a particular Announcement
java.util.List<Announcement>	getUnreadAnnouncementsForUser(User user)	Get a list of Announcements that have not been read by User
java.util.List<User>	getUnreadUsersForAnnouncement(Announcement announcement)	Get a list of all of the Users that have not confirmed they've read the Announcement
AnnouncementUserJoin	markAnnouncementAsReadByUser(Announcement announcement, User user)	Mark an Announcement object as read by a User
void	markAnnouncementAsUnreadByUser(Announcement announcement, User user)	Mark an Announcement as unread by a User
Announcement	read(java.lang.Long id)	Read the object type by unique identifier.
org.springframework.data.domain.Page<Announcement>	search(org.springframework.data.jpa.domain.Specification<Announcement> specification, org.springframework.data.domain.Pageable request)	Search for an entity of Type and PageRequest
Announcement	update(Announcement announcement)	Update an object

Methods inherited from class ca.corefacility.bioinformatics.irida.service.impl.CRUDServiceImpl

count, exists, findAll, findRevisions, findRevisions, list, list, list, readMultiple, search, updateFields, updateMultiple

Methods inherited from class java.lang.Object

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

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

count, exists, findAll, findRevisions, findRevisions, list, list, list, readMultiple, search, updateFields, updateMultiple

Constructor Detail

AnnouncementServiceImpl

@Autowired
public AnnouncementServiceImpl(AnnouncementRepository announcementRepository,
                               AnnouncementUserJoinRepository announcementUserJoinRepository,
                               UserRepository userRepository,
                               javax.validation.Validator validator)

Method Detail

create

@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
public Announcement create(Announcement announcement)

Create a new object in the persistence store.

Specified by:

create in interface CRUDService<java.lang.Long,Announcement>

Overrides:

create in class CRUDServiceImpl<java.lang.Long,Announcement>

Parameters:

announcement - The object to persist.

Returns:

The object as it was persisted in the database. May modify the identifier of the object when returned.

delete

@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
public void delete(java.lang.Long id)

Delete the object with the specified identifier from the database.

Specified by:

delete in interface CRUDService<java.lang.Long,Announcement>

Overrides:

delete in class CRUDServiceImpl<java.lang.Long,Announcement>

Parameters:

id - The identifier of the object to delete.

update

@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
public Announcement update(Announcement announcement)

Update an object

Specified by:

update in interface CRUDService<java.lang.Long,Announcement>

Overrides:

update in class CRUDServiceImpl<java.lang.Long,Announcement>

Parameters:

announcement - The object to update

Returns:

The updated object

read

@PreAuthorize("hasAnyRole(\'ROLE_USER\')")
public Announcement read(java.lang.Long id)

Read the object type by unique identifier.

Specified by:

read in interface CRUDService<java.lang.Long,Announcement>

Overrides:

read in class CRUDServiceImpl<java.lang.Long,Announcement>

Parameters:

id - The unique identifier for this object.

Returns:

The object corresponding to the unique identifier.

search

@PreAuthorize("hasAnyRole(\'ROLE_USER\')")
public org.springframework.data.domain.Page<Announcement> search(org.springframework.data.jpa.domain.Specification<Announcement> specification,
                                                                 org.springframework.data.domain.Pageable request)

Search for an entity of Type and PageRequest

Specified by:

search in interface CRUDService<java.lang.Long,Announcement>

Overrides:

search in class CRUDServiceImpl<java.lang.Long,Announcement>

Parameters:

specification - The search Specification

request - The PageRequest

Returns:

a Page of Type

markAnnouncementAsReadByUser

@PreAuthorize("hasAnyRole(\'ROLE_USER\')")
public AnnouncementUserJoin markAnnouncementAsReadByUser(Announcement announcement,
                                                         User user)
                                                  throws EntityExistsException

Mark an Announcement object as read by a User

Specified by:

markAnnouncementAsReadByUser in interface AnnouncementService

Parameters:

announcement - The announcement to mark

user - the user who's read the announcement

Returns:

An AnnouncementUserJoin object representing the relationship between the announcement and the user

Throws:

EntityExistsException

markAnnouncementAsUnreadByUser

@PreAuthorize("hasAnyRole(\'ROLE_USER\')")
public void markAnnouncementAsUnreadByUser(Announcement announcement,
                                           User user)
                                    throws EntityNotFoundException

Mark an Announcement as unread by a User

Specified by:

markAnnouncementAsUnreadByUser in interface AnnouncementService

Parameters:

announcement - the announcement to mark

user - the user to mark the announcement for

Throws:

EntityNotFoundException

getReadUsersForAnnouncement

@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
public java.util.List<AnnouncementUserJoin> getReadUsersForAnnouncement(Announcement announcement)
                                                                 throws EntityNotFoundException

Get all of the Joins describing users that have comfirmed they've read a particular Announcement

Specified by:

getReadUsersForAnnouncement in interface AnnouncementService

Parameters:

announcement - The Announcement for which we want to load users that have read it

Returns:

List of Users that have read the announcement

Throws:

EntityNotFoundException

getUnreadUsersForAnnouncement

@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
public java.util.List<User> getUnreadUsersForAnnouncement(Announcement announcement)
                                                   throws EntityNotFoundException

Get a list of all of the Users that have not confirmed they've read the Announcement

Specified by:

getUnreadUsersForAnnouncement in interface AnnouncementService

Parameters:

announcement - The

Returns:

List of Users that haven't confirmed they've read the announcement

Throws:

EntityNotFoundException

getAnnouncementsForUser

@PreAuthorize("hasPermission(#user, \'canUpdateUser\')")
public java.util.List<AnnouncementUserReadDetails> getAnnouncementsForUser(User user)

Get a list of Announcements that have been read and unread by User

Specified by:

getAnnouncementsForUser in interface AnnouncementService

Parameters:

user - User for whom we want to get unread announcements

Returns:

list of AnnouncementUserReadDetails objects representing announcements read and unread by a user

getReadAnnouncementsForUser

@PreAuthorize("hasPermission(#user, \'canUpdateUser\')")
public java.util.List<AnnouncementUserJoin> getReadAnnouncementsForUser(User user)

Get a list of Announcements that have been read by User

Specified by:

getReadAnnouncementsForUser in interface AnnouncementService

Parameters:

user - User for whom we want to get unread announcements

Returns:

list of Join objects representing announcements marked as read by a user

getUnreadAnnouncementsForUser

@PreAuthorize("hasPermission(#user, \'canUpdateUser\')")
public java.util.List<Announcement> getUnreadAnnouncementsForUser(User user)

Get a list of Announcements that have not been read by User

Specified by:

getUnreadAnnouncementsForUser in interface AnnouncementService

Parameters:

user - User for whom we want to get unread announcements

Returns:

List of Announcements that have not been read by the user

getAllAnnouncements

@PreAuthorize("hasAnyRole(\'ROLE_USER\')")
public java.util.List<Announcement> getAllAnnouncements()

Get a list of all of the Announcements that currently exist

Specified by:

getAllAnnouncements in interface AnnouncementService

Returns:

List of Announcements

getAnnouncementsCreatedByUser

@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
public java.util.List<Announcement> getAnnouncementsCreatedByUser(User user)

Get a list of Announcements created by specific admin User

Specified by:

getAnnouncementsCreatedByUser in interface AnnouncementService

Parameters:

user - The admin User who created the announcements

Returns:

List of announcements created by the admin, empty list if User is not an admin

countReadsForOneAnnouncement

@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
public java.lang.Long countReadsForOneAnnouncement(Announcement announcement)

Get a count of the number of Users who have read Announcement

Specified by:

countReadsForOneAnnouncement in interface AnnouncementService

Parameters:

announcement - Announcement for which we want the number of users who have read it

Returns:

number of users who have read Announcement

countReadsForAllAnnouncements

@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
public java.util.Map<Announcement,java.lang.Long> countReadsForAllAnnouncements()

Get a map where the keys are Announcements and the values are Integers representing the number of Users who have read that announcement.

Specified by:

countReadsForAllAnnouncements in interface AnnouncementService

Returns:

A Map of announcements and counts of users who have read that announcement