Package cdm.product.common.schedule
Class PaymentDates.PaymentDatesImpl
java.lang.Object
cdm.product.common.schedule.PaymentDates.PaymentDatesImpl
- All Implemented Interfaces:
PaymentDates,com.rosetta.model.lib.GlobalKey,com.rosetta.model.lib.RosettaModelObject
- Enclosing interface:
PaymentDates
Immutable Implementation of PaymentDates
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.rosetta.model.lib.GlobalKey
com.rosetta.model.lib.GlobalKey.GlobalKeyBuilderNested classes/interfaces inherited from interface cdm.product.common.schedule.PaymentDates
PaymentDates.PaymentDatesBuilder, PaymentDates.PaymentDatesBuilderImpl, PaymentDates.PaymentDatesImpl -
Field Summary
Fields inherited from interface cdm.product.common.schedule.PaymentDates
metaData -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected -
Method Summary
Modifier and TypeMethodDescriptionbuild()Build Methodsbooleancom.rosetta.model.lib.records.DateThe first unadjusted payment date.com.rosetta.model.lib.records.DateThe last regular payment date when specified as a date, as in the FpML interest rate construct.com.rosetta.model.metafields.MetaFieldsgetMeta()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.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.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 frequency at which regular payment dates occur.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.inthashCode()protected voidtoString()Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface cdm.product.common.schedule.PaymentDates
getType, metaData, processMethods inherited from interface com.rosetta.model.lib.RosettaModelObject
processRosetta, processRosetta
-
Constructor Details
-
PaymentDatesImpl
-
-
Method Details
-
getPaymentFrequency
@RosettaAttribute("paymentFrequency") @RuneAttribute("paymentFrequency") public Frequency getPaymentFrequency()Description copied from interface:PaymentDatesThe 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:
getPaymentFrequencyin interfacePaymentDates
-
getFirstPaymentDate
@RosettaAttribute("firstPaymentDate") @RuneAttribute("firstPaymentDate") public com.rosetta.model.lib.records.Date getFirstPaymentDate()Description copied from interface:PaymentDatesThe 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:
getFirstPaymentDatein interfacePaymentDates
-
getLastRegularPaymentDate
@RosettaAttribute("lastRegularPaymentDate") @RuneAttribute("lastRegularPaymentDate") public com.rosetta.model.lib.records.Date getLastRegularPaymentDate()Description copied from interface:PaymentDatesThe 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:
getLastRegularPaymentDatein interfacePaymentDates
-
getPaymentDateSchedule
@RosettaAttribute("paymentDateSchedule") @RuneAttribute("paymentDateSchedule") public PaymentDateSchedule getPaymentDateSchedule()Description copied from interface:PaymentDatesThe 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:
getPaymentDateSchedulein interfacePaymentDates
-
getPayRelativeTo
@RosettaAttribute("payRelativeTo") @RuneAttribute("payRelativeTo") public PayRelativeToEnum getPayRelativeTo()Description copied from interface:PaymentDatesSpecifies 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:
getPayRelativeToin interfacePaymentDates
-
getPaymentDaysOffset
@RosettaAttribute("paymentDaysOffset") @RuneAttribute("paymentDaysOffset") public Offset getPaymentDaysOffset()Description copied from interface:PaymentDatesIf 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:
getPaymentDaysOffsetin interfacePaymentDates
-
getPaymentDatesAdjustments
@RosettaAttribute("paymentDatesAdjustments") @RuneAttribute("paymentDatesAdjustments") public BusinessDayAdjustments getPaymentDatesAdjustments()Description copied from interface:PaymentDatesThe 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:
getPaymentDatesAdjustmentsin interfacePaymentDates
-
getMeta
@RosettaAttribute("meta") @RuneAttribute("meta") @RuneMetaType public com.rosetta.model.metafields.MetaFields getMeta()- Specified by:
getMetain interfacecom.rosetta.model.lib.GlobalKey- Specified by:
getMetain interfacePaymentDates
-
build
Description copied from interface:PaymentDatesBuild Methods- Specified by:
buildin interfacePaymentDates- Specified by:
buildin interfacecom.rosetta.model.lib.RosettaModelObject
-
toBuilder
- Specified by:
toBuilderin interfacePaymentDates- Specified by:
toBuilderin interfacecom.rosetta.model.lib.RosettaModelObject
-
setBuilderFields
-
equals
-
hashCode
public int hashCode() -
toString
-