TimeBasedRateTypeHandler (Cyclos 4.14.14 Scripting API Documentation)

All Superinterfaces:

RateTypeHandler<Date,R,D>

All Known Subinterfaces:

ARateTypeHandler, ARateTypeHandlerTestable, DRateTypeHandler, DRateTypeHandlerTestable

All Known Implementing Classes:

ARateTypeHandlerImpl, DRateTypeHandlerImpl, TimeBasedRateTypeHandlerImpl
```
public interface TimeBasedRateTypeHandler<R extends TimeBasedRateParameters,D extends TimeBasedRateParametersDTO>
extends RateTypeHandler<Date,R,D>
```
Handler for time based rates (A-rate, D-rate)

Field Summary
- Fields inherited from interface org.cyclos.impl.banking.RateTypeHandler
  RATE_SCALE

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`DateTime`	`convert(BigDecimal rate, DateTime date)`	like `RateTypeHandler.convert(BigDecimal, Date)`, but with DateTime as parameters.
`BigDecimal`	`convert(DateTime rawRate, DateTime date)`	like `RateTypeHandler.convert(Object, Date)`, but with DateTimes as parameters.
`Date`	`getInitValue(Currency currency, Date date)`	Reads the raw initialization value of the rate in case a null rate is encountered.

Methods inherited from interface org.cyclos.impl.banking.RateTypeHandler
applyIncomingTransfer, calculateFromRates, complete, convert, convert, copy, getCreationValue, getEnableDate, getNullSafeRawRate, getRateParameters, getRateParameters, getRateParametersDTO, getRateType, isEnabled, isVisible, isVisibleToUser, nullAllAccountRates, resolveValidator, setRate, setRawRate, toEntity

- Method Detail
  - convert
```
DateTime convert(BigDecimal rate,
                 DateTime date)
```
    like RateTypeHandler.convert(BigDecimal, Date), but with DateTime as parameters.
  - convert
```
BigDecimal convert(DateTime rawRate,
                   DateTime date)
```
    like RateTypeHandler.convert(Object, Date), but with DateTimes as parameters.
  - getInitValue
```
Date getInitValue(Currency currency,
                  Date date)
```
    Reads the raw initialization value of the rate in case a null rate is encountered. The initialization fields are looked up on the currency. The actual initialization of the rates only takes place when a new ClosedAccountBalance is created. This method does NOT initialized rates, it only reads the initialization values.
    
    Parameters:
    
    currency -
    
    date - the date for which this init value is valid
    
    Returns:
    
    the value on which the rate is initialized. Returns null if the rate was not enabled at the given date.