Package cdm.base.math

Interface NonNegativeStep

All Superinterfaces:

com.rosetta.model.lib.GlobalKey, com.rosetta.model.lib.RosettaModelObject

All Known Subinterfaces:

NonNegativeStep.NonNegativeStepBuilder

All Known Implementing Classes:

NonNegativeStep.NonNegativeStepBuilderImpl, NonNegativeStep.NonNegativeStepImpl

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

A class defining a step date and non-negative step value pair. This step definitions are used to define varying rate or amount schedules, e.g. a notional amortisation or a step-up coupon schedule.

Version:

5.30.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	NonNegativeStep.NonNegativeStepBuilder	Builder Interface
static class	NonNegativeStep.NonNegativeStepBuilderImpl	Builder Implementation of NonNegativeStep
static class	NonNegativeStep.NonNegativeStepImpl	Immutable Implementation of NonNegativeStep

Nested classes/interfaces inherited from interface com.rosetta.model.lib.GlobalKey

com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final NonNegativeStepMeta	metaData

Method Summary

Modifier and Type	Method	Description
NonNegativeStep	build()	Build Methods
static NonNegativeStep.NonNegativeStepBuilder	builder()
com.rosetta.model.metafields.MetaFields	getMeta()
com.rosetta.model.lib.records.Date	getStepDate()	The date on which the associated stepValue becomes effective.
BigDecimal	getStepValue()	The non-negative rate or amount which becomes effective on the associated stepDate.
default Class<? extends NonNegativeStep>	getType()
default com.rosetta.model.lib.meta.RosettaMetaData<? extends NonNegativeStep>	metaData()	Utility Methods
default void	process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
NonNegativeStep.NonNegativeStepBuilder	toBuilder()

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

processRosetta, processRosetta

Field Details

metaData

static final NonNegativeStepMeta metaData

Method Details

getStepDate

com.rosetta.model.lib.records.Date getStepDate()

The date on which the associated stepValue becomes effective. This day may be subject to adjustment in accordance with a business day convention.

getStepValue

BigDecimal getStepValue()

The non-negative rate or amount which becomes effective on the associated stepDate. A rate of 5% would be represented as 0.05.

getMeta

com.rosetta.model.metafields.MetaFields getMeta()

Specified by:

getMeta in interface com.rosetta.model.lib.GlobalKey

build

NonNegativeStep build()

Build Methods

Specified by:

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

toBuilder

NonNegativeStep.NonNegativeStepBuilder toBuilder()

Specified by:

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

builder

static NonNegativeStep.NonNegativeStepBuilder builder()

metaData

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

Utility Methods

Specified by:

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

getType

@RuneAttribute("@type")
default Class<? extends NonNegativeStep> 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