org.jasig.portlet.notice.service.jpa

Class JpaNotificationRESTService

java.lang.Object

org.jasig.portlet.notice.service.jpa.JpaNotificationRESTService

All Implemented Interfaces:

IJpaNotificationRESTService

@Service
public class JpaNotificationRESTService
extends Object
implements IJpaNotificationRESTService

Since:

3.0

Author:

Josh Helmer, jhelmer.unicon.net

Constructor Summary

Constructors

Constructor and Description
JpaNotificationRESTService()

Method Summary

Modifier and Type	Method and Description
AddresseeDTO	createAddressee(long notificationId, AddresseeDTO addressee) Create the addressee.
EventDTO	createEvent(long notificationId, EventDTO event) Create an event.
EntryDTO	createNotification(EntryDTO entry) Create a notification.
AddresseeDTO	getAddressee(long addresseeId) Get a single addressee by id.
Set<AddresseeDTO>	getAddressees(long notificationId) Get the List addressees for a notification.
EventDTO	getEvent(long eventId) Get a single event.
List<EventDTO>	getEventsByNotification(long notificationId) Get the list of events by notification.
EntryDTO	getNotification(long id, boolean full) Get a notification by id.
List<EntryDTO>	getNotifications(Integer page, Integer pageSize) Get the list of notifications.

Methods inherited from class java.lang.Object

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

Constructor Detail

JpaNotificationRESTService

public JpaNotificationRESTService()

Method Detail

getNotifications

@Transactional(readOnly=true)
public List<EntryDTO> getNotifications(Integer page,
                                                                     Integer pageSize)

Description copied from interface: IJpaNotificationRESTService

Get the list of notifications.

Specified by:

getNotifications in interface IJpaNotificationRESTService

Parameters:

page - 0 based page #

pageSize - page size

Returns:

the list of entries.

getNotification

@Transactional(readOnly=true)
public EntryDTO getNotification(long id,
                                                              boolean full)

Description copied from interface: IJpaNotificationRESTService

Get a notification by id.

Specified by:

getNotification in interface IJpaNotificationRESTService

Parameters:

id - the notification id

full - if true, will fetch the addressee info as well, otherwise will omit

Returns:

The entry if found, else null

createNotification

@Transactional
public EntryDTO createNotification(EntryDTO entry)

Description copied from interface: IJpaNotificationRESTService

Create a notification.

Specified by:

createNotification in interface IJpaNotificationRESTService

Parameters:

entry - the notification object. Should *NOT* contain a populated id field.

Returns:

the newly created Entry

getAddressees

@Transactional(readOnly=true)
public Set<AddresseeDTO> getAddressees(long notificationId)

Description copied from interface: IJpaNotificationRESTService

Get the List addressees for a notification.

Specified by:

getAddressees in interface IJpaNotificationRESTService

Parameters:

notificationId - the notification id

Returns:

the set of notifications

getAddressee

@Transactional(readOnly=true)
public AddresseeDTO getAddressee(long addresseeId)

Description copied from interface: IJpaNotificationRESTService

Get a single addressee by id.

Specified by:

getAddressee in interface IJpaNotificationRESTService

Parameters:

addresseeId - the addressee id

Returns:

the addressee if found, else null

createAddressee

@Transactional
public AddresseeDTO createAddressee(long notificationId,
                                                   AddresseeDTO addressee)

Description copied from interface: IJpaNotificationRESTService

Create the addressee.

Specified by:

createAddressee in interface IJpaNotificationRESTService

Parameters:

notificationId - the notification to attach the addressee to

addressee - the addressee object. Should *NOT* create an id

Returns:

the newly created addressee

getEventsByNotification

@Transactional(readOnly=true)
public List<EventDTO> getEventsByNotification(long notificationId)

Description copied from interface: IJpaNotificationRESTService

Get the list of events by notification.

Specified by:

getEventsByNotification in interface IJpaNotificationRESTService

Parameters:

notificationId - the notification id

Returns:

the list of events

getEvent

@Transactional(readOnly=true)
public EventDTO getEvent(long eventId)

Description copied from interface: IJpaNotificationRESTService

Get a single event.

Specified by:

getEvent in interface IJpaNotificationRESTService

Parameters:

eventId - the event id

Returns:

the event if found, else null

createEvent

@Transactional
public EventDTO createEvent(long notificationId,
                                           EventDTO event)

Description copied from interface: IJpaNotificationRESTService

Create an event.

Specified by:

createEvent in interface IJpaNotificationRESTService

Parameters:

notificationId - the notification id

event - the entry to create. Should *NOT* contain an id.

Returns:

the newly created event