Package cdm.product.common.schedule

Interface PaymentDates.PaymentDatesBuilder

All Superinterfaces:
com.rosetta.model.lib.GlobalKey, com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder, PaymentDates, com.rosetta.model.lib.RosettaModelObject, com.rosetta.model.lib.RosettaModelObjectBuilder
All Known Implementing Classes:
PaymentDates.PaymentDatesBuilderImpl
Enclosing interface:
PaymentDates
public static interface PaymentDates.PaymentDatesBuilder extends PaymentDates, com.rosetta.model.lib.RosettaModelObjectBuilder, com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder
Builder Interface

  • Method Details

    • getOrCreatePaymentFrequency

      Frequency.FrequencyBuilder getOrCreatePaymentFrequency()

    • getPaymentFrequency

      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

    • getOrCreatePaymentDateSchedule

      PaymentDateSchedule.PaymentDateScheduleBuilder getOrCreatePaymentDateSchedule()

    • getPaymentDateSchedule

      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

    • getOrCreatePaymentDaysOffset

      Offset.OffsetBuilder getOrCreatePaymentDaysOffset()

    • getPaymentDaysOffset

      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

    • getOrCreatePaymentDatesAdjustments

      BusinessDayAdjustments.BusinessDayAdjustmentsBuilder getOrCreatePaymentDatesAdjustments()

    • getPaymentDatesAdjustments

      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

    • getOrCreateMeta

      com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder getOrCreateMeta()
      Specified by:
      getOrCreateMeta in interface com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder

    • getMeta

      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

    • setPaymentFrequency

      PaymentDates.PaymentDatesBuilder setPaymentFrequency(Frequency paymentFrequency)

    • setFirstPaymentDate

      PaymentDates.PaymentDatesBuilder setFirstPaymentDate(com.rosetta.model.lib.records.Date firstPaymentDate)

    • setLastRegularPaymentDate

      PaymentDates.PaymentDatesBuilder setLastRegularPaymentDate(com.rosetta.model.lib.records.Date lastRegularPaymentDate)

    • setPaymentDateSchedule

      PaymentDates.PaymentDatesBuilder setPaymentDateSchedule(PaymentDateSchedule paymentDateSchedule)

    • setPayRelativeTo

      PaymentDates.PaymentDatesBuilder setPayRelativeTo(PayRelativeToEnum payRelativeTo)

    • setPaymentDaysOffset

      PaymentDates.PaymentDatesBuilder setPaymentDaysOffset(Offset paymentDaysOffset)

    • setPaymentDatesAdjustments

      PaymentDates.PaymentDatesBuilder setPaymentDatesAdjustments(BusinessDayAdjustments paymentDatesAdjustments)

    • setMeta

      PaymentDates.PaymentDatesBuilder setMeta(com.rosetta.model.metafields.MetaFields meta)

    • process

      default void process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.BuilderProcessor processor)
      Specified by:
      process in interface com.rosetta.model.lib.RosettaModelObjectBuilder

    • prune

      PaymentDates.PaymentDatesBuilder prune()
      Specified by:
      prune in interface com.rosetta.model.lib.RosettaModelObjectBuilder