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

Method Summary

Modifier and Type	Method and Description
org.jasig.portlet.notice.rest.AddresseeDTO	createAddressee(long notificationId, org.jasig.portlet.notice.rest.AddresseeDTO addressee) Create the addressee.
org.jasig.portlet.notice.rest.EventDTO	createEvent(long notificationId, org.jasig.portlet.notice.rest.EventDTO event) Create an event.
org.jasig.portlet.notice.rest.EntryDTO	createNotification(org.jasig.portlet.notice.rest.EntryDTO notification) Create a notification.
org.jasig.portlet.notice.rest.AddresseeDTO	getAddressee(long addresseeId) Get a single addressee by id.
java.util.Set<org.jasig.portlet.notice.rest.AddresseeDTO>	getAddressees(long notificationId) Get the List addressees for a notification.
org.jasig.portlet.notice.rest.EventDTO	getEvent(long eventId) Get a single event.
java.util.List<org.jasig.portlet.notice.rest.EventDTO>	getEventsByNotification(long notificationId) Get the list of events by notification.
java.util.List<org.jasig.portlet.notice.rest.EventDTO>	getEventsByNotificationAndUser(long notificationId, java.lang.String username) Get the list of events by notification.
org.jasig.portlet.notice.rest.EntryDTO	getNotification(long id, boolean full) Get an EntryDTO by id.
org.jasig.portlet.notice.rest.EntryDTO	getNotification(org.jasig.portlet.notice.NotificationEntry entry, boolean full) Get an EntryDTO for a NotificationEntry, if applicable.
java.util.List<org.jasig.portlet.notice.rest.EntryDTO>	getNotifications(java.lang.Integer page, java.lang.Integer pageSize) Get a paged list of all notifications in the data source.
java.util.List<org.jasig.portlet.notice.rest.EntryDTO>	getNotificationsBySourceAndCustomAttribute(java.lang.String source, java.lang.String attributeName, java.lang.String attributeValue) Supports custom integrations and decorators.

Method Detail

getNotification

org.jasig.portlet.notice.rest.EntryDTO getNotification(long id,
                                                       boolean full)

Get an EntryDTO by id.

getNotification

org.jasig.portlet.notice.rest.EntryDTO getNotification(org.jasig.portlet.notice.NotificationEntry entry,
                                                       boolean full)

Get an EntryDTO for a NotificationEntry, if applicable.

getNotifications

java.util.List<org.jasig.portlet.notice.rest.EntryDTO> getNotifications(java.lang.Integer page,
                                                                        java.lang.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

java.util.List<org.jasig.portlet.notice.rest.EntryDTO> getNotificationsBySourceAndCustomAttribute(java.lang.String source,
                                                                                                  java.lang.String attributeName,
                                                                                                  java.lang.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

org.jasig.portlet.notice.rest.EntryDTO createNotification(org.jasig.portlet.notice.rest.EntryDTO notification)

Create a notification.

Parameters:

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

Returns:

the newly created Entry

getAddressees

java.util.Set<org.jasig.portlet.notice.rest.AddresseeDTO> getAddressees(long notificationId)

Get the List addressees for a notification.

Parameters:

notificationId - the notification id

Returns:

the set of notifications

getAddressee

org.jasig.portlet.notice.rest.AddresseeDTO getAddressee(long addresseeId)

Get a single addressee by id.

Parameters:

addresseeId - the addressee id

Returns:

the addressee if found, else null

createAddressee

org.jasig.portlet.notice.rest.AddresseeDTO createAddressee(long notificationId,
                                                           org.jasig.portlet.notice.rest.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

java.util.List<org.jasig.portlet.notice.rest.EventDTO> getEventsByNotification(long notificationId)

Get the list of events by notification.

Parameters:

notificationId - the notification id

Returns:

the list of events

getEventsByNotificationAndUser

java.util.List<org.jasig.portlet.notice.rest.EventDTO> getEventsByNotificationAndUser(long notificationId,
                                                                                      java.lang.String username)

Get the list of events by notification.

Parameters:

notificationId - the notification id

Returns:

the list of events

getEvent

org.jasig.portlet.notice.rest.EventDTO getEvent(long eventId)

Get a single event.

Parameters:

eventId - the event id

Returns:

the event if found, else null

createEvent

org.jasig.portlet.notice.rest.EventDTO createEvent(long notificationId,
                                                   org.jasig.portlet.notice.rest.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