FormattableTimeBasedRate (Cyclos 4.16.19 Scripting API Documentation)

java.lang.Object
- org.cyclos.model.banking.rates.FormattableTimeBasedRate

```
public class FormattableTimeBasedRate
extends Object
```
A wrapper object for representing time based rates in the gui, needed to get rates handled by the formatter.

Constructor Summary

Constructors
Constructor	Description
`FormattableTimeBasedRate(BigDecimal rate)`
`FormattableTimeBasedRate(BigDecimal rate, MessageKey extraRemarkAfterUnitsKey)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MessageKey`	`getDayKey()`
`MessageKey`	`getDaysKey()`
`MessageKey`	`getExtraRemarkKey()`	Optional.
`MessageKey`	`getHourKey()`
`MessageKey`	`getHoursKey()`
`BigDecimal`	`getRate()`
`int`	`getScale()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FormattableTimeBasedRate

public FormattableTimeBasedRate(BigDecimal rate)

FormattableTimeBasedRate

public FormattableTimeBasedRate(BigDecimal rate,
                                MessageKey extraRemarkAfterUnitsKey)

Method Detail

getDayKey
```
public MessageKey getDayKey()
```

getDaysKey
```
public MessageKey getDaysKey()
```

getExtraRemarkKey
```
public MessageKey getExtraRemarkKey()
```
Optional. Extra key to be shown after the units label.

getHourKey
```
public MessageKey getHourKey()
```

getHoursKey
```
public MessageKey getHoursKey()
```

getRate
```
public BigDecimal getRate()
```

getScale
```
public int getScale()
```