org.kuali.kfs.module.endow.document.service
Interface CurrentTaxLotService

All Known Implementing Classes:

CurrentTaxLotServiceImpl

public interface CurrentTaxLotService

Method Summary

void	clearAllCurrentTaxLotRecords() clears all the records from the CurrentTaxLotBalance table.
CurrentTaxLotBalance	copyHoldingTaxLotToCurrentTaxLotBalance(HoldingTaxLot holdingTaxLot) Method to copy HoldingTaxLot record to currentTaxLotBalance record
Collection<CurrentTaxLotBalance>	getAllCurrentTaxLotBalance() Retrieves all the records from END_CURR_TAX_LOT_BAL_T
CurrentTaxLotBalance	getByPrimaryKey(String kemid, String securityId, String registrationCode, org.kuali.rice.kns.util.KualiInteger lotNumber, String ipIndicator) Gets a current tax lot based on primary keys: kemid, security id, registration code, lot number and IP indicator.
Collection<CurrentTaxLotBalance>	getCurrentTaxLotBalancesByIncomePrincipalIndicator(String incomePrincipalIndicator) Gets matching records from END_CRNT_TAX_LOT_BAL_T table
Collection<CurrentTaxLotBalance>	getCurrentTaxLotBalancesBySecurityId(String securityId) Gets matching records from END_CRNT_TAX_LOT_BAL_T table
BigDecimal	getCurrentTaxLotBalanceSecurityUnitValue(String securityId) Method to get the security unit value for the current balance tax lot record
Collection<CurrentTaxLotBalance>	getCurrentTaxLotBalancesForMatchingSecurityClassCode(String securityClassCode) Gets matching records from END_CRNT_TAX_LOT_BAL_T table
Collection<CurrentTaxLotBalance>	getCurrentTaxLotBalancesForMatchingSecurityClassCodeAndSecurityId(String securityClassCode, String securityId) Gets matching records from END_CRNT_TAX_LOT_BAL_T table
BigDecimal	getHoldingMarketValue(HoldingTaxLot holdingTaxLot, String securityId) Gets the holding market value as follows: Class type code = B => MV = Units x Unit value / 100 Class type code = A => Market Valuation (END_SEC_T: SEC_VAL_BY_MKT) minus the total cash activity (income and principal) since the last value date (END_SEC_T: SEC_VAL_DT) Class type code = O => Units x Unit value
BigDecimal	getHoldingMarketValueSumForSecurity(String securityId) Gets the Sum of the HLDG _MVAL for all records for the Security in END_CURR_TAX_LOT_BAL_T.
BigDecimal	getNextFiscalYearInvestmentIncome(HoldingTaxLot holdingTaxLot, String securityId) Method to calculate next fiscal year investment income
BigDecimal	getNextTwelveMonthsEstimatedValue(HoldingTaxLot holdingTaxLot, String securityId) Method to calculate Next Twelve Months Estimated value
BigDecimal	getRemainderOfFiscalYearEstimatedIncome(HoldingTaxLot holdingTaxLot, String securityId) Method to calculate remainder of fiscal year estimated income
void	updateCurrentTaxLotBalance(CurrentTaxLotBalance currentTaxLotBalance) updates a current tax lot

Method Detail

getByPrimaryKey

CurrentTaxLotBalance getByPrimaryKey(String kemid,
                                     String securityId,
                                     String registrationCode,
                                     org.kuali.rice.kns.util.KualiInteger lotNumber,
                                     String ipIndicator)

Gets a current tax lot based on primary keys: kemid, security id, registration code, lot number and IP indicator.

Parameters:

kemid -

securityId -

registrationCode -

lotNumber -

ipIndicator -

Returns:

the corresponding tax lot

getCurrentTaxLotBalancesBySecurityId

Collection<CurrentTaxLotBalance> getCurrentTaxLotBalancesBySecurityId(String securityId)

Gets matching records from END_CRNT_TAX_LOT_BAL_T table

Parameters:

securityId -

Returns:

currentTaxLotBal Records from the table matching the securityId

getCurrentTaxLotBalancesForMatchingSecurityClassCode

