Package cdm.product.template

Interface Payout.PayoutBuilder

All Superinterfaces:

com.rosetta.model.lib.GlobalKey, com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder, Payout, com.rosetta.model.lib.RosettaModelObject, com.rosetta.model.lib.RosettaModelObjectBuilder

All Known Implementing Classes:

Payout.PayoutBuilderImpl

Enclosing interface:

Payout

public static interface Payout.PayoutBuilder
extends Payout, com.rosetta.model.lib.RosettaModelObjectBuilder, com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder

Builder Interface

Nested Class Summary

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.template.Payout

Payout.PayoutBuilder, Payout.PayoutBuilderImpl, Payout.PayoutImpl

Field Summary

Fields inherited from interface cdm.product.template.Payout

metaData

Method Summary

Modifier and Type	Method	Description
AssetPayout.AssetPayoutBuilder	getAssetPayout()	Defines the assets and movements in a security financing transaction.
CommodityPayout.CommodityPayoutBuilder	getCommodityPayout()	Defines the payout for the floating leg of a Commodity Swap.
CreditDefaultPayout.CreditDefaultPayoutBuilder	getCreditDefaultPayout()	The credit default payout, which provides the details necessary for determining when a credit payout will be triggered as well as the parameters for calculating the payout and the settlement terms.
FixedPricePayout.FixedPricePayoutBuilder	getFixedPricePayout()	Defines a payout in which one or more payouts are defined as a fixed price.
InterestRatePayout.InterestRatePayoutBuilder	getInterestRatePayout()	All of the terms necessary to define and calculate a cash flow based on a fixed, a floating or an inflation index rate.
com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder	getMeta()
OptionPayout.OptionPayoutBuilder	getOptionPayout()	The option payout.
AssetPayout.AssetPayoutBuilder	getOrCreateAssetPayout()
CommodityPayout.CommodityPayoutBuilder	getOrCreateCommodityPayout()
CreditDefaultPayout.CreditDefaultPayoutBuilder	getOrCreateCreditDefaultPayout()
FixedPricePayout.FixedPricePayoutBuilder	getOrCreateFixedPricePayout()
InterestRatePayout.InterestRatePayoutBuilder	getOrCreateInterestRatePayout()
com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder	getOrCreateMeta()
OptionPayout.OptionPayoutBuilder	getOrCreateOptionPayout()
PerformancePayout.PerformancePayoutBuilder	getOrCreatePerformancePayout()
SettlementPayout.SettlementPayoutBuilder	getOrCreateSettlementPayout()
PerformancePayout.PerformancePayoutBuilder	getPerformancePayout()	The performance payout, which encompasses the equity price returns, dividend returns, volatility return, variance return and correlation provisions.
SettlementPayout.SettlementPayoutBuilder	getSettlementPayout()	Represents a forward settling payout.
default void	process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.BuilderProcessor processor)
Payout.PayoutBuilder	prune()
Payout.PayoutBuilder	setAssetPayout(AssetPayout _AssetPayout)
Payout.PayoutBuilder	setCommodityPayout(CommodityPayout _CommodityPayout)
Payout.PayoutBuilder	setCreditDefaultPayout(CreditDefaultPayout _CreditDefaultPayout)
Payout.PayoutBuilder	setFixedPricePayout(FixedPricePayout _FixedPricePayout)
Payout.PayoutBuilder	setInterestRatePayout(InterestRatePayout _InterestRatePayout)
Payout.PayoutBuilder	setMeta(com.rosetta.model.metafields.MetaFields meta)
Payout.PayoutBuilder	setOptionPayout(OptionPayout _OptionPayout)
Payout.PayoutBuilder	setPerformancePayout(PerformancePayout _PerformancePayout)
Payout.PayoutBuilder	setSettlementPayout(SettlementPayout _SettlementPayout)

Methods inherited from interface cdm.product.template.Payout

build, getType, metaData, process, toBuilder

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

processRosetta, processRosetta

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

getIndex, hasData, merge, processRosetta, processRosetta

Method Details

getOrCreateAssetPayout

AssetPayout.AssetPayoutBuilder getOrCreateAssetPayout()

getAssetPayout

AssetPayout.AssetPayoutBuilder getAssetPayout()

Description copied from interface: Payout

Defines the assets and movements in a security financing transaction.

