org.kuali.rice.kew.mail.service.impl

Class ActionListEmailServiceImpl

java.lang.Object

org.kuali.rice.kew.mail.service.impl.ActionListEmailServiceImpl

All Implemented Interfaces:

ActionListEmailService

Direct Known Subclasses:

CustomizableActionListEmailServiceImpl

public class ActionListEmailServiceImpl
extends Object
implements ActionListEmailService

ActionListeEmailService which generates messages whose body and subject can be customized via KEW configuration parameters, 'immediate.reminder.email.message' and 'immediate.reminder.email.subject'. The immediate reminder email message key should specify a MessageFormat string. See code for the parameters to this MessageFormat.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Constructor Summary

Constructors

Constructor and Description
ActionListEmailServiceImpl()

Method Summary

Modifier and Type	Method and Description
String	buildDailyReminderBody(Collection<ActionItem> actionItems)
String	buildImmediateReminderBody(org.kuali.rice.kim.api.identity.Person person, ActionItem actionItem, DocumentType documentType)
String	buildWeeklyReminderBody(Collection<ActionItem> actionItems)
protected boolean	checkEmailNotificationPreferences(ActionItemContract actionItem, Preferences preferences, String emailSetting) This method takes in a type of email which is being sent, an action item which is being checked and a user's preferences and it checks to see if the action item should be included in the given kind of email based on the user's preferences.
protected Collection<ActionItem>	filterActionItemsToNotify(String principalId, Collection<ActionItem> actionItems, String emailSetting) Returns a filtered Collection of ActionItems which are filtered according to the user's preferences.
protected ActionListService	getActionListService()
protected String	getActionListUrl()
String	getApplicationEmailAddress()
String	getDeploymentEnvironment()
String	getDocumentTypeEmailAddress(DocumentType documentType)
protected EmailFrom	getEmailFrom(DocumentType documentType)
EmailSubject	getEmailSubject()
EmailSubject	getEmailSubject(String customSubject)
protected EmailTo	getEmailTo(org.kuali.rice.kim.api.identity.Person user)
protected String	getHelpLink()
protected String	getHelpLink(DocumentType documentType)
protected String	getPreferencesUrl()
protected Collection<String>	getUsersWithEmailSetting(String setting)
protected boolean	isProduction()
void	scheduleBatchEmailReminders()
protected boolean	sendActionListEmailNotification()
void	sendDailyReminder()
protected void	sendEmail(org.kuali.rice.kim.api.identity.Person user, EmailSubject subject, EmailBody body)
protected void	sendEmail(org.kuali.rice.kim.api.identity.Person user, EmailSubject subject, EmailBody body, DocumentType documentType)
void	sendImmediateReminder(ActionItem actionItem, Boolean skipOnApprovals)
protected void	sendPeriodicReminder(String principalId, Collection<ActionItem> actionItems, String emailSetting)
void	sendWeeklyReminder()
void	setDeploymentEnvironment(String deploymentEnvironment)
void	setMailer(Mailer mailer)

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionListEmailServiceImpl

public ActionListEmailServiceImpl()

Method Detail

setMailer

public void setMailer(Mailer mailer)

getDocumentTypeEmailAddress

public String getDocumentTypeEmailAddress(DocumentType documentType)

getApplicationEmailAddress

public String getApplicationEmailAddress()

getHelpLink

protected String getHelpLink()

getHelpLink

protected String getHelpLink(DocumentType documentType)

getEmailSubject

public EmailSubject getEmailSubject()

getEmailSubject

public EmailSubject getEmailSubject(String customSubject)

getEmailFrom

protected EmailFrom getEmailFrom(DocumentType documentType)

getEmailTo

protected EmailTo getEmailTo(org.kuali.rice.kim.api.identity.Person user)

sendEmail

protected void sendEmail(org.kuali.rice.kim.api.identity.Person user,
                         EmailSubject subject,
                         EmailBody body)

sendEmail

protected void sendEmail(org.kuali.rice.kim.api.identity.Person user,
                         EmailSubject subject,
                         EmailBody body,
                         DocumentType documentType)

checkEmailNotificationPreferences

protected boolean checkEmailNotificationPreferences(ActionItemContract actionItem,
                                                    Preferences preferences,
                                                    String emailSetting)

This method takes in a type of email which is being sent, an action item which is being checked and a user's preferences and it checks to see if the action item should be included in the given kind of email based on the user's preferences.

Parameters:

actionItem -

preferences -

emailSetting -

Returns:

sendImmediateReminder

public void sendImmediateReminder(ActionItem actionItem,
                                  Boolean skipOnApprovals)

Specified by:

sendImmediateReminder in interface ActionListEmailService

isProduction

protected boolean isProduction()

sendDailyReminder

public void sendDailyReminder()

Specified by:

sendDailyReminder in interface ActionListEmailService

sendWeeklyReminder

public void sendWeeklyReminder()

Specified by:

sendWeeklyReminder in interface ActionListEmailService

sendPeriodicReminder

protected void sendPeriodicReminder(String principalId,
                                    Collection<ActionItem> actionItems,
                                    String emailSetting)

filterActionItemsToNotify

protected Collection<ActionItem> filterActionItemsToNotify(String principalId,
                                                           Collection<ActionItem> actionItems,
                                                           String emailSetting)

Returns a filtered Collection of ActionItems which are filtered according to the user's preferences. If they have opted not to recieve secondary or primary delegation emails then they will not be included.

getUsersWithEmailSetting

protected Collection<String> getUsersWithEmailSetting(String setting)

buildImmediateReminderBody

public String buildImmediateReminderBody(org.kuali.rice.kim.api.identity.Person person,
                                         ActionItem actionItem,
                                         DocumentType documentType)

buildDailyReminderBody

public String buildDailyReminderBody(Collection<ActionItem> actionItems)

buildWeeklyReminderBody

public String buildWeeklyReminderBody(Collection<ActionItem> actionItems)

sendActionListEmailNotification

protected boolean sendActionListEmailNotification()

scheduleBatchEmailReminders

public void scheduleBatchEmailReminders()
                                 throws Exception

Specified by:

scheduleBatchEmailReminders in interface ActionListEmailService

Throws:

Exception

getActionListService

protected ActionListService getActionListService()

getDeploymentEnvironment

public String getDeploymentEnvironment()

setDeploymentEnvironment

public void setDeploymentEnvironment(String deploymentEnvironment)

getActionListUrl

protected String getActionListUrl()

getPreferencesUrl

protected String getPreferencesUrl()