org.kuali.kfs.fp.batch.service
Interface DisbursementVoucherExtractService

All Known Implementing Classes:

DisbursementVoucherExtractServiceImpl

public interface DisbursementVoucherExtractService

This service interface defines the methods that a DisbursementVoucherExtractService implementation must provide.

Method Summary

void	cancelExtractedDisbursementVoucher(DisbursementVoucherDocument dv, Date processDate) Cancels a disbursement voucher completely, because its payment has been canceled
boolean	extractPayments() Extract all disbursement vouchers that need to be paid from the database and prepares them for payment.
DisbursementVoucherDocument	getDocumentById(String documentNumber) Returns the disbursement voucher document associated with the given document number
void	markDisbursementVoucherAsPaid(DisbursementVoucherDocument dv, Date processDate) Marks a disbursement voucher as paid
void	resetExtractedDisbursementVoucher(DisbursementVoucherDocument dv, Date processDate) Resets the disbursement voucher so that it can be reextracted

Method Detail

extractPayments

boolean extractPayments()

Extract all disbursement vouchers that need to be paid from the database and prepares them for payment.

Returns:

True if the extraction of payments is successful, false if not.

cancelExtractedDisbursementVoucher

void cancelExtractedDisbursementVoucher(DisbursementVoucherDocument dv,
                                        Date processDate)

Cancels a disbursement voucher completely, because its payment has been canceled

Parameters:

dv - the disbursement voucher to cancel

resetExtractedDisbursementVoucher

void resetExtractedDisbursementVoucher(DisbursementVoucherDocument dv,
                                       Date processDate)

Resets the disbursement voucher so that it can be reextracted

Parameters:

dv - the disbursement voucher to reset for reextraction

getDocumentById

DisbursementVoucherDocument getDocumentById(String documentNumber)

Returns the disbursement voucher document associated with the given document number

Parameters:

documentNumber - the id of the document to retrieve

Returns:

the DV document if found, or null

markDisbursementVoucherAsPaid

void markDisbursementVoucherAsPaid(DisbursementVoucherDocument dv,
                                   Date processDate)

Marks a disbursement voucher as paid

Parameters:

dv - the disbursement voucher to mark

processDate - the date when the dv was paid