Package cdm.product.common.schedule

Class PaymentDates.PaymentDatesBuilderImpl

java.lang.Object

cdm.product.common.schedule.PaymentDates.PaymentDatesBuilderImpl

All Implemented Interfaces:

PaymentDates, PaymentDates.PaymentDatesBuilder, com.rosetta.model.lib.GlobalKey, com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder, com.rosetta.model.lib.RosettaModelObject, com.rosetta.model.lib.RosettaModelObjectBuilder

Enclosing interface:

PaymentDates

public static class PaymentDates.PaymentDatesBuilderImpl
extends Object
implements PaymentDates.PaymentDatesBuilder

Builder Implementation of PaymentDates

Nested Class Summary

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

com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder

Nested classes/interfaces inherited from interface cdm.product.common.schedule.PaymentDates

PaymentDates.PaymentDatesBuilder, PaymentDates.PaymentDatesBuilderImpl, PaymentDates.PaymentDatesImpl

Field Summary

Fields

Modifier and Type	Field	Description
protected com.rosetta.model.lib.records.Date	firstPaymentDate
protected com.rosetta.model.lib.records.Date	lastRegularPaymentDate
protected com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder	meta
protected BusinessDayAdjustments.BusinessDayAdjustmentsBuilder	paymentDatesAdjustments
protected PaymentDateSchedule.PaymentDateScheduleBuilder	paymentDateSchedule
protected Offset.OffsetBuilder	paymentDaysOffset
protected Frequency.FrequencyBuilder	paymentFrequency
protected PayRelativeToEnum	payRelativeTo

Fields inherited from interface cdm.product.common.schedule.PaymentDates

metaData

Constructor Summary

Constructors

Constructor	Description
PaymentDatesBuilderImpl()

Method Summary

Modifier and Type	Method	Description
PaymentDates	build()	Build Methods
boolean	equals(Object o)
com.rosetta.model.lib.records.Date	getFirstPaymentDate()	The first unadjusted payment date.
com.rosetta.model.lib.records.Date	getLastRegularPaymentDate()	The last regular payment date when specified as a date, as in the FpML interest rate construct.
com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder	getMeta()
com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder	getOrCreateMeta()
BusinessDayAdjustments.BusinessDayAdjustmentsBuilder	getOrCreatePaymentDatesAdjustments()
PaymentDateSchedule.PaymentDateScheduleBuilder	getOrCreatePaymentDateSchedule()
Offset.OffsetBuilder	getOrCreatePaymentDaysOffset()
Frequency.FrequencyBuilder	getOrCreatePaymentFrequency()
BusinessDayAdjustments.BusinessDayAdjustmentsBuilder	getPaymentDatesAdjustments()	The definition of the business day convention and financial business centers used for adjusting the payment date if it would otherwise fall on a day that is not a business day in the specified business center.
PaymentDateSchedule.PaymentDateScheduleBuilder	getPaymentDateSchedule()	The payment dates when specified as relative to a set of dates specified somewhere else in the instance document/transaction, e.g. the valuation dates as typically the case for equity swaps, or when specified as a calculation period schedule.
Offset.OffsetBuilder	getPaymentDaysOffset()	If early payment or delayed payment is required, specifies the number of days offset that the payment occurs relative to what would otherwise be the unadjusted payment date.
Frequency.FrequencyBuilder	getPaymentFrequency()	The frequency at which regular payment dates occur.
PayRelativeToEnum	getPayRelativeTo()	Specifies whether the payments occur relative to each adjusted calculation period start date or end date, each reset date, valuation date or the last pricing date.
boolean	hasData()
int	hashCode()
PaymentDates.PaymentDatesBuilder	merge(com.rosetta.model.lib.RosettaModelObjectBuilder other, com.rosetta.model.lib.process.BuilderMerger merger)
PaymentDates.PaymentDatesBuilder	prune()
PaymentDates.PaymentDatesBuilder	setFirstPaymentDate(com.rosetta.model.lib.records.Date _firstPaymentDate)
PaymentDates.PaymentDatesBuilder	setLastRegularPaymentDate(com.rosetta.model.lib.records.Date _lastRegularPaymentDate)
PaymentDates.PaymentDatesBuilder	setMeta(com.rosetta.model.metafields.MetaFields _meta)
PaymentDates.PaymentDatesBuilder	setPaymentDatesAdjustments(BusinessDayAdjustments _paymentDatesAdjustments)
PaymentDates.PaymentDatesBuilder	setPaymentDateSchedule(PaymentDateSchedule _paymentDateSchedule)
PaymentDates.PaymentDatesBuilder	setPaymentDaysOffset(Offset _paymentDaysOffset)
PaymentDates.PaymentDatesBuilder	setPaymentFrequency(Frequency _paymentFrequency)
PaymentDates.PaymentDatesBuilder	setPayRelativeTo(PayRelativeToEnum _payRelativeTo)
PaymentDates.PaymentDatesBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface cdm.product.common.schedule.PaymentDates

