Package cdm.product.template

Interface SettlementPayout

All Superinterfaces:

PayoutBase, com.rosetta.model.lib.RosettaModelObject

All Known Subinterfaces:

SettlementPayout.SettlementPayoutBuilder

All Known Implementing Classes:

SettlementPayout.SettlementPayoutBuilderImpl, SettlementPayout.SettlementPayoutImpl

@RosettaDataType(value="SettlementPayout",
                 builder=SettlementPayoutBuilderImpl.class,
                 version="7.0.0-dev.105")
@RuneDataType(value="SettlementPayout",
              model="cdm",
              builder=SettlementPayoutBuilderImpl.class,
              version="7.0.0-dev.105")
public interface SettlementPayout
extends PayoutBase

Represents a forward settling payout. The underlier attribute captures the underlying payout, which is settled according to the settlementTerms attribute (which is part of PayoutBase). Both FX Spot and FX Forward should use this component.

Version:

7.0.0-dev.105

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SettlementPayout.SettlementPayoutBuilder	Builder Interface
static class	SettlementPayout.SettlementPayoutBuilderImpl	Builder Implementation of SettlementPayout
static class	SettlementPayout.SettlementPayoutImpl	Immutable Implementation of SettlementPayout

Nested classes/interfaces inherited from interface cdm.product.common.settlement.PayoutBase

PayoutBase.PayoutBaseBuilder, PayoutBase.PayoutBaseBuilderImpl, PayoutBase.PayoutBaseImpl

Field Summary

Fields

Modifier and Type	Field	Description
static final SettlementPayoutMeta	metaData

Method Summary

Modifier and Type	Method	Description
SettlementPayout	build()	Build Methods
static SettlementPayout.SettlementPayoutBuilder	builder()
AssetDeliveryInformation	getDelivery()	Contains the information relative to the delivery of the asset.
String	getDeliveryTerm()	Also called contract month or delivery month.
CalculationSchedule	getSchedule()	Allows the full representation of a payout by defining a set of schedule periods.
default Class<? extends SettlementPayout>	getType()
Underlier	getUnderlier()	The underlying financial product that will be physically or cash settled, which can be of any type, eg an asset such as cash or a security, or the cash settlement of an index rate.
default com.rosetta.model.lib.meta.RosettaMetaData<? extends SettlementPayout>	metaData()	Utility Methods
default void	process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
SettlementPayout.SettlementPayoutBuilder	toBuilder()

Methods inherited from interface cdm.product.common.settlement.PayoutBase

getPayerReceiver, getPriceQuantity, getPrincipalPayment, getSettlementTerms

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

processRosetta, processRosetta

Field Details

metaData

static final SettlementPayoutMeta metaData

Method Details

getUnderlier

Underlier getUnderlier()

The underlying financial product that will be physically or cash settled, which can be of any type, eg an asset such as cash or a security, or the cash settlement of an index rate.

getDeliveryTerm

String getDeliveryTerm()

Also called contract month or delivery month. However, it's not always a month. It is usually expressed using a code, e.g. Z23 would be the Dec 2023 contract, (Z = December). For crude oil, the corresponding contract might be called CLZ23.

getDelivery

AssetDeliveryInformation getDelivery()

Contains the information relative to the delivery of the asset.

getSchedule

CalculationSchedule getSchedule()

Allows the full representation of a payout by defining a set of schedule periods. It supports standard schedule customization by expressing all the dates, quantities, and pricing data in a non-parametric way.

build

SettlementPayout build()

Build Methods

Specified by:

build in interface PayoutBase

Specified by:

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

toBuilder

SettlementPayout.SettlementPayoutBuilder toBuilder()

Specified by:

toBuilder in interface PayoutBase

Specified by:

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

builder

static SettlementPayout.SettlementPayoutBuilder builder()

metaData

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

Utility Methods

Specified by:

metaData in interface PayoutBase

Specified by:

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

getType

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

Specified by:

getType in interface PayoutBase

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 PayoutBase

Specified by:

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