org.kuali.kra.protocol.notification

Class ProtocolNotificationContextBase

java.lang.Object

org.kuali.kra.common.notification.NotificationContextBase

org.kuali.kra.protocol.notification.ProtocolNotificationContextBase

All Implemented Interfaces:

Serializable, NotificationContext

Direct Known Subclasses:

IacucProtocolNotificationContext, IRBNotificationContext

public abstract class ProtocolNotificationContextBase
extends NotificationContextBase

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProtocolNotificationContextBase(ProtocolBase protocol, ProtocolOnlineReviewBase protocolOnlineReview, String actionTypeCode, String contextName, NotificationRenderer renderer) Constructs a protocol notification context and sets the necessary services.
ProtocolNotificationContextBase(ProtocolBase protocol, String actionTypeCode, String contextName, NotificationRenderer renderer) Constructs an IRB notification context and sets the necessary services.

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	getForwardName()
boolean	isPopulateRole()
void	populateRoleQualifiers(NotificationTypeRecipient notificationRecipient) This is a hook/hack for assign reviewer/submit for review, which has potential of multiple reviewers reviewers are supposed to be processed separately, but for 'prompt user', it merged into one prompt.
void	setEmailAttachments(List<EmailAttachment> emailAttachments) This method sets a list of email attachments
void	setForwardName(String forwardName)
void	setPopulateRole(boolean populateRole)

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

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

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

getModuleCode

Constructor Detail

ProtocolNotificationContextBase

public ProtocolNotificationContextBase(ProtocolBase protocol,
                               ProtocolOnlineReviewBase protocolOnlineReview,
                               String actionTypeCode,
                               String contextName,
                               NotificationRenderer renderer)

Constructs a protocol notification context and sets the necessary services.

Parameters:

protocol -

protocolOnlineReview -

actionTypeCode -

contextName -

ProtocolNotificationContextBase

public ProtocolNotificationContextBase(ProtocolBase protocol,
                               String actionTypeCode,
                               String contextName,
                               NotificationRenderer renderer)

Constructs an IRB notification context and sets the necessary services.

Parameters:

protocol -

actionTypeCode -

contextName -

Method Detail

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()

Description copied from interface: NotificationContext

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)

This method sets a list of email attachments

Parameters:

emailAttachments -

getForwardName

public String getForwardName()

setForwardName

public void setForwardName(String forwardName)

isPopulateRole

public boolean isPopulateRole()

setPopulateRole

public void setPopulateRole(boolean populateRole)

populateRoleQualifiers

public void populateRoleQualifiers(NotificationTypeRecipient notificationRecipient)
                            throws UnknownRoleException

This is a hook/hack for assign reviewer/submit for review, which has potential of multiple reviewers reviewers are supposed to be processed separately, but for 'prompt user', it merged into one prompt. 'reviewer role' are the same, but the role qualifiers' are different which is based on context. the role qualifier are populated when we merge all recipients in to one list. So, when sendnotification, it is just using the last 'context', so at this point, we don't want rolequalifiers being populated again. If it is populated again, all reviewer role will retrieve same reviewer because the context are the same at the point of 'send'. Unless, there is better approach, we'll stick with this hack for now. isPopulateRole is only 'true' for this case, so the other cases will stay the same as before this change.

Specified by:

populateRoleQualifiers in interface NotificationContext

Overrides:

populateRoleQualifiers in class NotificationContextBase

Parameters:

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

Throws:

UnknownRoleException - if the role is unknown for this context.

See Also:

NotificationContextBase.populateRoleQualifiers(org.kuali.kra.common.notification.bo.NotificationTypeRecipient)