getType, metaData, process

Methods inherited from interface cdm.product.common.schedule.PaymentDates.PaymentDatesBuilder

process

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

paymentFrequency

protected Frequency.FrequencyBuilder paymentFrequency

firstPaymentDate

protected com.rosetta.model.lib.records.Date firstPaymentDate

lastRegularPaymentDate

protected com.rosetta.model.lib.records.Date lastRegularPaymentDate

paymentDateSchedule

protected PaymentDateSchedule.PaymentDateScheduleBuilder paymentDateSchedule

payRelativeTo

protected PayRelativeToEnum payRelativeTo

paymentDaysOffset

protected Offset.OffsetBuilder paymentDaysOffset

paymentDatesAdjustments

protected BusinessDayAdjustments.BusinessDayAdjustmentsBuilder paymentDatesAdjustments

meta

protected com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder meta

Constructor Details

PaymentDatesBuilderImpl

public PaymentDatesBuilderImpl()

Method Details

getPaymentFrequency

@RosettaAttribute("paymentFrequency")
@RuneAttribute("paymentFrequency")
public Frequency.FrequencyBuilder getPaymentFrequency()

Description copied from interface: PaymentDates

The frequency at which regular payment dates occur. If the payment frequency is equal to the frequency defined in the calculation period dates component then one calculation period contributes to each payment amount. If the payment frequency is less frequent than the frequency defined in the calculation period dates component then more than one calculation period will contribute to the payment amount. A payment frequency more frequent than the calculation period frequency or one that is not a multiple of the calculation period frequency is invalid. If the payment frequency is of value T (term), the period is defined by the effectiveDate and the terminationDate.

Specified by:

getPaymentFrequency in interface PaymentDates

Specified by:

getPaymentFrequency in interface PaymentDates.PaymentDatesBuilder

getOrCreatePaymentFrequency

public Frequency.FrequencyBuilder getOrCreatePaymentFrequency()

Specified by:

getOrCreatePaymentFrequency in interface PaymentDates.PaymentDatesBuilder

getFirstPaymentDate

@RosettaAttribute("firstPaymentDate")
@RuneAttribute("firstPaymentDate")
public com.rosetta.model.lib.records.Date getFirstPaymentDate()

Description copied from interface: PaymentDates

The first unadjusted payment date. This day may be subject to adjustment in accordance with any business day convention specified in paymentDatesAdjustments. This element must only be included if there is an initial stub. This date will normally correspond to an unadjusted calculation period start or end date. This is true even if early or delayed payment is specified to be applicable since the actual first payment date will be the specified number of days before or after the applicable adjusted calculation period start or end date with the resulting payment date then being adjusted in accordance with any business day convention specified in paymentDatesAdjustments.

Specified by:

getFirstPaymentDate in interface PaymentDates

getLastRegularPaymentDate

