org.kuali.kfs.pdp.service
Interface PdpEmailService

All Known Implementing Classes:

PdpEmailServiceImpl

public interface PdpEmailService

Defines methods for sending PDP emails.

Method Summary

boolean	isPaymentEmailEnabled() Reads system parameter indicating whether to status emails should be sent
void	sendAchAdviceEmail(PaymentGroup paymentGroup, PaymentDetail paymentDetail, CustomerProfile customer) Sends advice notification email to the payee receiving an ACH payment
void	sendAchSummaryEmail(Map<String,Integer> unitCounts, Map<String,org.kuali.rice.kns.util.KualiDecimal> unitTotals, Date extractDate) Sends summary email for an ACH extract
void	sendCancelEmail(PaymentGroup paymentGroup, String note, org.kuali.rice.kim.bo.Person user) Sends Payment Cancellation Email
void	sendErrorEmail(PaymentFileLoad paymentFile, org.kuali.rice.kns.util.MessageMap errors) Sends email for a payment load has failed.
void	sendExceedsMaxNotesWarningEmail(List<String> creditMemos, List<String> paymentRequests, int lineTotal, int maxNoteLines) Sends email for a purap bundle that exceeds the maximum number of notes allowed
void	sendLoadEmail(Batch batch) Sends email for a load done internally
void	sendLoadEmail(PaymentFileLoad paymentFile, List<String> warnings) Sends email for a successful payment load.
void	sendTaxEmail(PaymentFileLoad paymentFile) Sends email for a payment load that was held due to tax reasons

Method Detail

sendErrorEmail

void sendErrorEmail(PaymentFileLoad paymentFile,
                    org.kuali.rice.kns.util.MessageMap errors)

Sends email for a payment load has failed. Errors encountered will be printed out in message

Parameters:

paymentFile - parsed payment file object (might not be populated completely due to errors)

errors - ErrorMap containing ErrorMessage entries

sendLoadEmail

void sendLoadEmail(PaymentFileLoad paymentFile,
                   List<String> warnings)

Sends email for a successful payment load. Warnings encountered will be printed out in message

Parameters:

paymentFile - parsed payment file object

warnings - List of String messages

sendTaxEmail

void sendTaxEmail(PaymentFileLoad paymentFile)

Sends email for a payment load that was held due to tax reasons

Parameters:

paymentFile - parsed payment file object

sendLoadEmail

void sendLoadEmail(Batch batch)

Sends email for a load done internally

Parameters:

batch - Batch created by load

sendExceedsMaxNotesWarningEmail

void sendExceedsMaxNotesWarningEmail(List<String> creditMemos,
                                     List<String> paymentRequests,
                                     int lineTotal,
                                     int maxNoteLines)

Sends email for a purap bundle that exceeds the maximum number of notes allowed

Parameters:

creditMemos - list of credit memo documents in bundle

paymentRequests - list of payment request documents in bundle

lineTotal - total number of lines for bundle

maxNoteLines - maximum number of lines allowed

sendAchSummaryEmail

void sendAchSummaryEmail(Map<String,Integer> unitCounts,
                         Map<String,org.kuali.rice.kns.util.KualiDecimal> unitTotals,
                         Date extractDate)

Sends summary email for an ACH extract

Parameters:

unitCounts - Map containing payment counts for each unit

unitTotals - Map containing total payment amount for each unit

extractDate - date of ACH extraction

sendAchAdviceEmail

void sendAchAdviceEmail(PaymentGroup paymentGroup,
                        PaymentDetail paymentDetail,
                        CustomerProfile customer)

Sends advice notification email to the payee receiving an ACH payment

Parameters:

paymentGroup - ACH payment group to send notification for

paymentDetail - Payment Detail containing payment amounts

customer - Pdp Customer profile for payment

sendCancelEmail

void sendCancelEmail(PaymentGroup paymentGroup,
                     String note,
                     org.kuali.rice.kim.bo.Person user)

Sends Payment Cancellation Email

Parameters:

paymentGroup -

note -

user -

isPaymentEmailEnabled

boolean isPaymentEmailEnabled()

Reads system parameter indicating whether to status emails should be sent

Returns:

true if email should be sent, false otherwise