Collection<CurrentTaxLotBalance> getCurrentTaxLotBalancesForMatchingSecurityClassCode(String securityClassCode)

Gets matching records from END_CRNT_TAX_LOT_BAL_T table

Parameters:

securityClassCode, - securityId

Returns:

currentTaxLotBal Records from the table matching the securityClassCode, securityId

getCurrentTaxLotBalancesForMatchingSecurityClassCodeAndSecurityId

Collection<CurrentTaxLotBalance> getCurrentTaxLotBalancesForMatchingSecurityClassCodeAndSecurityId(String securityClassCode,
                                                                                                   String securityId)

Gets matching records from END_CRNT_TAX_LOT_BAL_T table

Parameters:

securityClassCode, - securityId

Returns:

currentTaxLotBal Records from the table matching the securityClassCode, securityId

getCurrentTaxLotBalancesByIncomePrincipalIndicator

Collection<CurrentTaxLotBalance> getCurrentTaxLotBalancesByIncomePrincipalIndicator(String incomePrincipalIndicator)

Gets matching records from END_CRNT_TAX_LOT_BAL_T table

Parameters:

incomePrincipalIndicator -

Returns:

currentTaxLotBalances Records from the table matching the incomePrincipalIndicator

updateCurrentTaxLotBalance

void updateCurrentTaxLotBalance(CurrentTaxLotBalance currentTaxLotBalance)

updates a current tax lot

Parameters:

currentTaxLotBalances -

clearAllCurrentTaxLotRecords

void clearAllCurrentTaxLotRecords()

clears all the records from the CurrentTaxLotBalance table.

copyHoldingTaxLotToCurrentTaxLotBalance

CurrentTaxLotBalance copyHoldingTaxLotToCurrentTaxLotBalance(HoldingTaxLot holdingTaxLot)

Method to copy HoldingTaxLot record to currentTaxLotBalance record

Parameters:

holdingTaxLot -

Returns:

currentTaxLotBalance

getCurrentTaxLotBalanceSecurityUnitValue

BigDecimal getCurrentTaxLotBalanceSecurityUnitValue(String securityId)

Method to get the security unit value for the current balance tax lot record

Parameters:

securityId -

Returns:

securityUnitValue

getNextTwelveMonthsEstimatedValue

BigDecimal getNextTwelveMonthsEstimatedValue(HoldingTaxLot holdingTaxLot,
                                             String securityId)

Method to calculate Next Twelve Months Estimated value

Parameters:

securityId -

Returns:

nextTwelveMonthsEstimatedValue

getRemainderOfFiscalYearEstimatedIncome

BigDecimal getRemainderOfFiscalYearEstimatedIncome(HoldingTaxLot holdingTaxLot,
                                                   String securityId)

Method to calculate remainder of fiscal year estimated income

Parameters:

securityId -

Returns:

remainderOfFiscalYearEstimatedIncome

getNextFiscalYearInvestmentIncome

BigDecimal getNextFiscalYearInvestmentIncome(HoldingTaxLot holdingTaxLot,
                                             String securityId)

Method to calculate next fiscal year investment income

Parameters:

securityId -

Returns:

nextFiscalyearInvestmentIncome

getHoldingMarketValueSumForSecurity

BigDecimal getHoldingMarketValueSumForSecurity(String securityId)

Gets the Sum of the HLDG _MVAL for all records for the Security in END_CURR_TAX_LOT_BAL_T.

Parameters:

securityId - the security for which we return the sum

Returns:

the Sum of the HLDG _MVAL for all records for the Security

getAllCurrentTaxLotBalance

Collection<CurrentTaxLotBalance> getAllCurrentTaxLotBalance()

Retrieves all the records from END_CURR_TAX_LOT_BAL_T

Returns:

currentBalances

getHoldingMarketValue

BigDecimal getHoldingMarketValue(HoldingTaxLot holdingTaxLot,
                                 String securityId)

Gets the holding market value as follows: Class type code = B => MV = Units x Unit value / 100 Class type code = A => Market Valuation (END_SEC_T: SEC_VAL_BY_MKT) minus the total cash activity (income and principal) since the last value date (END_SEC_T: SEC_VAL_DT) Class type code = O => Units x Unit value