org.kuali.kfs.module.endow.batch.service.impl
Class AvailableCashUpdateServiceImpl

java.lang.Object
  org.kuali.kfs.module.endow.batch.service.impl.AvailableCashUpdateServiceImpl

All Implemented Interfaces:

AvailableCashUpdateService

@Transactional
public class AvailableCashUpdateServiceImpl
extends Object
implements AvailableCashUpdateService

This class implements the AvailableCashUpdateService batch job.

Field Summary

protected HoldingTaxLotService	holdingTaxLotService
protected KEMIDCurrentAvailableBalanceService	kEMIDCurrentAvailableBalanceService
protected KemidCurrentCashService	kemidCurrentCashService
protected KEMIDService	kEMIDService
protected static org.apache.log4j.Logger	LOG
protected org.kuali.rice.kns.service.ParameterService	parameterService

Constructor Summary

AvailableCashUpdateServiceImpl()
Constructs a AvailableCashUpdateServiceImpl instance

Method Summary

protected BigDecimal	getAvailableIncomeCash(String kemId) Method to calculate sum of available cash Income Cash 1.
protected BigDecimal	getAvailablePrincipalCash(String kemId, String typePrincipalRestrictedCode) If the END_KEMID_T record has a TYP_PRIN_RESTR CD where END_TYP_RESTR_CD_T: PERM is equal to Y (Yes), the principal is Permanently Restricted and AVAIL_PRIN_CSH is zero (0.00).
protected HoldingTaxLotService	getHoldingTaxLotService() gets the holdingTaxLotService
protected KEMIDCurrentAvailableBalanceService	getkEMIDCurrentAvailableBalanceService() Gets the kEMIDCurrentAvailableBalanceService attribute.
protected KemidCurrentCashService	getKemidCurrentCashOpenRecordsService() gets the kemidCurrentCashService
protected KEMIDService	getkEMIDService() gets the kEMIDService
protected org.kuali.rice.kns.service.ParameterService	getParameterService() Gets the parameterService attribute.
void	setHoldingTaxLotService(HoldingTaxLotService holdingTaxLotService) Sets the holdingTaxLotService
void	setkEMIDCurrentAvailableBalanceService(KEMIDCurrentAvailableBalanceService kEMIDCurrentAvailableBalanceService) Sets the kEMIDCurrentAvailableBalanceService attribute value.
void	setKemidCurrentCashService(KemidCurrentCashService kemidCurrentCashService) Sets the kemidCurrentCashService
void	setkEMIDService(KEMIDService kEMIDService) gets the kEMIDService
void	setParameterService(org.kuali.rice.kns.service.ParameterService parameterService) Sets the parameterService attribute value.
boolean	summarizeAvailableSpendableFunds() This process will generate records at the end of each processing cycle to summarize the available spendable funds for every KEMID that is not closed.
protected boolean	systemParametersForSummarizeAvailableSpendableFundsJobExist() This method checks if the System parameters have been set up for this batch job.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static org.apache.log4j.Logger LOG

parameterService

protected org.kuali.rice.kns.service.ParameterService parameterService

kemidCurrentCashService

protected KemidCurrentCashService kemidCurrentCashService

holdingTaxLotService

protected HoldingTaxLotService holdingTaxLotService

kEMIDService

protected KEMIDService kEMIDService

kEMIDCurrentAvailableBalanceService

protected KEMIDCurrentAvailableBalanceService kEMIDCurrentAvailableBalanceService

Constructor Detail

AvailableCashUpdateServiceImpl

public AvailableCashUpdateServiceImpl()

Constructs a AvailableCashUpdateServiceImpl instance

Method Detail

summarizeAvailableSpendableFunds

public boolean summarizeAvailableSpendableFunds()

This process will generate records at the end of each processing cycle to summarize the available spendable funds for every KEMID that is not closed.

Specified by:

summarizeAvailableSpendableFunds in interface AvailableCashUpdateService

systemParametersForSummarizeAvailableSpendableFundsJobExist

protected boolean systemParametersForSummarizeAvailableSpendableFundsJobExist()

