org.kuali.kfs.gl.batch.service
Interface EncumbranceClosingOriginEntryGenerationService

All Known Implementing Classes:

EncumbranceClosingOriginEntryGenerationServiceImpl

public interface EncumbranceClosingOriginEntryGenerationService

Service which generates encumbrance closing origin entries

Method Summary

OriginEntryOffsetPair	createBeginningBalanceEntryOffsetPair(Encumbrance encumbrance, Integer closingFiscalYear, Date transactionDate) Create a pair of OriginEntries, one explicit and one offset to carry forward an encumbrance.
OriginEntryOffsetPair	createCostShareBeginningBalanceEntryOffsetPair(Encumbrance encumbrance, Date transactionDate) Create a pair of cost share entries, one explicit and one offset to carry forward an encumbrance after validating the encumbrance.
boolean	isEncumbranceClosed(Encumbrance encumbrance) Determine whether or not the encumbrance has been fully relieved.
boolean	shouldForwardCostShareForEncumbrance(OriginEntryFull entry, OriginEntryFull offset, Encumbrance encumbrance, String objectTypeCode) Do some validation and make sure that the encumbrance A21SubAccount is a cost share sub-account.
boolean	shouldForwardEncumbrance(Encumbrance encumbrance) Determine whether or not an encumbrance should be carried forward from one fiscal year to the next.

Method Detail

createCostShareBeginningBalanceEntryOffsetPair

OriginEntryOffsetPair createCostShareBeginningBalanceEntryOffsetPair(Encumbrance encumbrance,
                                                                     Date transactionDate)

Create a pair of cost share entries, one explicit and one offset to carry forward an encumbrance after validating the encumbrance.

Parameters:

encumbrance - the encumbrance to create origin entry and offset for

transactionDate - the date all origin entries should have as their transaction date

Returns:

a cost share entry/offset pair to carry forward the given encumbrance.

createBeginningBalanceEntryOffsetPair

OriginEntryOffsetPair createBeginningBalanceEntryOffsetPair(Encumbrance encumbrance,
                                                            Integer closingFiscalYear,
                                                            Date transactionDate)

Create a pair of OriginEntries, one explicit and one offset to carry forward an encumbrance.

Parameters:

encumbrance - the encumbrance to create origin entries for

closingFiscalYear - the fiscal year that's closing

transactionDate - the transaction date these entries should have

Returns:

a entry/offset pair for the given encumbrance

shouldForwardEncumbrance

boolean shouldForwardEncumbrance(Encumbrance encumbrance)

Determine whether or not an encumbrance should be carried forward from one fiscal year to the next.

Parameters:

encumbrance - the encumbrance to qualify

Returns:

true if the encumbrance should be rolled forward from the closing fiscal year to the opening fiscal year.

shouldForwardCostShareForEncumbrance

boolean shouldForwardCostShareForEncumbrance(OriginEntryFull entry,
                                             OriginEntryFull offset,
                                             Encumbrance encumbrance,
                                             String objectTypeCode)
                                             throws FatalErrorException

Do some validation and make sure that the encumbrance A21SubAccount is a cost share sub-account.

Parameters:

entry - not used in this implementation

offset - not used in this implementation

encumbrance - the encumbrance whose A21SubAccount must be qualified

objectTypeCode - the object type code of the generated entries

Returns:

true if the encumbrance is eligible for cost share.

Throws:

FatalErrorException - thrown if a given A21SubAccount, SubFundGroup, or PriorYearAccount record is not found in the database

isEncumbranceClosed

boolean isEncumbranceClosed(Encumbrance encumbrance)

Determine whether or not the encumbrance has been fully relieved.

Parameters:

encumbrance - the encumbrance to qualify

Returns:

true if the amount closed on the encumbrance is NOT equal to the amount of the encumbrance itself, e.g. if the encumbrance has not yet been paid off.