Package cdm.product.asset

Interface DividendDateReference

All Superinterfaces:

com.rosetta.model.lib.RosettaModelObject

All Known Subinterfaces:

DividendDateReference.DividendDateReferenceBuilder

All Known Implementing Classes:

DividendDateReference.DividendDateReferenceBuilderImpl, DividendDateReference.DividendDateReferenceImpl

@RosettaDataType(value="DividendDateReference",
                 builder=DividendDateReferenceBuilderImpl.class,
                 version="5.30.0")
@RuneDataType(value="DividendDateReference",
              model="cdm",
              builder=DividendDateReferenceBuilderImpl.class,
              version="5.30.0")
public interface DividendDateReference
extends com.rosetta.model.lib.RosettaModelObject

A class to specify the dividend date by reference to another date, with the ability to apply and offset. This class doesn't exist in FpML and is meant to simplify the choice constraint associated with the DividendPaymentDate class.

Version:

5.30.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DividendDateReference.DividendDateReferenceBuilder	Builder Interface
static class	DividendDateReference.DividendDateReferenceBuilderImpl	Builder Implementation of DividendDateReference
static class	DividendDateReference.DividendDateReferenceImpl	Immutable Implementation of DividendDateReference

Field Summary

Fields

Modifier and Type	Field	Description
static final DividendDateReferenceMeta	metaData

Method Summary

Modifier and Type	Method	Description
DividendDateReference	build()	Build Methods
static DividendDateReference.DividendDateReferenceBuilder	builder()
DividendDateReferenceEnum	getDateReference()	Specification of the dividend date using an enumeration, with values such as the pay date, the ex-date or the record date.
Offset	getPaymentDateOffset()	Only to be used when SharePayment has been specified in the dividendDateReference element.
default Class<? extends DividendDateReference>	getType()
default com.rosetta.model.lib.meta.RosettaMetaData<? extends DividendDateReference>	metaData()	Utility Methods
default void	process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
DividendDateReference.DividendDateReferenceBuilder	toBuilder()

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

processRosetta, processRosetta

Field Details

metaData

static final DividendDateReferenceMeta metaData

Method Details

getDateReference

DividendDateReferenceEnum getDateReference()

Specification of the dividend date using an enumeration, with values such as the pay date, the ex-date or the record date.

getPaymentDateOffset

Offset getPaymentDateOffset()

Only to be used when SharePayment has been specified in the dividendDateReference element. The number of Currency Business Days following the day on which the Issuer of the Shares pays the relevant dividend to holders of record of the Shares.

build

DividendDateReference build()

Build Methods

Specified by:

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

toBuilder

DividendDateReference.DividendDateReferenceBuilder toBuilder()

Specified by:

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

builder

static DividendDateReference.DividendDateReferenceBuilder builder()

metaData

default com.rosetta.model.lib.meta.RosettaMetaData<? extends DividendDateReference> metaData()

Utility Methods

Specified by:

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

getType

@RuneAttribute("@type")
default Class<? extends DividendDateReference> getType()

Specified by:

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

process

default void process(com.rosetta.model.lib.path.RosettaPath path,
 com.rosetta.model.lib.process.Processor processor)

Specified by:

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