org.kuali.kra.common.notification

Interface NotificationContext

All Known Implementing Classes:

AwardNotificationContext, CoiNotificationContext, CommitteeNotificationContext, CommitteeNotificationContext, IacucProtocolNotificationContext, InstitutionalProposalNotificationContext, IRBNotificationContext, NegotiationCloseNotificationContext, NotificationContextBase, ProposalDevelopmentNotificationContext, ProtocolNotificationContextBase, SubAwardNotificationContext

public interface NotificationContext

A context from which a Notification is sent. Contains instance-specific information needed to process and send the Notification.

Method Summary

Methods

Modifier and Type	Method and Description
String	getActionTypeCode() Returns the action type code for this context.
String	getContextName() Returns a the name used for the given context.
String	getDocumentNumber() Returns the document number for the associated document.
List<EmailAttachment>	getEmailAttachments() This method provides support for email attachments for email notifications.
String	getModuleCode() Returns the associated module as defined in CoeusModule.
void	populateRoleQualifiers(NotificationTypeRecipient notificationRecipient) Populate context-specific role qualifier values on role-based recipients.
String	replaceContextVariables(String text) Replace context-specific variables in the message or subject.

Method Detail

getModuleCode

String getModuleCode()

Returns the associated module as defined in CoeusModule.

Returns:

the Coeus module code

See Also:

CoeusModule

getActionTypeCode

String getActionTypeCode()

Returns the action type code for this context.

Returns:

the action type code

getDocumentNumber

String getDocumentNumber()

Returns the document number for the associated document.

Returns:

the document number

getContextName

String getContextName()

Returns a the name used for the given context.

Returns:

the context name

replaceContextVariables

String replaceContextVariables(String text)

Replace context-specific variables in the message or subject. E.G., {DOCUMENT_NUMBER} -> 1234567.

Parameters:

text - The text to process.

Returns:

The new text with context variables replaced.

populateRoleQualifiers

void populateRoleQualifiers(NotificationTypeRecipient notificationRecipient)
                            throws UnknownRoleException

Populate context-specific role qualifier values on role-based recipients. For example many roles are qualified by Document Number.

Parameters:

notificationRecipient -

Throws:

UnknownRoleException - if the role is unknown for this context.

getEmailAttachments

List<EmailAttachment> getEmailAttachments()

This method provides support for email attachments for email notifications.

Returns:

a list of email attachments or null if none are available.