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

All Known Implementing Classes:

SecurityServiceImpl

public interface SecurityService

Method Summary

void	computeValueBasedOnValuationMethod(Security security) Calculates market value or unit value based on the security valuation method
Security	getByPrimaryKey(String id) Gets a Security by primary key.
List<Security>	getSecuritiesByClassCodeWithUnitsGreaterThanZero(List<String> classCodes) Gets all the Securities with the class code in the classCodes array and the units held greater than zero.
Security	updateIncomeChangeDate(Security security) Updates incomeChangeDate to currentDate
Security	updateInterestRate(Security theSecurity, BigDecimal interestRate) This method will update the interest rate or amount
Security	updateUnitValue(Security security, BigDecimal newUnitValue, Date newValueDate, String newUnitValueSource) This method will perform the following updates: 1) Copy current Security Unit Value to Previous Unit Value 2) Copy current Security Value Date to Previous Unit Value Date 3) Copy newUnitValue to current Security Unit Value 4) Copy newValueDate to current Security Unit Value Date 5) Copy newUnitValueSource to Unit Value Source

Method Detail

computeValueBasedOnValuationMethod

void computeValueBasedOnValuationMethod(Security security)

Calculates market value or unit value based on the security valuation method

Parameters:

security - the security for which we calculate the market value or unit value

updateUnitValue

Security updateUnitValue(Security security,
                         BigDecimal newUnitValue,
                         Date newValueDate,
                         String newUnitValueSource)

This method will perform the following updates: 1) Copy current Security Unit Value to Previous Unit Value 2) Copy current Security Value Date to Previous Unit Value Date 3) Copy newUnitValue to current Security Unit Value 4) Copy newValueDate to current Security Unit Value Date 5) Copy newUnitValueSource to Unit Value Source

Parameters:

security - the BO that needs to be updated.

newUnitValue - the new unit value for that security

newValueDate - the new value date for that security

newUnitValueSource - the new unit value source for that security

Returns:

Security the update security object

updateInterestRate

Security updateInterestRate(Security theSecurity,
                            BigDecimal interestRate)

This method will update the interest rate or amount

Returns:

Security the update security object

updateIncomeChangeDate

Security updateIncomeChangeDate(Security security)

Updates incomeChangeDate to currentDate

Parameters:

id -

getByPrimaryKey

Security getByPrimaryKey(String id)

Gets a Security by primary key.

Parameters:

id -

Returns:

a Security

getSecuritiesByClassCodeWithUnitsGreaterThanZero

List<Security> getSecuritiesByClassCodeWithUnitsGreaterThanZero(List<String> classCodes)

Gets all the Securities with the class code in the classCodes array and the units held greater than zero.

Parameters:

classCodes -

Returns:

All securities that meet the criteria