org.kuali.kra.common.notification.web.struts.form

Class NotificationHelper<T extends NotificationContext>

java.lang.Object

org.kuali.kra.common.notification.web.struts.form.NotificationHelper<T>

Type Parameters:

T - the notification context

All Implemented Interfaces:

Serializable

public class NotificationHelper<T extends NotificationContext>
extends Object
implements Serializable

Defines the base helper for sending ad-hoc notifications.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NotificationHelper() Constructs a NotificationHelperBase.

Method Summary

Methods

Modifier and Type	Method and Description
KcPersonService	getKcPersonService()
NotificationTypeRecipient	getNewNotificationRecipient()
String	getNewPersonId()
String	getNewRoleId()
String	getNewRolodexId()
KcNotification	getNotification()
T	getNotificationContext()
List<NotificationTypeRecipient>	getNotificationRecipients()
KcNotificationService	getNotificationService()
boolean	getPromptUserForNotificationEditor(T context) Determines whether the ad-hoc notification editor for this context should be shown.
org.kuali.rice.kim.api.role.RoleService	getRoleService()
RolodexService	getRolodexService()
void	initializeDefaultValues(T context) Initializes the helper with the default values from the Notification Type.
void	prepareView() Prepares the user view from the context.
void	sendNotification() Sends the ad-hoc notification.
void	sendNotificationAndPersist(KcNotification notification, KraPersistableBusinessObjectBase object)
void	setKcPersonService(KcPersonService kcPersonService)
void	setNewNotificationRecipient(NotificationTypeRecipient newNotificationRecipient)
void	setNewPersonId(String newPersonId) Sets the newPersonId while nulling the other id values.
void	setNewRoleId(String newRoleId) Sets the newRoleId while nulling the other id values.
void	setNewRolodexId(String newRolodexId) Sets the newRolodexId while nulling the other id values.
void	setNotification(KcNotification notification)
void	setNotificationContext(T notificationContext)
void	setNotificationRecipients(List<NotificationTypeRecipient> notificationRecipients)
void	setNotificationService(KcNotificationService notificationService)
void	setRoleService(org.kuali.rice.kim.api.role.RoleService roleService)
void	setRolodexService(RolodexService rolodexService)

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationHelper

public NotificationHelper()

Constructs a NotificationHelperBase.

Method Detail

getNewNotificationRecipient

public NotificationTypeRecipient getNewNotificationRecipient()

setNewNotificationRecipient

public void setNewNotificationRecipient(NotificationTypeRecipient newNotificationRecipient)

getNotificationRecipients

public List<NotificationTypeRecipient> getNotificationRecipients()

setNotificationRecipients

public void setNotificationRecipients(List<NotificationTypeRecipient> notificationRecipients)

getNotification

public KcNotification getNotification()

setNotification

public void setNotification(KcNotification notification)

getNotificationContext

public T getNotificationContext()

setNotificationContext

public void setNotificationContext(T notificationContext)

getNewRoleId

public String getNewRoleId()

setNewRoleId

public void setNewRoleId(String newRoleId)

Sets the newRoleId while nulling the other id values.

Parameters:

newRoleId - the new role id

getNewPersonId

public String getNewPersonId()

setNewPersonId

public void setNewPersonId(String newPersonId)

Sets the newPersonId while nulling the other id values.

Parameters:

newPersonId - the new person id

getNewRolodexId

public String getNewRolodexId()

setNewRolodexId

public void setNewRolodexId(String newRolodexId)

Sets the newRolodexId while nulling the other id values.

Parameters:

newRolodexId - the new rolodex id

initializeDefaultValues

public void initializeDefaultValues(T context)

Initializes the helper with the default values from the Notification Type.

Parameters:

context - the notification context

prepareView

public void prepareView()

Prepares the user view from the context.

getPromptUserForNotificationEditor

public boolean getPromptUserForNotificationEditor(T context)

Determines whether the ad-hoc notification editor for this context should be shown.

Parameters:

context - the notification context

Returns:

true if the ad-hoc notification editor should be shown, false otherwise

sendNotification

public void sendNotification()

Sends the ad-hoc notification.

sendNotificationAndPersist

public void sendNotificationAndPersist(KcNotification notification,
                              KraPersistableBusinessObjectBase object)

getNotificationService

public KcNotificationService getNotificationService()

setNotificationService

public void setNotificationService(KcNotificationService notificationService)

getKcPersonService

public KcPersonService getKcPersonService()

setKcPersonService

public void setKcPersonService(KcPersonService kcPersonService)

getRolodexService

public RolodexService getRolodexService()

setRolodexService

public void setRolodexService(RolodexService rolodexService)

getRoleService

public org.kuali.rice.kim.api.role.RoleService getRoleService()

setRoleService

public void setRoleService(org.kuali.rice.kim.api.role.RoleService roleService)