org.kuali.kra.committee.notification

Class CommitteeNotificationContext

java.lang.Object

org.kuali.kra.common.notification.NotificationContextBase

org.kuali.kra.committee.notification.CommitteeNotificationContext

All Implemented Interfaces:

Serializable, NotificationContext

public class CommitteeNotificationContext
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
CommitteeNotificationContext(CommitteeSchedule committeeSchedule, String actionTypeCode, String contextName, NotificationRenderer renderer) Constructs a Committee 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.
CommitteeNotificationRoleQualifierService	getCommitteeNotificationRoleQualifierService()
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) 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	setCommitteeNotificationRoleQualifierService(CommitteeNotificationRoleQualifierService committeeNotificationRoleQualifierService)

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

Constructor Detail

CommitteeNotificationContext

public CommitteeNotificationContext(CommitteeSchedule committeeSchedule,
                            String actionTypeCode,
                            String contextName,
                            NotificationRenderer renderer)

Constructs a Committee notification context and sets the necessary services.

Parameters:

protocol -

actionTypeCode -

contextName -

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

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)

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.

getCommitteeNotificationRoleQualifierService

public CommitteeNotificationRoleQualifierService getCommitteeNotificationRoleQualifierService()

setCommitteeNotificationRoleQualifierService

public void setCommitteeNotificationRoleQualifierService(CommitteeNotificationRoleQualifierService committeeNotificationRoleQualifierService)