Package cdm.product.template

Interface ExercisePeriod

All Superinterfaces:

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

All Known Subinterfaces:

ExercisePeriod.ExercisePeriodBuilder

All Known Implementing Classes:

ExercisePeriod.ExercisePeriodBuilderImpl, ExercisePeriod.ExercisePeriodImpl

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

This defines the time interval to the start of the exercise period, i.e. the earliest exercise date, and the frequency of subsequent exercise dates (if any).

Version:

5.30.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ExercisePeriod.ExercisePeriodBuilder	Builder Interface
static class	ExercisePeriod.ExercisePeriodBuilderImpl	Builder Implementation of ExercisePeriod
static class	ExercisePeriod.ExercisePeriodImpl	Immutable Implementation of ExercisePeriod

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 ExercisePeriodMeta	metaData

Method Summary

Modifier and Type	Method	Description
ExercisePeriod	build()	Build Methods
static ExercisePeriod.ExercisePeriodBuilder	builder()
Period	getEarliestExerciseDateTenor()	The time interval to the first (and possibly only) exercise date in the exercise period.
Period	getExerciseFrequency()	The frequency of subsequent exercise dates in the exercise period following the earliest exercise date.
com.rosetta.model.metafields.MetaFields	getMeta()
default Class<? extends ExercisePeriod>	getType()
default com.rosetta.model.lib.meta.RosettaMetaData<? extends ExercisePeriod>	metaData()	Utility Methods
default void	process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
ExercisePeriod.ExercisePeriodBuilder	toBuilder()

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

processRosetta, processRosetta

Field Details

metaData

static final ExercisePeriodMeta metaData

Method Details

getEarliestExerciseDateTenor

Period getEarliestExerciseDateTenor()

The time interval to the first (and possibly only) exercise date in the exercise period.

getExerciseFrequency

Period getExerciseFrequency()

The frequency of subsequent exercise dates in the exercise period following the earliest exercise date. An interval of 1 day should be used to indicate an American style exercise period.

getMeta

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

Specified by:

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

build

ExercisePeriod build()

Build Methods

Specified by:

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

toBuilder

ExercisePeriod.ExercisePeriodBuilder toBuilder()

Specified by:

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

builder

static ExercisePeriod.ExercisePeriodBuilder builder()

metaData

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

Utility Methods

Specified by:

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

getType

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