org.kuali.kra.award.notification

Class AwardNotificationContext

java.lang.Object

org.kuali.kra.common.notification.NotificationContextBase

org.kuali.kra.award.notification.AwardNotificationContext

All Implemented Interfaces:

Serializable, NotificationContext

public class AwardNotificationContext
extends NotificationContextBase

This class extends the notification context base and provides some helpful functions for any Award specific events.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AwardNotificationContext(Award award, String actionTypeCode, String contextName)
AwardNotificationContext(Award award, String actionTypeCode, String contextName, NotificationRenderer renderer, String forwardName) Constructs an Award notification context and sets the necessary services.
AwardNotificationContext(Award award, String actionTypeCode, String contextName, String forwardName)

Method Summary

Methods

Modifier and Type	Method and Description
String	getActionTypeCode() Returns the action type code for this context.
Award	getAward()
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	getForwardName()
String	getModuleCode() Returns the associated module as defined in CoeusModule.
void	setAward(Award award)
void	setEmailAttachments(List<EmailAttachment> emailAttachments)
void	setForwardName(String forwardName)

Methods inherited from class org.kuali.kra.common.notification.NotificationContextBase

getNotificationModuleRoleService, getNotificationRoleQualifierService, getNotificationService, getRenderer, populateRoleQualifiers, replaceContextVariables, setNotificationModuleRoleService, setNotificationRoleQualifierService, setNotificationService, setRenderer

Methods inherited from class java.lang.Object

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

Constructor Detail

AwardNotificationContext

public AwardNotificationContext(Award award,
                        String actionTypeCode,
                        String contextName,
                        NotificationRenderer renderer,
                        String forwardName)

Constructs an Award notification context and sets the necessary services.

Parameters:

award -

actionTypeCode -

contextName -

renderer -

AwardNotificationContext

public AwardNotificationContext(Award award,
                        String actionTypeCode,
                        String contextName)

AwardNotificationContext

public AwardNotificationContext(Award award,
                        String actionTypeCode,
                        String contextName,
                        String forwardName)

Method Detail

getModuleCode

public String getModuleCode()

Returns the associated module as defined in CoeusModule.

Returns:

the Coeus module code

See Also:

NotificationContext.getModuleCode()

getDocumentNumber

public String getDocumentNumber()

Returns the document number for the associated document.

Returns:

the document number

See Also:

NotificationContext.getDocumentNumber()

getActionTypeCode

public String getActionTypeCode()

Returns the action type code for this context.

Returns:

the action type code

See Also:

NotificationContext.getActionTypeCode()

getContextName

public String getContextName()

Returns a the name used for the given context.

Returns:

the context name

See Also:

NotificationContext.getContextName()

getEmailAttachments

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

See Also:

NotificationContext.getEmailAttachments()

setEmailAttachments

public void setEmailAttachments(List<EmailAttachment> emailAttachments)

Parameters:

emailAttachments -

getAward

public Award getAward()

setAward

public void setAward(Award award)

getForwardName

public String getForwardName()

setForwardName

public void setForwardName(String forwardName)