org.kuali.rice.ken.deliverer
Interface NotificationMessageDeliverer

All Known Subinterfaces:

BulkNotificationMessageDeliverer

All Known Implementing Classes:

KEWActionListMessageDeliverer

public interface NotificationMessageDeliverer

This class represents the different types of Notification Delivery Types that the system can handle. For example, an instance of delivery type could be "ActionList" or "Email" or "SMS". Any deliverer implementation adhering to this interface can be plugged into the system and will be automatically available for use.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

void	autoRemoveMessageDelivery(NotificationMessageDelivery messageDelivery) This method handles auto removing a message delivery from a person's list of notifications.
void	deliverMessage(NotificationMessageDelivery messageDelivery) This method is responsible for delivering the passed in messageDelivery record.
void	dismissMessageDelivery(NotificationMessageDelivery messageDelivery, String user, String cause) This method dismisses/removes the NotificationMessageDelivery so that it is no longer being presented to the user via this deliverer.

Method Detail

deliverMessage

void deliverMessage(NotificationMessageDelivery messageDelivery)
                    throws NotificationMessageDeliveryException

This method is responsible for delivering the passed in messageDelivery record.

Parameters:

messageDelivery - The messageDelivery to process

Throws:

NotificationMessageDeliveryException

autoRemoveMessageDelivery

void autoRemoveMessageDelivery(NotificationMessageDelivery messageDelivery)
                               throws NotificationAutoRemoveException

This method handles auto removing a message delivery from a person's list of notifications.

Parameters:

messageDelivery - The messageDelivery to auto remove

Throws:

NotificationAutoRemoveException

dismissMessageDelivery

void dismissMessageDelivery(NotificationMessageDelivery messageDelivery,
                            String user,
                            String cause)
                            throws NotificationMessageDismissalException

This method dismisses/removes the NotificationMessageDelivery so that it is no longer being presented to the user via this deliverer. Note, whether this action is meaningful is dependent on the deliverer implementation. If the deliverer cannot control the presentation of the message, then this method need not do anything.

Parameters:

messageDelivery - the messageDelivery to dismiss

the - user that caused the dismissal; in the case of end-user actions, this will most likely be the user to which the message was delivered (user recipient in the NotificationMessageDelivery object)

cause - the reason the message was dismissed

Throws:

NotificationMessageDismissalException