org.kuali.ole.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

Methods

Modifier and Type	Method and Description
void	cancelExtractedDisbursementVoucher(DisbursementVoucherDocument dv, Date processDate) Cancels a disbursement voucher completely, because its payment has been canceled
void	extractImmediatePayment(DisbursementVoucherDocument disbursementVoucher) Creates a batch payment for a single disbursement voucher
void	extractImmediatePayments() Deprecated. this method is not used in batch any longer (immediate extract of DV's occurs in the DV's own route status change handler) and the code seems a bit fishy at this point, so likely, institutions shouldn't be using this
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.

extractImmediatePayments

void extractImmediatePayments()

Deprecated. this method is not used in batch any longer (immediate extract of DV's occurs in the DV's own route status change handler) and the code seems a bit fishy at this point, so likely, institutions shouldn't be using this

Pulls all disbursement voucher which pay checks and which are marked as "immediate payment" from the database and builds payment information for them

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

extractImmediatePayment

void extractImmediatePayment(DisbursementVoucherDocument disbursementVoucher)

Creates a batch payment for a single disbursement voucher

Parameters:

disbursementVoucher - the voucher to immediately extract