Package cdm.base.datetime

Class CalculationPeriodFrequency.CalculationPeriodFrequencyBuilderImpl

java.lang.Object

cdm.base.datetime.Frequency.FrequencyBuilderImpl

cdm.base.datetime.CalculationPeriodFrequency.CalculationPeriodFrequencyBuilderImpl

All Implemented Interfaces:

CalculationPeriodFrequency, CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder, Frequency, Frequency.FrequencyBuilder, com.rosetta.model.lib.GlobalKey, com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder, com.rosetta.model.lib.RosettaModelObject, com.rosetta.model.lib.RosettaModelObjectBuilder

Enclosing interface:

CalculationPeriodFrequency

public static class CalculationPeriodFrequency.CalculationPeriodFrequencyBuilderImpl
extends Frequency.FrequencyBuilderImpl
implements CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder

Builder 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

Modifier and Type	Field	Description
protected Boolean	balanceOfFirstPeriod
protected RollConventionEnum	rollConvention

Fields inherited from class cdm.base.datetime.Frequency.FrequencyBuilderImpl

meta, period, periodMultiplier

Fields inherited from interface cdm.base.datetime.CalculationPeriodFrequency

metaData

Fields inherited from interface cdm.base.datetime.Frequency

metaData

Constructor Summary

Constructors

Constructor	Description
CalculationPeriodFrequencyBuilderImpl()

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.
boolean	hasData()
int	hashCode()
CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder	merge(com.rosetta.model.lib.RosettaModelObjectBuilder other, com.rosetta.model.lib.process.BuilderMerger merger)
CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder	prune()
CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder	setBalanceOfFirstPeriod(Boolean _balanceOfFirstPeriod)
CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder	setMeta(com.rosetta.model.metafields.MetaFields _meta)
CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder	setPeriod(PeriodExtendedEnum _period)
CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder	setPeriodMultiplier(Integer _periodMultiplier)
CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder	setRollConvention(RollConventionEnum _rollConvention)
CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder	toBuilder()
String	toString()

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

getMeta, getOrCreateMeta, getPeriod, getPeriodMultiplier

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.CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder

process

Methods inherited from interface cdm.base.datetime.Frequency

getPeriod, getPeriodMultiplier

Methods inherited from interface cdm.base.datetime.Frequency.FrequencyBuilder

getMeta, getOrCreateMeta

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

processRosetta, processRosetta

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

getIndex, processRosetta, processRosetta

Field Details

rollConvention

protected RollConventionEnum rollConvention

balanceOfFirstPeriod

protected Boolean balanceOfFirstPeriod

Constructor Details

CalculationPeriodFrequencyBuilderImpl

public CalculationPeriodFrequencyBuilderImpl()

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

setPeriodMultiplier

@RosettaAttribute(value="periodMultiplier",
                  isRequired=true)
@RuneAttribute(value="periodMultiplier",
               isRequired=true)
public CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder setPeriodMultiplier(Integer _periodMultiplier)

Specified by:

setPeriodMultiplier in interface CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder

Specified by:

setPeriodMultiplier in interface Frequency.FrequencyBuilder

Overrides:

setPeriodMultiplier in class Frequency.FrequencyBuilderImpl

setPeriod

@RosettaAttribute(value="period",
                  isRequired=true)
@RuneAttribute(value="period",
               isRequired=true)
public CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder setPeriod(PeriodExtendedEnum _period)

Specified by:

setPeriod in interface CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder

Specified by:

setPeriod in interface Frequency.FrequencyBuilder

Overrides:

setPeriod in class Frequency.FrequencyBuilderImpl

setMeta

@RosettaAttribute("meta")
@RuneAttribute("meta")
@RuneMetaType
public CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder setMeta(com.rosetta.model.metafields.MetaFields _meta)

Specified by:

setMeta in interface CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder

Specified by:

setMeta in interface Frequency.FrequencyBuilder

Overrides:

setMeta in class Frequency.FrequencyBuilderImpl

setRollConvention

@RosettaAttribute(value="rollConvention",
                  isRequired=true)
@RuneAttribute(value="rollConvention",
               isRequired=true)
public CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder setRollConvention(RollConventionEnum _rollConvention)

Specified by:

setRollConvention in interface CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder

setBalanceOfFirstPeriod

@RosettaAttribute("balanceOfFirstPeriod")
@RuneAttribute("balanceOfFirstPeriod")
public CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder setBalanceOfFirstPeriod(Boolean _balanceOfFirstPeriod)

Specified by:

setBalanceOfFirstPeriod in interface CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder

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

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

prune

public CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder prune()

Specified by:

prune in interface CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder

Specified by:

prune in interface Frequency.FrequencyBuilder

Specified by:

prune in interface com.rosetta.model.lib.RosettaModelObjectBuilder

Overrides:

prune in class Frequency.FrequencyBuilderImpl

hasData

public boolean hasData()

Specified by:

hasData in interface com.rosetta.model.lib.RosettaModelObjectBuilder

Overrides:

hasData in class Frequency.FrequencyBuilderImpl

merge

public CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder merge(com.rosetta.model.lib.RosettaModelObjectBuilder other,
 com.rosetta.model.lib.process.BuilderMerger merger)

Specified by:

merge in interface com.rosetta.model.lib.RosettaModelObjectBuilder

Overrides:

merge in class Frequency.FrequencyBuilderImpl

equals

public boolean equals(Object o)

Overrides:

equals in class Frequency.FrequencyBuilderImpl

hashCode

public int hashCode()

Overrides:

hashCode in class Frequency.FrequencyBuilderImpl

toString

public String toString()

Overrides:

toString in class Frequency.FrequencyBuilderImpl