org.kuali.kra.common.notification

Class NotificationContextBase

java.lang.Object

org.kuali.kra.common.notification.NotificationContextBase

All Implemented Interfaces:

Serializable, NotificationContext

Direct Known Subclasses:

AwardNotificationContext, CoiNotificationContext, CommitteeNotificationContext, CommitteeNotificationContext, InstitutionalProposalNotificationContext, NegotiationCloseNotificationContext, ProposalDevelopmentNotificationContext, ProtocolNotificationContextBase, SubAwardNotificationContext

public abstract class NotificationContextBase
extends Object
implements NotificationContext, Serializable

Provides a base class for all notifications to extend. It defines a holding place for the required services as well as a few methods that should be implemented by any notification.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NotificationContextBase(NotificationRenderer renderer) Constructs a Notification Context base class.

Method Summary

Methods

Modifier and Type	Method and Description
KcNotificationModuleRoleService	getNotificationModuleRoleService()
KcNotificationRoleQualifierService	getNotificationRoleQualifierService()
KcNotificationService	getNotificationService()
NotificationRenderer	getRenderer()
void	populateRoleQualifiers(NotificationTypeRecipient notificationRecipient) This method populates the role qualifiers for use in KIM lookups by finding the associated notification module roles and using the role qualifier service to find the values.
String	replaceContextVariables(String text) This method replaces the context variables using the default parameters.
void	setNotificationModuleRoleService(KcNotificationModuleRoleService notificationModuleRoleService)
void	setNotificationRoleQualifierService(KcNotificationRoleQualifierService notificationRoleQualifierService)
void	setNotificationService(KcNotificationService notificationService)
void	setRenderer(NotificationRenderer renderer)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.kra.common.notification.NotificationContext

getActionTypeCode, getContextName, getDocumentNumber, getEmailAttachments, getModuleCode

Constructor Detail

NotificationContextBase

public NotificationContextBase(NotificationRenderer renderer)

Constructs a Notification Context base class.

Parameters:

renderer - the text renderer for this context

Method Detail

replaceContextVariables

public String replaceContextVariables(String text)

This method replaces the context variables using the default parameters.

Specified by:

replaceContextVariables in interface NotificationContext

Parameters:

text - The text to process.

Returns:

The new text with context variables replaced.

See Also:

NotificationContext.replaceContextVariables(java.lang.String)

populateRoleQualifiers

public void populateRoleQualifiers(NotificationTypeRecipient notificationRecipient)
                            throws UnknownRoleException

This method populates the role qualifiers for use in KIM lookups by finding the associated notification module roles and using the role qualifier service to find the values.

Specified by:

populateRoleQualifiers in interface NotificationContext

Parameters:

notificationRecipient - The recipient of the notification, it represents a KIM role

Throws:

UnknownRoleException

getNotificationService

public KcNotificationService getNotificationService()

setNotificationService

public void setNotificationService(KcNotificationService notificationService)

getNotificationModuleRoleService

public KcNotificationModuleRoleService getNotificationModuleRoleService()

setNotificationModuleRoleService

public void setNotificationModuleRoleService(KcNotificationModuleRoleService notificationModuleRoleService)

getNotificationRoleQualifierService

public KcNotificationRoleQualifierService getNotificationRoleQualifierService()

setNotificationRoleQualifierService

public void setNotificationRoleQualifierService(KcNotificationRoleQualifierService notificationRoleQualifierService)

getRenderer

public NotificationRenderer getRenderer()

setRenderer

public void setRenderer(NotificationRenderer renderer)