org.kuali.kra.common.notification.service.impl

Class KcNotificationServiceImpl

java.lang.Object

org.kuali.kra.common.notification.service.impl.KcNotificationServiceImpl

All Implemented Interfaces:

KcNotificationService

public class KcNotificationServiceImpl
extends Object
implements KcNotificationService

Defines methods for creating and sending KC Notifications.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.kuali.rice.ken.api.notification.NotificationChannel	kcNotificationChannel
protected org.kuali.rice.ken.api.notification.NotificationProducer	systemNotificationProducer

Constructor Summary

Constructors

Constructor and Description
KcNotificationServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
KcNotification	copy(KcNotification oldNotification) Make a copy of an existing notification
KcNotification	createNotificationObject(NotificationContext context) Creates a KC Notification based on the Notification Context.
org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
org.kuali.rice.kim.api.identity.IdentityService	getIdentityService()
KcEmailService	getKcEmailService()
KcPersonService	getKcPersonService()
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 actionTypeCode) Returns the Notification Type based on a Module Code and Action Code.
org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService()
org.kuali.rice.kim.api.role.RoleService	getRoleManagementService()
RolodexService	getRolodexService()
org.kuali.rice.ken.api.service.SendNotificationService	getSendNotificationService()
void	saveNotification(KcNotification notification) Saves a KC Notifications.
void	sendEmailNotification(NotificationContext context) Send an unedited KC Notification Email, using the context to populate context-specific role qualifiers within the Role-based Recipients.
void	sendNotification(NotificationContext context) Send an unedited KC Notification, using the context to populate context-specific role qualifiers within the Role-based Recipients.
void	sendNotification(NotificationContext context, KcNotification notification, List<NotificationTypeRecipient> notificationTypeRecipients) 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)
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)
void	setIdentityService(org.kuali.rice.kim.api.identity.IdentityService identityService)
void	setKcEmailService(KcEmailService kcEmailService)
void	setKcPersonService(KcPersonService kcPersonService)
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)
void	setRoleManagementService(org.kuali.rice.kim.api.role.RoleService roleManagementService)
void	setRolodexService(RolodexService rolodexService)
void	setSendNotificationService(org.kuali.rice.ken.api.service.SendNotificationService sendNotificationService)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

kcNotificationChannel

protected org.kuali.rice.ken.api.notification.NotificationChannel kcNotificationChannel

systemNotificationProducer

protected org.kuali.rice.ken.api.notification.NotificationProducer systemNotificationProducer

Constructor Detail

KcNotificationServiceImpl

public KcNotificationServiceImpl()

Method Detail

getNotificationType

public NotificationType getNotificationType(NotificationContext context)

Returns the Notification Type based on a Notification Context.

Specified by:

getNotificationType in interface KcNotificationService

Returns:

The Notification Type

See Also:

KcNotificationService.getNotificationType(org.kuali.kra.common.notification.NotificationContext)

getNotificationType

public NotificationType getNotificationType(String moduleCode,
                                   String actionTypeCode)

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

Specified by:

getNotificationType in interface KcNotificationService

Returns:

The Notification Type

See Also:

KcNotificationService.getNotificationType(java.lang.String, java.lang.String)

createNotificationObject

public KcNotification createNotificationObject(NotificationContext context)

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.

Specified by:

createNotificationObject in interface KcNotificationService

Returns:

The KC Notification

See Also:

KcNotificationService.createNotificationObject(org.kuali.kra.common.notification.NotificationContext)

saveNotification

public void saveNotification(KcNotification notification)

Saves a KC Notifications.

Specified by:

saveNotification in interface KcNotificationService

See Also:

KcNotificationService.saveNotification(org.kuali.kra.common.notification.bo.KcNotification)

getNotifications

public 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.

Specified by:

getNotifications in interface KcNotificationService

Returns:

The list of KC Notifications

See Also:

KcNotificationService.getNotifications(java.lang.String, java.lang.String, java.util.Set)

sendNotification

public void sendNotification(NotificationContext context)

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

Specified by:

sendNotification in interface KcNotificationService

See Also:

org.kuali.kra.common.notification.service.KcNotificationService#sendNotification(org.kuali.kra.common.notification.bo.KcNotification, org.kuali.kra.common.notification.NotificationContext)

sendNotification

public void sendNotification(NotificationContext context,
                    KcNotification notification,
                    List<NotificationTypeRecipient> notificationTypeRecipients)

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.

Specified by:

sendNotification in interface KcNotificationService

See Also:

KcNotificationService.sendNotification(org.kuali.kra.common.notification.NotificationContext, org.kuali.kra.common.notification.bo.KcNotification, java.util.List)

sendNotification

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

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

Specified by:

sendNotification in interface KcNotificationService

See Also:

KcNotificationService.sendNotification(java.lang.String, java.lang.String, java.lang.String, java.util.List)

sendEmailNotification

public void sendEmailNotification(NotificationContext context)

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

Specified by:

sendEmailNotification in interface KcNotificationService

See Also:

KcNotificationService.sendEmailNotification(org.kuali.kra.common.notification.NotificationContext)

sendNotification

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

Description copied from interface: KcNotificationService

Send a notification to the specified recipients.

Specified by:

sendNotification in interface KcNotificationService

getNotificationRecipients

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

Description copied from interface: KcNotificationService

Return the notification recipients for this notification context.

Specified by:

getNotificationRecipients in interface KcNotificationService

Returns:

sendNotificationAndPersist

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

Description copied from interface: KcNotificationService

Sends notification, completes notification object, and persists it.

Specified by:

sendNotificationAndPersist in interface KcNotificationService

sendNotificationAndPersist

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

Specified by:

sendNotificationAndPersist in interface KcNotificationService

getBusinessObjectService

public org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)

getSendNotificationService

public org.kuali.rice.ken.api.service.SendNotificationService getSendNotificationService()

setSendNotificationService

public void setSendNotificationService(org.kuali.rice.ken.api.service.SendNotificationService sendNotificationService)

getRoleManagementService

public org.kuali.rice.kim.api.role.RoleService getRoleManagementService()

setRoleManagementService

public void setRoleManagementService(org.kuali.rice.kim.api.role.RoleService roleManagementService)

getKcPersonService

public KcPersonService getKcPersonService()

setKcPersonService

public void setKcPersonService(KcPersonService kcPersonService)

getRolodexService

public RolodexService getRolodexService()

setRolodexService

public void setRolodexService(RolodexService rolodexService)

getParameterService

public org.kuali.rice.coreservice.framework.parameter.ParameterService getParameterService()

setParameterService

public void setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)

getIdentityService

public org.kuali.rice.kim.api.identity.IdentityService getIdentityService()

setIdentityService

public void setIdentityService(org.kuali.rice.kim.api.identity.IdentityService identityService)

getKcEmailService

public KcEmailService getKcEmailService()

setKcEmailService

public void setKcEmailService(KcEmailService kcEmailService)

copy

public KcNotification copy(KcNotification oldNotification)

Description copied from interface: KcNotificationService

Make a copy of an existing notification

Specified by:

copy in interface KcNotificationService