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

All Known Implementing Classes:

KEMServiceImpl

public interface KEMService

This interface provides utility methods for the KEM module like mod10 calculation.

Method Summary

BigDecimal	getAvailableCashPercent() Gets the AVAILABLE_CASH_PERCENT system parameter
Date	getCurrentDate() Gets the current date based on a system parameter USE_PROCESS_DATE_IND: 1) If USE_PROCESS_DATE_IND = Y (true), get the value from CURRENT_PROCESS_DATE.
Date	getCurrentProcessDate() Gets the current process date from the CURRENT_PROCESS_DATE parameter
String	getCurrentSystemProcessDate() Gets the current system process date.
String	getCurrentSystemProcessDateFormated()
Date	getCurrentSystemProcessDateObject()
Date	getFirstDayAfterFiscalYearEndDayAndMonth() Gets the first day after the fiscal year End Day and Month system parameter.
Date	getFiscalYearEndDayAndMonth() Gets the FISCAL_YEAR_END_DAY_AND_MONTH system parameter
BigDecimal	getMarketValue(String securityId) Computes the market value as the Sum of the HLDG _MVAL for all records for the Security in END_CURR_TAX_LOT_BAL_T.
BigDecimal	getMarketValue(String kemid, String securityId, String registrationCode, org.kuali.rice.kns.util.KualiInteger lotNumber, String ipIndicator) Gets the market value as the HLDG _MVAL for the record in END_CURR_TAX_LOT_BAL_T for the given kemid, securityId, registrationCode, lotNumber, ipIndicator.
int	getMaxNumberOfTransactionLinesPerDocument() Gets MAXIMUM_TRANSACTION_LINES value from the system parameter.
int	getNumberOfDaysInCalendarYear() Gets the number of days in the calendar year.
long	getTotalNumberOfPaymentsForFiscalYear() Gets the DISTRIBUTION_TIMES_PER_YEAR system parameter
String	mod10(String prefix) Computes the check digit based on the given prefix.

Method Detail

mod10

String mod10(String prefix)

Computes the check digit based on the given prefix.

Parameters:

prefix -

Returns:

the string formed by the prefix + check digit

getMarketValue

BigDecimal getMarketValue(String securityId)

Computes the market value as the Sum of the HLDG _MVAL for all records for the Security in END_CURR_TAX_LOT_BAL_T.

Parameters:

securityId -

Returns:

the market value for the given security

getMarketValue

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

Gets the market value as the HLDG _MVAL for the record in END_CURR_TAX_LOT_BAL_T for the given kemid, securityId, registrationCode, lotNumber, ipIndicator.

Parameters:

kemid -

securityId -

registrationCode -

lotNumber -

ipIndicator -

Returns:

the market value for the given kemid, securityId, registrationCode, lotNumber, ipIndicator.

getCurrentSystemProcessDate

String getCurrentSystemProcessDate()

Gets the current system process date.

Returns:

a String representing the value of the current system process date

getCurrentSystemProcessDateFormated

String getCurrentSystemProcessDateFormated()
                                           throws Exception

Throws:

Exception

getCurrentSystemProcessDateObject

Date getCurrentSystemProcessDateObject()

getCurrentDate

Date getCurrentDate()

Gets the current date based on a system parameter USE_PROCESS_DATE_IND:
1) If USE_PROCESS_DATE_IND = Y (true), get the value from CURRENT_PROCESS_DATE.
2) If USE_PROCESS_DATE_IND = N (false), get the current date from the local system using standard Java API.

Returns:

the current date

getCurrentProcessDate

Date getCurrentProcessDate()

Gets the current process date from the CURRENT_PROCESS_DATE parameter

Returns:

current process date

getAvailableCashPercent

BigDecimal getAvailableCashPercent()

Gets the AVAILABLE_CASH_PERCENT system parameter

Returns:

AVAILABLE_CASH_PERCENT value

getFiscalYearEndDayAndMonth

Date getFiscalYearEndDayAndMonth()

Gets the FISCAL_YEAR_END_DAY_AND_MONTH system parameter

Returns:

FISCAL_YEAR_END_DAY_AND_MONTH value

getTotalNumberOfPaymentsForFiscalYear

long getTotalNumberOfPaymentsForFiscalYear()

Gets the DISTRIBUTION_TIMES_PER_YEAR system parameter

Returns:

DISTRIBUTION_TIMES_PER_YEAR value

getNumberOfDaysInCalendarYear

int getNumberOfDaysInCalendarYear()

Gets the number of days in the calendar year.

Returns:

the number of days in the calendar year

getFirstDayAfterFiscalYearEndDayAndMonth

Date getFirstDayAfterFiscalYearEndDayAndMonth()

Gets the first day after the fiscal year End Day and Month system parameter.

getMaxNumberOfTransactionLinesPerDocument

int getMaxNumberOfTransactionLinesPerDocument()

Gets MAXIMUM_TRANSACTION_LINES value from the system parameter.