This method checks if the System parameters have been set up for this batch job.

getAvailableIncomeCash

protected BigDecimal getAvailableIncomeCash(String kemId)

Method to calculate sum of available cash Income Cash 1. END_CRNT_CSH_T: CRNT_INC_CSH for the KEMID 2. The Market Value of the KEMID END_HLDG_TAX_LOT_T records with a CLS_CD_TYP of Cash Equivalents (C), and with the HLDG_IP_IND equal to I. 3. The Market Value of the KEMID END_HLDG_TAX_LOT_T records with a CLS_CD_TYP of Pooled Investment (P) and with the HLDG_IP_IND equal to I times the value in the Available Cash Percent institutional parameter (accounts for only a percentage of the market value allowing for pricing changes).

Parameters:

kemId -

Returns:

availableIncomeCash

getAvailablePrincipalCash

protected BigDecimal getAvailablePrincipalCash(String kemId,
                                               String typePrincipalRestrictedCode)

If the END_KEMID_T record has a TYP_PRIN_RESTR CD where END_TYP_RESTR_CD_T: PERM is equal to Y (Yes), the principal is Permanently Restricted and AVAIL_PRIN_CSH is zero (0.00). Otherwise Principal Available Cash is the sum of all of the following : END_CRNT_CSH: CRNT_PRIN_CSH The Market Value of the END_HLDG_TAX_LOT_T records with a CLS_CD_TYP of Cash Equivalents (C) and with the HLDG_IP_IND equal to P. The Market Value of the KEMID END_HLDG_TAX_LOT_T records with a CLS_CD_TYP of Pooled Investment (P) and with the HLDG_IP_IND equal to P times the value in the Available Cash Percent institutional parameter (accounts for only a percentage of the market value allowing for pricing changes)

Parameters:

kemId, - typeRestrictionCode

Returns:

availableIncomeCash

getParameterService

protected org.kuali.rice.kns.service.ParameterService getParameterService()

Gets the parameterService attribute.

Returns:

Returns the parameterService.

setParameterService

public void setParameterService(org.kuali.rice.kns.service.ParameterService parameterService)

Sets the parameterService attribute value.

Parameters:

parameterService - The parameterService to set.

getKemidCurrentCashOpenRecordsService

protected KemidCurrentCashService getKemidCurrentCashOpenRecordsService()

gets the kemidCurrentCashService

Parameters:

kemidCurrentCashService - The kemidCurrentCashService to get.

setKemidCurrentCashService

public void setKemidCurrentCashService(KemidCurrentCashService kemidCurrentCashService)

Sets the kemidCurrentCashService

Parameters:

kemidCurrentCashService - The kemidCurrentCashService to set.

getHoldingTaxLotService

protected HoldingTaxLotService getHoldingTaxLotService()

gets the holdingTaxLotService

Parameters:

holdingTaxLotService - The holdingTaxLotService to get.

setHoldingTaxLotService

public void setHoldingTaxLotService(HoldingTaxLotService holdingTaxLotService)

Sets the holdingTaxLotService

Parameters:

holdingTaxLotService - The holdingTaxLotService to set.

getkEMIDService

protected KEMIDService getkEMIDService()

gets the kEMIDService

Parameters:

kEMIDService - The kEMIDService to get.

setkEMIDService

public void setkEMIDService(KEMIDService kEMIDService)

gets the kEMIDService

Parameters:

kEMIDService - The kEMIDService to get.

getkEMIDCurrentAvailableBalanceService

protected KEMIDCurrentAvailableBalanceService getkEMIDCurrentAvailableBalanceService()

Gets the kEMIDCurrentAvailableBalanceService attribute.

Returns:

Returns the kEMIDCurrentAvailableBalanceService.

setkEMIDCurrentAvailableBalanceService

public void setkEMIDCurrentAvailableBalanceService(KEMIDCurrentAvailableBalanceService kEMIDCurrentAvailableBalanceService)

Sets the kEMIDCurrentAvailableBalanceService attribute value.

Parameters:

kEMIDCurrentAvailableBalanceService - The kEMIDCurrentAvailableBalanceService to set.