Package org.isda.cdm

Class Period

  • All Implemented Interfaces:
    com.rosetta.model.lib.GlobalKey
    Direct Known Subclasses:
    Offset

    @RosettaClass
    @RosettaSynonym(value="Period",source="FpML_5_10") @RosettaSynonym(value="Period",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="Period",source="DTCC_11_0") @RosettaSynonym(value="Period",source="DTCC_9_0") @RosettaSynonym(value="Period",source="CME_ClearedConfirm_1_17")
    public class Period
    extends com.rosetta.model.lib.RosettaModelObject
    implements com.rosetta.model.lib.GlobalKey
    A class to define recurring periods or time offsets.
    Version:
    2.5.4
    • Method Detail

      • getMeta

        public final MetaFields getMeta()
        Specified by:
        getMeta in interface com.rosetta.model.lib.GlobalKey
      • getPeriod

        @RosettaSynonym(value="period",source="FpML_5_10") @RosettaSynonym(value="period",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="period",source="DTCC_11_0") @RosettaSynonym(value="period",source="DTCC_9_0") @RosettaSynonym(value="period",source="CME_ClearedConfirm_1_17") @RosettaSynonym(value="period",source="FpML_5_10",path="dateOffset")
        public final PeriodEnum getPeriod()
        A time period, e.g. a day, week, month or year of the stream. If the periodMultiplier value is 0 (zero) then period must contain the value D (day).
      • getPeriodMultiplier

        @RosettaSynonym(value="periodMultiplier",source="FpML_5_10") @RosettaSynonym(value="periodMultiplier",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="periodMultiplier",source="DTCC_11_0") @RosettaSynonym(value="periodMultiplier",source="DTCC_9_0") @RosettaSynonym(value="periodMultiplier",source="CME_ClearedConfirm_1_17") @RosettaSynonym(value="periodMultiplier",source="FpML_5_10",path="dateOffset") @RosettaSynonym(value="periodMultiplier",source="FpML_5_10",path="calculationPeriodDates.relativeEffectiveDate") @RosettaSynonym(value="timely_days,release_days,after_days",source="ISDA_Create_1_0")
        public final java.lang.Integer getPeriodMultiplier()
        A time period multiplier, e.g. 1, 2 or 3 etc. A negative value can be used when specifying an offset relative to another date, e.g. -2 days.
      • metaData

        public com.rosetta.model.lib.meta.RosettaMetaData<? extends Period> metaData()
        Specified by:
        metaData in class com.rosetta.model.lib.RosettaModelObject
      • toBuilder

        public Period.PeriodBuilder toBuilder()
        Specified by:
        toBuilder in class com.rosetta.model.lib.RosettaModelObject
      • process

        public void process​(com.rosetta.model.lib.path.RosettaPath path,
                            com.rosetta.model.lib.process.Processor processor)
        Specified by:
        process in class com.rosetta.model.lib.RosettaModelObject
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object