org.kuali.kra.common.notification.service

Interface KcNotificationService

All Known Implementing Classes:

KcNotificationServiceImpl

public interface KcNotificationService

Defines methods for creating and sending KC Notifications.

Method Summary

Methods

Modifier and Type	Method and Description
KcNotification	copy(KcNotification oldNotification) Make a copy of an existing notification
KcNotification	createNotificationObject(NotificationContext notificationContext) Creates a KC Notification based on the Notification Context.
Set<org.kuali.rice.ken.api.notification.NotificationRecipient.Builder>	getNotificationRecipients(NotificationContext context) Return the notification recipients for this notification context.
List<KcNotification>	getNotifications(String documentNumber, String moduleCode, Set<String> actionCodes) Retrieves a list of KC Notifications based on a Document Number, a Module Code, and a set of Action Codes.
NotificationType	getNotificationType(NotificationContext context) Returns the Notification Type based on a Notification Context.
NotificationType	getNotificationType(String moduleCode, String actionCode) Returns the Notification Type based on a Module Code and Action Code.
void	saveNotification(KcNotification notification) Saves a KC Notifications.
void	sendEmailNotification(NotificationContext notificationContext) Send an unedited KC Notification Email, using the context to populate context-specific role qualifiers within the Role-based Recipients.
void	sendNotification(NotificationContext notificationContext) Send an unedited KC Notification, using the context to populate context-specific role qualifiers within the Role-based Recipients.
void	sendNotification(NotificationContext notificationContext, KcNotification notification, List<NotificationTypeRecipient> notificationRecipients) Send a previously saved or edited KC Notification, using the context to populate context-specific role qualifiers within the Role-based Recipients and additionally sending the notification to other non-role users.
void	sendNotification(String contextName, String subject, String message, Collection<org.kuali.rice.ken.api.notification.NotificationRecipient.Builder> notificationRecipients) Send a notification to the specified recipients.
void	sendNotification(String contextName, String subject, String message, List<String> principalNames) Send an unedited KC Notification to principalNames using the given subject and message.
void	sendNotificationAndPersist(NotificationContext context, KcNotification notification, KraPersistableBusinessObjectBase object) Sends notification, completes notification object, and persists it.
void	sendNotificationAndPersist(NotificationContext context, KcNotification notification, List<NotificationTypeRecipient> notificationTypeRecipients, KraPersistableBusinessObjectBase object)

Method Detail

getNotificationType

NotificationType getNotificationType(NotificationContext context)

Returns the Notification Type based on a Notification Context.

Parameters:

context -

Returns:

The Notification Type

getNotificationType

NotificationType getNotificationType(String moduleCode,
                                   String actionCode)

Returns the Notification Type based on a Module Code and Action Code.

Parameters:

moduleCode -

actionCode -

Returns:

The Notification Type

createNotificationObject

KcNotification createNotificationObject(NotificationContext notificationContext)

Creates a KC Notification based on the Notification Context. The Notification Type associated with the Module Code and Action Code is retrieved from persistent storage and translated into a context-specific KC Notification instance based on the Notification Context.

Parameters:

notificationContext -

Returns:

The KC Notification

saveNotification

void saveNotification(KcNotification notification)

Saves a KC Notifications.

Parameters:

notification -

sendNotificationAndPersist

void sendNotificationAndPersist(NotificationContext context,
                              KcNotification notification,
                              KraPersistableBusinessObjectBase object)

Sends notification, completes notification object, and persists it.

Parameters:

notificationContext -

sendNotificationAndPersist

void sendNotificationAndPersist(NotificationContext context,
                              KcNotification notification,
                              List<NotificationTypeRecipient> notificationTypeRecipients,
                              KraPersistableBusinessObjectBase object)

getNotifications

List<KcNotification> getNotifications(String documentNumber,
                                    String moduleCode,
                                    Set<String> actionCodes)

Retrieves a list of KC Notifications based on a Document Number, a Module Code, and a set of Action Codes.

Parameters:

documentNumber -

moduleCode -

actionCodes -

Returns:

The list of KC Notifications

sendNotification

void sendNotification(NotificationContext notificationContext)

Send an unedited KC Notification, using the context to populate context-specific role qualifiers within the Role-based Recipients.

Parameters:

notificationContext -

sendNotification

void sendNotification(NotificationContext notificationContext,
                    KcNotification notification,
                    List<NotificationTypeRecipient> notificationRecipients)

Send a previously saved or edited KC Notification, using the context to populate context-specific role qualifiers within the Role-based Recipients and additionally sending the notification to other non-role users.

Parameters:

notificationContext -

notification -

notificationRecipients -

sendNotification

void sendNotification(String contextName,
                    String subject,
                    String message,
                    List<String> principalNames)

Send an unedited KC Notification to principalNames using the given subject and message.

Parameters:

contextName -

subject -

message -

principalNames -

sendEmailNotification

void sendEmailNotification(NotificationContext notificationContext)

Send an unedited KC Notification Email, using the context to populate context-specific role qualifiers within the Role-based Recipients.

Parameters:

notificationContext -

getNotificationRecipients

Set<org.kuali.rice.ken.api.notification.NotificationRecipient.Builder> getNotificationRecipients(NotificationContext context)

Return the notification recipients for this notification context.

Parameters:

context -

Returns:

sendNotification

void sendNotification(String contextName,
                    String subject,
                    String message,
                    Collection<org.kuali.rice.ken.api.notification.NotificationRecipient.Builder> notificationRecipients)

Send a notification to the specified recipients.

Parameters:

contextName -

subject -

message -

notificationRecipients -

copy

KcNotification copy(KcNotification oldNotification)

Make a copy of an existing notification

Parameters:

notification -