org.jasig.portlet.notice.service.jpa

Interface IJpaNotificationRESTService

All Known Implementing Classes:

JpaNotificationRESTService

public interface IJpaNotificationRESTService

Service for the REST-ful API for JPA Notifications.

Since:

3.0

Author:

Josh Helmer, jhelmer.unicon.net

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 notification) 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.
List<EventDTO>	getEventsByNotificationAndUser(long notificationId, String username) Get the list of events by notification.
EntryDTO	getNotification(long id, boolean full) Get an EntryDTO by id.
EntryDTO	getNotification(NotificationEntry entry, boolean full) Get an EntryDTO for a NotificationEntry, if applicable.
List<EntryDTO>	getNotifications(Integer page, Integer pageSize) Get a paged list of all notifications in the data source.
List<EntryDTO>	getNotificationsBySourceAndCustomAttribute(String source, String attributeName, String attributeValue) Supports custom integrations and decorators.

Method Detail

getNotification

EntryDTO getNotification(long id,
                         boolean full)

Get an EntryDTO by id.

getNotification

EntryDTO getNotification(NotificationEntry entry,
                         boolean full)

Get an EntryDTO for a NotificationEntry, if applicable.

getNotifications

List<EntryDTO> getNotifications(Integer page,
                                Integer pageSize)

Get a paged list of all notifications in the data source.

Parameters:

page - 0 based page #

pageSize - page size

Returns:

the list of entries.

getNotificationsBySourceAndCustomAttribute

List<EntryDTO> getNotificationsBySourceAndCustomAttribute(String source,
                                                          String attributeName,
                                                          String attributeValue)

Supports custom integrations and decorators. Allows another component within the Notification app to find entries that match a source (a string representing the other component) and a custom criterion.

createNotification

EntryDTO createNotification(EntryDTO notification)

Create a notification.

Parameters:

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

Returns:

the newly created Entry

getAddressees

Set<AddresseeDTO> getAddressees(long notificationId)

Get the List addressees for a notification.

Parameters:

notificationId - the notification id

Returns:

the set of notifications

getAddressee

AddresseeDTO getAddressee(long addresseeId)

Get a single addressee by id.

Parameters:

addresseeId - the addressee id

Returns:

the addressee if found, else null

createAddressee

AddresseeDTO createAddressee(long notificationId,
                             AddresseeDTO addressee)

Create the addressee.

Parameters:

notificationId - the notification to attach the addressee to

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

Returns:

the newly created addressee

getEventsByNotification

List<EventDTO> getEventsByNotification(long notificationId)

Get the list of events by notification.

Parameters:

notificationId - the notification id

Returns:

the list of events

getEventsByNotificationAndUser

List<EventDTO> getEventsByNotificationAndUser(long notificationId,
                                              String username)

Get the list of events by notification.

Parameters:

notificationId - the notification id

Returns:

the list of events

getEvent

EventDTO getEvent(long eventId)

Get a single event.

Parameters:

eventId - the event id

Returns:

the event if found, else null

createEvent

EventDTO createEvent(long notificationId,
                     EventDTO event)

Create an event.

Parameters:

notificationId - the notification id

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

Returns:

the newly created event