Package cdm.base.math

Interface Schedule

All Superinterfaces:

com.rosetta.model.lib.RosettaModelObject

All Known Subinterfaces:

AmountSchedule, AmountSchedule.AmountScheduleBuilder, Schedule.ScheduleBuilder

All Known Implementing Classes:

AmountSchedule.AmountScheduleBuilderImpl, AmountSchedule.AmountScheduleImpl, Schedule.ScheduleBuilderImpl, Schedule.ScheduleImpl

@RosettaDataType(value="Schedule",
                 builder=ScheduleBuilderImpl.class,
                 version="5.30.0")
@RuneDataType(value="Schedule",
              model="cdm",
              builder=ScheduleBuilderImpl.class,
              version="5.30.0")
public interface Schedule
extends com.rosetta.model.lib.RosettaModelObject

A 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.

Version:

5.30.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Schedule.ScheduleBuilder	Builder Interface
static class	Schedule.ScheduleBuilderImpl	Builder Implementation of Schedule
static class	Schedule.ScheduleImpl	Immutable Implementation of Schedule

Field Summary

Fields

Modifier and Type	Field	Description
static final ScheduleMeta	metaData

Method Summary

Modifier and Type	Method	Description
Schedule	build()	Build Methods
static Schedule.ScheduleBuilder	builder()
List<? extends DatedValue>	getDatedValue()	The schedule of step date and value pairs.
default Class<? extends Schedule>	getType()
BigDecimal	getValue()	The initial rate or amount, as the case may be.
default com.rosetta.model.lib.meta.RosettaMetaData<? extends Schedule>	metaData()	Utility Methods
default void	process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
Schedule.ScheduleBuilder	toBuilder()

Methods inherited from interface com.rosetta.model.lib.RosettaModelObject

processRosetta, processRosetta

Field Details

metaData

static final ScheduleMeta metaData

Method Details

getValue

BigDecimal getValue()

The initial rate or amount, as the case may be. An initial rate of 5% would be represented as 0.05.

getDatedValue

List<? extends DatedValue> getDatedValue()

The schedule of step date and value pairs. On each step date the associated step value becomes effective. A list of steps may be ordered in the document by ascending step date. An FpML document containing an unordered list of steps is still regarded as a conformant document.

build

Schedule build()

Build Methods

Specified by:

build in interface com.rosetta.model.lib.RosettaModelObject

toBuilder

Schedule.ScheduleBuilder toBuilder()

Specified by:

toBuilder in interface com.rosetta.model.lib.RosettaModelObject

builder

static Schedule.ScheduleBuilder builder()

metaData

default com.rosetta.model.lib.meta.RosettaMetaData<? extends Schedule> metaData()

Utility Methods

Specified by:

metaData in interface com.rosetta.model.lib.RosettaModelObject

getType

@RuneAttribute("@type")
default Class<? extends Schedule> getType()

Specified by:

getType in interface com.rosetta.model.lib.RosettaModelObject

process

default void process(com.rosetta.model.lib.path.RosettaPath path,
 com.rosetta.model.lib.process.Processor processor)

Specified by:

process in interface com.rosetta.model.lib.RosettaModelObject