@RosettaAttribute("lastRegularPaymentDate")
@RuneAttribute("lastRegularPaymentDate")
public com.rosetta.model.lib.records.Date getLastRegularPaymentDate()

Description copied from interface: PaymentDates

The last regular payment date when specified as a date, as in the FpML interest rate construct. FpML specifies that this date may be subject to adjustment in accordance with any business day convention specified in the paymentDatesAdjustments attribute.

Specified by:

getLastRegularPaymentDate in interface PaymentDates

getPaymentDateSchedule

@RosettaAttribute("paymentDateSchedule")
@RuneAttribute("paymentDateSchedule")
public PaymentDateSchedule.PaymentDateScheduleBuilder getPaymentDateSchedule()

Description copied from interface: PaymentDates

The payment dates when specified as relative to a set of dates specified somewhere else in the instance document/transaction, e.g. the valuation dates as typically the case for equity swaps, or when specified as a calculation period schedule.

Specified by:

getPaymentDateSchedule in interface PaymentDates

Specified by:

getPaymentDateSchedule in interface PaymentDates.PaymentDatesBuilder

getOrCreatePaymentDateSchedule

public PaymentDateSchedule.PaymentDateScheduleBuilder getOrCreatePaymentDateSchedule()

Specified by:

getOrCreatePaymentDateSchedule in interface PaymentDates.PaymentDatesBuilder

getPayRelativeTo

@RosettaAttribute("payRelativeTo")
@RuneAttribute("payRelativeTo")
public PayRelativeToEnum getPayRelativeTo()

Description copied from interface: PaymentDates

Specifies whether the payments occur relative to each adjusted calculation period start date or end date, each reset date, valuation date or the last pricing date. Calculation period start date means relative to the start of the first calculation period contributing to a given payment. Similarly, calculation period end date means the end of the last calculation period contributing to a given payment. The valuation date is applicable for Brazilian-CDI and equity swaps.

Specified by:

getPayRelativeTo in interface PaymentDates

getPaymentDaysOffset

@RosettaAttribute("paymentDaysOffset")
@RuneAttribute("paymentDaysOffset")
public Offset.OffsetBuilder getPaymentDaysOffset()

Description copied from interface: PaymentDates

If early payment or delayed payment is required, specifies the number of days offset that the payment occurs relative to what would otherwise be the unadjusted payment date. The offset can be specified in terms of either calendar or business days. Even in the case of a calendar days offset, the resulting payment date, adjusted for the specified calendar days offset, will still be adjusted in accordance with the specified payment dates adjustments. This element should only be included if early or delayed payment is applicable, i.e. if the periodMultiplier element value is not equal to zero. An early payment would be indicated by a negative periodMultiplier element value and a delayed payment (or payment lag) would be indicated by a positive periodMultiplier element value.

Specified by:

getPaymentDaysOffset in interface PaymentDates

Specified by:

getPaymentDaysOffset in interface PaymentDates.PaymentDatesBuilder

getOrCreatePaymentDaysOffset

public Offset.OffsetBuilder getOrCreatePaymentDaysOffset()

Specified by:

getOrCreatePaymentDaysOffset in interface PaymentDates.PaymentDatesBuilder

getPaymentDatesAdjustments

@RosettaAttribute("paymentDatesAdjustments")
@RuneAttribute("paymentDatesAdjustments")
public BusinessDayAdjustments.BusinessDayAdjustmentsBuilder getPaymentDatesAdjustments()

Description copied from interface: PaymentDates

The definition of the business day convention and financial business centers used for adjusting the payment date if it would otherwise fall on a day that is not a business day in the specified business center.

Specified by:

getPaymentDatesAdjustments in interface PaymentDates

Specified by:

getPaymentDatesAdjustments in interface PaymentDates.PaymentDatesBuilder

getOrCreatePaymentDatesAdjustments

public BusinessDayAdjustments.BusinessDayAdjustmentsBuilder getOrCreatePaymentDatesAdjustments()

Specified by:

