Package cdm.product.template

Interface ForwardPayout

All Superinterfaces:

com.rosetta.model.lib.GlobalKey, PayoutBase, com.rosetta.model.lib.RosettaModelObject

All Known Subinterfaces:

ForwardPayout.ForwardPayoutBuilder

All Known Implementing Classes:

ForwardPayout.ForwardPayoutBuilderImpl, ForwardPayout.ForwardPayoutImpl

@RosettaDataType(value="ForwardPayout",
                 builder=ForwardPayoutBuilderImpl.class,
                 version="5.30.0")
@RuneDataType(value="ForwardPayout",
              model="cdm",
              builder=ForwardPayoutBuilderImpl.class,
              version="5.30.0")
public interface ForwardPayout
extends PayoutBase, com.rosetta.model.lib.GlobalKey

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:

5.30.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ForwardPayout.ForwardPayoutBuilder	Builder Interface
static class	ForwardPayout.ForwardPayoutBuilderImpl	Builder Implementation of ForwardPayout
static class	ForwardPayout.ForwardPayoutImpl	Immutable Implementation of ForwardPayout

Nested classes/interfaces inherited from interface com.rosetta.model.lib.GlobalKey

com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder

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 ForwardPayoutMeta	metaData

Method Summary

Modifier and Type	Method	Description
ForwardPayout	build()	Build Methods
static ForwardPayout.ForwardPayoutBuilder	builder()
AssetDeliveryInformation	getDelivery()	Contains the information relative to the delivery of the asset.
String	getDeliveryTerm()	Also called contract month or delivery month.
com.rosetta.model.metafields.MetaFields	getMeta()
CalculationSchedule	getSchedule()	Allows the full representation of a payout by defining a set of schedule periods.
default Class<? extends ForwardPayout>	getType()
Product	getUnderlier()	Underlying product that the forward is written on, which can be of any type: FX, a contractual product, a security, etc.
default com.rosetta.model.lib.meta.RosettaMetaData<? extends ForwardPayout>	metaData()	Utility Methods
default void	process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
ForwardPayout.ForwardPayoutBuilder	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 ForwardPayoutMeta metaData

Method Details

getUnderlier

Product getUnderlier()

Underlying product that the forward is written on, which can be of any type: FX, a contractual product, a security, etc.

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.

getMeta

com.rosetta.model.metafields.MetaFields getMeta()

Specified by:

getMeta in interface com.rosetta.model.lib.GlobalKey

build

ForwardPayout build()

Build Methods

Specified by:

build in interface PayoutBase

Specified by:

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

toBuilder

ForwardPayout.ForwardPayoutBuilder toBuilder()

Specified by:

toBuilder in interface PayoutBase

Specified by:

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

builder

static ForwardPayout.ForwardPayoutBuilder builder()

metaData

default com.rosetta.model.lib.meta.RosettaMetaData<? extends ForwardPayout> 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 ForwardPayout> 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