Specified by:

getAssetPayout in interface Payout

getOrCreateCommodityPayout

CommodityPayout.CommodityPayoutBuilder getOrCreateCommodityPayout()

getCommodityPayout

CommodityPayout.CommodityPayoutBuilder getCommodityPayout()

Description copied from interface: Payout

Defines the payout for the floating leg of a Commodity Swap.

Specified by:

getCommodityPayout in interface Payout

getOrCreateCreditDefaultPayout

CreditDefaultPayout.CreditDefaultPayoutBuilder getOrCreateCreditDefaultPayout()

getCreditDefaultPayout

CreditDefaultPayout.CreditDefaultPayoutBuilder getCreditDefaultPayout()

Description copied from interface: Payout

The credit default payout, which provides the details necessary for determining when a credit payout will be triggered as well as the parameters for calculating the payout and the settlement terms.

Specified by:

getCreditDefaultPayout in interface Payout

getOrCreateFixedPricePayout

FixedPricePayout.FixedPricePayoutBuilder getOrCreateFixedPricePayout()

getFixedPricePayout

FixedPricePayout.FixedPricePayoutBuilder getFixedPricePayout()

Description copied from interface: Payout

Defines a payout in which one or more payouts are defined as a fixed price.

Specified by:

getFixedPricePayout in interface Payout

getOrCreateInterestRatePayout

InterestRatePayout.InterestRatePayoutBuilder getOrCreateInterestRatePayout()

getInterestRatePayout

InterestRatePayout.InterestRatePayoutBuilder getInterestRatePayout()

Description copied from interface: Payout

All of the terms necessary to define and calculate a cash flow based on a fixed, a floating or an inflation index rate. The interest rate payout can be applied to interest rate swaps and FRA (which both have two associated interest rate payouts), credit default swaps (to represent the fee leg when subject to periodic payments) and equity swaps (to represent the funding leg).

Specified by:

getInterestRatePayout in interface Payout

getOrCreateOptionPayout

OptionPayout.OptionPayoutBuilder getOrCreateOptionPayout()

getOptionPayout

OptionPayout.OptionPayoutBuilder getOptionPayout()

Description copied from interface: Payout

The option payout.

Specified by:

getOptionPayout in interface Payout

getOrCreatePerformancePayout

PerformancePayout.PerformancePayoutBuilder getOrCreatePerformancePayout()

getPerformancePayout

PerformancePayout.PerformancePayoutBuilder getPerformancePayout()

Description copied from interface: Payout

The performance payout, which encompasses the equity price returns, dividend returns, volatility return, variance return and correlation provisions.

Specified by:

getPerformancePayout in interface Payout

getOrCreateSettlementPayout

SettlementPayout.SettlementPayoutBuilder getOrCreateSettlementPayout()

getSettlementPayout

SettlementPayout.SettlementPayoutBuilder getSettlementPayout()

Description copied from interface: Payout

Represents a forward settling payout. The 'Underlier' attribute captures the underlying payout, which is settled according to the 'SettlementTerms' attribute. Both FX Spot and FX Forward should use this component.

Specified by:

getSettlementPayout in interface Payout

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 Payout

setAssetPayout

Payout.PayoutBuilder setAssetPayout(AssetPayout _AssetPayout)

setCommodityPayout

Payout.PayoutBuilder setCommodityPayout(CommodityPayout _CommodityPayout)

setCreditDefaultPayout

Payout.PayoutBuilder setCreditDefaultPayout(CreditDefaultPayout _CreditDefaultPayout)

setFixedPricePayout

Payout.PayoutBuilder setFixedPricePayout(FixedPricePayout _FixedPricePayout)

setInterestRatePayout

Payout.PayoutBuilder setInterestRatePayout(InterestRatePayout _InterestRatePayout)

setOptionPayout

Payout.PayoutBuilder setOptionPayout(OptionPayout _OptionPayout)

setPerformancePayout

Payout.PayoutBuilder setPerformancePayout(PerformancePayout _PerformancePayout)

setSettlementPayout

Payout.PayoutBuilder setSettlementPayout(SettlementPayout _SettlementPayout)

setMeta

Payout.PayoutBuilder 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

Payout.PayoutBuilder prune()

Specified by:

prune in interface com.rosetta.model.lib.RosettaModelObjectBuilder