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

All Known Implementing Classes:

HoldingTaxLotServiceImpl

public interface HoldingTaxLotService

Method Summary

List<HoldingTaxLot>	getAllTaxLots() Gets all tax lots.
List<HoldingTaxLot>	getAllTaxLots(String kemid, String securityId, String registrationCode, String ipIndicator) Gets the holding tax lot based on the following criteria: kemid, security id, registration code, and IP indicator.
List<HoldingTaxLot>	getAllTaxLotsByKemIdAdndIPIndicator(String kemid, String ipIndicator) Gets all tax lots on the following criteria: kemi and IPindicator.
List<HoldingTaxLot>	getAllTaxLotsOrderByAcquiredDate(String kemid, String securityId, String registrationCode, String ipIndicator, boolean sortAscending) Gets the holding tax lot based on the following criteria: kemid, security id, registration code, and IP indicator and orders them ascending or descending based on the acquired date.
List<HoldingTaxLot>	getAllTaxLotsWithAccruedIncomeGreaterThanZeroPerSecurity(String securityId) Get all tax lots for the given security that have an accrued income greater than zero.
List<HoldingTaxLot>	getAllTaxLotsWithPositiveCost(String kemid, String securityId, String registrationCode, String ipIndicator) Gets all tax lots with positive cost based on the following criteria: kemid, security id, registration code, and IP indicator.
List<HoldingTaxLot>	getAllTaxLotsWithPositiveUnits(String kemid, String securityId, String registrationCode, String ipIndicator) Gets all tax lots with positive units based on the following criteria: kemid, security id, registration code, and IP indicator.
HoldingTaxLot	getByPrimaryKey(String kemid, String securityId, String registrationCode, int lotNumber, String ipIndicator) Gets a holding tax lot based on primary keys: kemid, security id, registration code, lot number and IP indicator.
String	getClassCodeType(String securityId) Gets class code type based on securityId.
BigDecimal	getMarketValueForCashEquivalentsForAvailableIncomeCash(String kemId) 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.
BigDecimal	getMarketValueForCashEquivalentsForAvailablePrincipalCash(String kemId) 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 P.
BigDecimal	getMarketValueForPooledInvestmentForAvailableIncomeCash(String kemId) 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).
BigDecimal	getMarketValueForPooledInvestmentForAvailablePrincipalCash(String kemId) 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).
List<HoldingTaxLot>	getTaxLotsPerSecurityIDWithUnitsGreaterThanZero(String securityId) Gets all the tax lots for the given security that have units greater than zero.
boolean	removeAllHoldingTaxLots() Removes all HoldingTaxLot records from END_HLDG_TAX_LOT_T

Method Detail

getByPrimaryKey

HoldingTaxLot getByPrimaryKey(String kemid,
                              String securityId,
                              String registrationCode,
                              int lotNumber,
                              String ipIndicator)

Gets a holding 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

getAllTaxLots

List<HoldingTaxLot> getAllTaxLots(String kemid,
                                  String securityId,
                                  String registrationCode,
                                  String ipIndicator)

Gets the holding tax lot based on the following criteria: kemid, security id, registration code, and IP indicator.

Parameters:

kemid -

securityId -

registrationCode -

ipIndicator -

Returns:

a list of tax lots that meet the criteria

getAllTaxLotsWithPositiveUnits

List<HoldingTaxLot> getAllTaxLotsWithPositiveUnits(String kemid,
                                                   String securityId,
                                                   String registrationCode,
                                                   String ipIndicator)

Gets all tax lots with positive units based on the following criteria: kemid, security id, registration code, and IP indicator.

Parameters:

kemid -

securityId -

registrationCode -

ipIndicator -

Returns:

a list of tax lots that meet the criteria

getAllTaxLotsOrderByAcquiredDate

List<HoldingTaxLot> getAllTaxLotsOrderByAcquiredDate(String kemid,
                                                     String securityId,
                                                     String registrationCode,
                                                     String ipIndicator,
                                                     boolean sortAscending)

Gets the holding tax lot based on the following criteria: kemid, security id, registration code, and IP indicator and orders them ascending or descending based on the acquired date.

Parameters:

kemid -

securityId -

registrationCode -

ipIndicator - returned in the descending order

Returns:

a list of tax lots that meet the criteria and in the right order

getAllTaxLotsWithPositiveCost

List<HoldingTaxLot> getAllTaxLotsWithPositiveCost(String kemid,
                                                  String securityId,
                                                  String registrationCode,
                                                  String ipIndicator)

Gets all tax lots with positive cost based on the following criteria: kemid, security id, registration code, and IP indicator.

Parameters:

kemid -

securityId -

registrationCode -

ipIndicator -

Returns:

a list of tax lots that meet the criteria

getAllTaxLotsByKemIdAdndIPIndicator

List<HoldingTaxLot> getAllTaxLotsByKemIdAdndIPIndicator(String kemid,
                                                        String ipIndicator)

Gets all tax lots on the following criteria: kemi and IPindicator.

Parameters:

kemid -

ipIndicator -

Returns:

a list of tax lots that meet the criteria

getClassCodeType

String getClassCodeType(String securityId)

Gets class code type based on securityId. Based on security ID, you search END_SEC_T Table to get END_SEC_T:SEC_CLS_CD, then, based on class code, you search END_CLS_CD_T, to get END_CLS_CD_T:CLS_CD_TYP

Parameters:

id -

Returns:

class code type

getMarketValueForCashEquivalentsForAvailableIncomeCash

BigDecimal getMarketValueForCashEquivalentsForAvailableIncomeCash(String kemId)

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.

Parameters:

kemId -

Returns:

marketValue

getMarketValueForPooledInvestmentForAvailableIncomeCash

BigDecimal getMarketValueForPooledInvestmentForAvailableIncomeCash(String kemId)

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).

Returns:

marketValue

getMarketValueForCashEquivalentsForAvailablePrincipalCash

BigDecimal getMarketValueForCashEquivalentsForAvailablePrincipalCash(String kemId)

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 P.

Parameters:

kemId -

Returns:

marketValue

getMarketValueForPooledInvestmentForAvailablePrincipalCash

BigDecimal getMarketValueForPooledInvestmentForAvailablePrincipalCash(String kemId)

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).

Returns:

marketValue

getAllTaxLots

List<HoldingTaxLot> getAllTaxLots()

Gets all tax lots.

Returns:

a list of tax lots

getAllTaxLotsWithAccruedIncomeGreaterThanZeroPerSecurity

List<HoldingTaxLot> getAllTaxLotsWithAccruedIncomeGreaterThanZeroPerSecurity(String securityId)

Get all tax lots for the given security that have an accrued income greater than zero.

Parameters:

securityId - the id of the security for which to retrieve the tax lots

Returns:

all tax lots that meet the criteria

getTaxLotsPerSecurityIDWithUnitsGreaterThanZero

List<HoldingTaxLot> getTaxLotsPerSecurityIDWithUnitsGreaterThanZero(String securityId)

Gets all the tax lots for the given security that have units greater than zero.

Parameters:

securityId -

Returns:

all tax lots that meet the criteria

removeAllHoldingTaxLots

boolean removeAllHoldingTaxLots()

Removes all HoldingTaxLot records from END_HLDG_TAX_LOT_T

Returns:

true is successfully removed the records, else false