org.jasig.portlet.notice.service.jpa

Class JpaNotificationRESTService

java.lang.Object

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

All Implemented Interfaces:

IJpaNotificationRESTService

@Service(value="jpaNotificationRestService")
public class JpaNotificationRESTService
extends java.lang.Object
implements IJpaNotificationRESTService

Allows you to interact with the same data as JpaNotificationService but provides write operations.

Since:

3.0

Constructor Summary

Constructors

Constructor and Description
JpaNotificationRESTService()

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 entry) 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) Provides a complete transaction log for a notification and a single recipient in chronological order.
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.

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

getNotification

@Transactional(readOnly=true)
public org.jasig.portlet.notice.rest.EntryDTO getNotification(long id,
                                                                                            boolean full)

Description copied from interface: IJpaNotificationRESTService

Get an EntryDTO by id.

Specified by:

getNotification in interface IJpaNotificationRESTService

getNotification

@Transactional(readOnly=true)
public org.jasig.portlet.notice.rest.EntryDTO getNotification(org.jasig.portlet.notice.NotificationEntry entry,
                                                                                            boolean full)

Description copied from interface: IJpaNotificationRESTService

Get an EntryDTO for a NotificationEntry, if applicable.

Specified by:

getNotification in interface IJpaNotificationRESTService

getNotifications

@Transactional(readOnly=true)
public java.util.List<org.jasig.portlet.notice.rest.EntryDTO> getNotifications(java.lang.Integer page,
                                                                                                             java.lang.Integer pageSize)

Description copied from interface: IJpaNotificationRESTService

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

Specified by:

getNotifications in interface IJpaNotificationRESTService

Parameters:

page - 0 based page #

pageSize - page size

Returns:

the list of entries.

getNotificationsBySourceAndCustomAttribute

@Transactional(readOnly=true)
public java.util.List<org.jasig.portlet.notice.rest.EntryDTO> getNotificationsBySourceAndCustomAttribute(java.lang.String source,
                                                                                                                                       java.lang.String attributeName,
                                                                                                                                       java.lang.String attributeValue)

Description copied from interface: IJpaNotificationRESTService

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.

Specified by:

getNotificationsBySourceAndCustomAttribute in interface IJpaNotificationRESTService

createNotification

@Transactional
public org.jasig.portlet.notice.rest.EntryDTO createNotification(org.jasig.portlet.notice.rest.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 java.util.Set<org.jasig.portlet.notice.rest.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 org.jasig.portlet.notice.rest.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 org.jasig.portlet.notice.rest.AddresseeDTO createAddressee(long notificationId,
                                                                                 org.jasig.portlet.notice.rest.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 java.util.List<org.jasig.portlet.notice.rest.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

getEventsByNotificationAndUser

@Transactional(readOnly=true)
public java.util.List<org.jasig.portlet.notice.rest.EventDTO> getEventsByNotificationAndUser(long notificationId,
                                                                                                                           java.lang.String username)

Provides a complete transaction log for a notification and a single recipient in chronological order.

Specified by:

getEventsByNotificationAndUser in interface IJpaNotificationRESTService

Parameters:

notificationId - the notification id

Returns:

the list of events

getEvent

@Transactional(readOnly=true)
public org.jasig.portlet.notice.rest.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 org.jasig.portlet.notice.rest.EventDTO createEvent(long notificationId,
                                                                         org.jasig.portlet.notice.rest.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