RateSchedule
Type CDM 7.2.0A class defining a schedule of rates or amounts in terms of an initial value and then a series of step date and value pairs. On each step date the rate or amount changes to the new step value. The series of step date and value pairs are optional. If not specified, this implies that the initial value remains unchanged over time.
Attributes
All 1 declared on RateSchedule. Cardinality in amber is required.
| Name | Type | Card. | Description |
|---|---|---|---|
| price | PriceSchedule | 1..1 | The initial rate. An initial rate of 5% would be represented as 0.05. |
Referenced by
2 types hold a RateSchedule as an attribute.
Functions
Model functions that produce or consume this type. These are the CDM's own behaviour — the logic a correct implementation has to match.
| Function | Role | Description |
|---|---|---|
| GetRateScheduleAmount | takes | Get the rate for the period start date. |
| GetRateScheduleStepValues | takes | Get all rate schedule step values whose stepDate is before or equal to the supplied periodStartDate. Returns a list of step values starting from the initial rate. |
Open RateSchedule in the Model Browser
Walk the tree and the reference graph interactively, and switch releases to see how the type has changed. Free, no signup.