getOrCreatePaymentDatesAdjustments in interface PaymentDates.PaymentDatesBuilder

getMeta

@RosettaAttribute("meta")
@RuneAttribute("meta")
@RuneMetaType
public com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder getMeta()

Specified by:

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

Specified by:

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

Specified by:

getMeta in interface PaymentDates

Specified by:

getMeta in interface PaymentDates.PaymentDatesBuilder

getOrCreateMeta

public com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder getOrCreateMeta()

Specified by:

getOrCreateMeta in interface com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder

Specified by:

getOrCreateMeta in interface PaymentDates.PaymentDatesBuilder

setPaymentFrequency

@RosettaAttribute("paymentFrequency")
@RuneAttribute("paymentFrequency")
public PaymentDates.PaymentDatesBuilder setPaymentFrequency(Frequency _paymentFrequency)

Specified by:

setPaymentFrequency in interface PaymentDates.PaymentDatesBuilder

setFirstPaymentDate

@RosettaAttribute("firstPaymentDate")
@RuneAttribute("firstPaymentDate")
public PaymentDates.PaymentDatesBuilder setFirstPaymentDate(com.rosetta.model.lib.records.Date _firstPaymentDate)

Specified by:

setFirstPaymentDate in interface PaymentDates.PaymentDatesBuilder

setLastRegularPaymentDate

@RosettaAttribute("lastRegularPaymentDate")
@RuneAttribute("lastRegularPaymentDate")
public PaymentDates.PaymentDatesBuilder setLastRegularPaymentDate(com.rosetta.model.lib.records.Date _lastRegularPaymentDate)

Specified by:

setLastRegularPaymentDate in interface PaymentDates.PaymentDatesBuilder

setPaymentDateSchedule

@RosettaAttribute("paymentDateSchedule")
@RuneAttribute("paymentDateSchedule")
public PaymentDates.PaymentDatesBuilder setPaymentDateSchedule(PaymentDateSchedule _paymentDateSchedule)

Specified by:

setPaymentDateSchedule in interface PaymentDates.PaymentDatesBuilder

setPayRelativeTo

@RosettaAttribute("payRelativeTo")
@RuneAttribute("payRelativeTo")
public PaymentDates.PaymentDatesBuilder setPayRelativeTo(PayRelativeToEnum _payRelativeTo)

Specified by:

setPayRelativeTo in interface PaymentDates.PaymentDatesBuilder

setPaymentDaysOffset

@RosettaAttribute("paymentDaysOffset")
@RuneAttribute("paymentDaysOffset")
public PaymentDates.PaymentDatesBuilder setPaymentDaysOffset(Offset _paymentDaysOffset)

Specified by:

setPaymentDaysOffset in interface PaymentDates.PaymentDatesBuilder

setPaymentDatesAdjustments

@RosettaAttribute("paymentDatesAdjustments")
@RuneAttribute("paymentDatesAdjustments")
public PaymentDates.PaymentDatesBuilder setPaymentDatesAdjustments(BusinessDayAdjustments _paymentDatesAdjustments)

Specified by:

setPaymentDatesAdjustments in interface PaymentDates.PaymentDatesBuilder

setMeta

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

Specified by:

setMeta in interface PaymentDates.PaymentDatesBuilder

build

public PaymentDates build()

Description copied from interface: PaymentDates

Build Methods

Specified by:

build in interface PaymentDates

Specified by:

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

toBuilder

public PaymentDates.PaymentDatesBuilder toBuilder()

Specified by:

toBuilder in interface PaymentDates

Specified by:

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

prune

public PaymentDates.PaymentDatesBuilder prune()

Specified by:

prune in interface PaymentDates.PaymentDatesBuilder

Specified by:

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

hasData

public boolean hasData()

Specified by:

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

merge

public PaymentDates.PaymentDatesBuilder merge(com.rosetta.model.lib.RosettaModelObjectBuilder other,
 com.rosetta.model.lib.process.BuilderMerger merger)

Specified by:

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object