Package cdm.base.datetime

Class CalculationPeriodFrequency.CalculationPeriodFrequencyImpl

java.lang.Object

cdm.base.datetime.Frequency.FrequencyImpl

cdm.base.datetime.CalculationPeriodFrequency.CalculationPeriodFrequencyImpl

All Implemented Interfaces:

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

Enclosing interface:

CalculationPeriodFrequency

public static class CalculationPeriodFrequency.CalculationPeriodFrequencyImpl
extends Frequency.FrequencyImpl
implements CalculationPeriodFrequency

Immutable Implementation of CalculationPeriodFrequency

Nested Class Summary

Nested classes/interfaces inherited from interface cdm.base.datetime.CalculationPeriodFrequency

CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder, CalculationPeriodFrequency.CalculationPeriodFrequencyBuilderImpl, CalculationPeriodFrequency.CalculationPeriodFrequencyImpl

Nested classes/interfaces inherited from interface cdm.base.datetime.Frequency

Frequency.FrequencyBuilder, Frequency.FrequencyBuilderImpl, Frequency.FrequencyImpl

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

com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder

Field Summary

Fields inherited from interface cdm.base.datetime.CalculationPeriodFrequency

metaData

Fields inherited from interface cdm.base.datetime.Frequency

metaData

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CalculationPeriodFrequencyImpl(CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder builder)

Method Summary

Modifier and Type	Method	Description
CalculationPeriodFrequency	build()	Build Methods
boolean	equals(Object o)
Boolean	getBalanceOfFirstPeriod()	Indicates, when true, that that the first Calculation Period should run from the Effective Date to the end of the calendar period in which the Effective Date falls, e.g.
RollConventionEnum	getRollConvention()	The roll convention specifies the period term as part of a periodic schedule, i.e. the calculation period end date within the regular part of the calculation period.
int	hashCode()
protected void	setBuilderFields(CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder builder)
CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder	toBuilder()
String	toString()

Methods inherited from class cdm.base.datetime.Frequency.FrequencyImpl

getMeta, getPeriod, getPeriodMultiplier, setBuilderFields

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface cdm.base.datetime.CalculationPeriodFrequency

getType, metaData, process

Methods inherited from interface cdm.base.datetime.Frequency

getMeta, getPeriod, getPeriodMultiplier

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

processRosetta, processRosetta

Constructor Details

CalculationPeriodFrequencyImpl

protected CalculationPeriodFrequencyImpl(CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder builder)

Method Details

getRollConvention

@RosettaAttribute(value="rollConvention",
                  isRequired=true)
@RuneAttribute(value="rollConvention",
               isRequired=true)
public RollConventionEnum getRollConvention()

Description copied from interface: CalculationPeriodFrequency

The roll convention specifies the period term as part of a periodic schedule, i.e. the calculation period end date within the regular part of the calculation period. The value could be a rule, e.g. IMM Settlement Dates, which is the 3rd Wednesday of the month, or it could be a specific day of the month, such as the first day of the applicable month. It is used in conjunction with a frequency and the regular period start date of a calculation period.

Specified by:

getRollConvention in interface CalculationPeriodFrequency

getBalanceOfFirstPeriod

@RosettaAttribute("balanceOfFirstPeriod")
@RuneAttribute("balanceOfFirstPeriod")
public Boolean getBalanceOfFirstPeriod()

Description copied from interface: CalculationPeriodFrequency

Indicates, when true, that that the first Calculation Period should run from the Effective Date to the end of the calendar period in which the Effective Date falls, e.g. Jan 15 - Jan 31 if the calculation periods are one month long and Effective Date is Jan 15. If false, the first Calculation Period should run from the Effective Date for one whole period, e.g. Jan 15 to Feb 14 if the calculation periods are one month long and Effective Date is Jan 15. Mostly used in Commmodity Swaps.

Specified by:

getBalanceOfFirstPeriod in interface CalculationPeriodFrequency

build

public CalculationPeriodFrequency build()

Description copied from interface: Frequency

Build Methods

Specified by:

build in interface CalculationPeriodFrequency

Specified by:

build in interface Frequency

Specified by:

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

Overrides:

build in class Frequency.FrequencyImpl

toBuilder

public CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder toBuilder()

Specified by:

toBuilder in interface CalculationPeriodFrequency

Specified by:

toBuilder in interface Frequency

Specified by:

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

Overrides:

toBuilder in class Frequency.FrequencyImpl

setBuilderFields

protected void setBuilderFields(CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder builder)

equals

public boolean equals(Object o)

Overrides:

equals in class Frequency.FrequencyImpl

hashCode

public int hashCode()

Overrides:

hashCode in class Frequency.FrequencyImpl

toString

public String toString()

Overrides:

toString in class Frequency.FrequencyImpl