Package cdm.product.template

Class Payout.PayoutBuilderImpl

java.lang.Object

cdm.product.template.Payout.PayoutBuilderImpl

All Implemented Interfaces:

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

Enclosing interface:

Payout

public static class Payout.PayoutBuilderImpl
extends Object
implements Payout.PayoutBuilder

Builder Implementation of Payout

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

Modifier and Type	Field	Description
protected AssetPayout.AssetPayoutBuilder	assetPayout
protected CommodityPayout.CommodityPayoutBuilder	commodityPayout
protected CreditDefaultPayout.CreditDefaultPayoutBuilder	creditDefaultPayout
protected FixedPricePayout.FixedPricePayoutBuilder	fixedPricePayout
protected InterestRatePayout.InterestRatePayoutBuilder	interestRatePayout
protected com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder	meta
protected OptionPayout.OptionPayoutBuilder	optionPayout
protected PerformancePayout.PerformancePayoutBuilder	performancePayout
protected SettlementPayout.SettlementPayoutBuilder	settlementPayout

Fields inherited from interface cdm.product.template.Payout

metaData

Constructor Summary

Constructors

Constructor	Description
PayoutBuilderImpl()

Method Summary

Modifier and Type	Method	Description
Payout	build()	Build Methods
boolean	equals(Object o)
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.
boolean	hasData()
int	hashCode()
Payout.PayoutBuilder	merge(com.rosetta.model.lib.RosettaModelObjectBuilder other, com.rosetta.model.lib.process.BuilderMerger merger)
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)
Payout.PayoutBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface cdm.product.template.Payout

getType, metaData, process

Methods inherited from interface cdm.product.template.Payout.PayoutBuilder

process

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

processRosetta, processRosetta

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

getIndex, processRosetta, processRosetta

Field Details

assetPayout

protected AssetPayout.AssetPayoutBuilder assetPayout

commodityPayout

protected CommodityPayout.CommodityPayoutBuilder commodityPayout

creditDefaultPayout

protected CreditDefaultPayout.CreditDefaultPayoutBuilder creditDefaultPayout

fixedPricePayout

protected FixedPricePayout.FixedPricePayoutBuilder fixedPricePayout

interestRatePayout

protected InterestRatePayout.InterestRatePayoutBuilder interestRatePayout

optionPayout

protected OptionPayout.OptionPayoutBuilder optionPayout

performancePayout

protected PerformancePayout.PerformancePayoutBuilder performancePayout

settlementPayout

protected SettlementPayout.SettlementPayoutBuilder settlementPayout

meta

protected com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder meta

Constructor Details

PayoutBuilderImpl

public PayoutBuilderImpl()

Method Details

getAssetPayout

@RosettaAttribute("AssetPayout")
@Accessor(GETTER)
@RuneAttribute("AssetPayout")
public AssetPayout.AssetPayoutBuilder getAssetPayout()

Description copied from interface: Payout

Defines the assets and movements in a security financing transaction.

Specified by:

getAssetPayout in interface Payout

Specified by:

getAssetPayout in interface Payout.PayoutBuilder

getOrCreateAssetPayout

public AssetPayout.AssetPayoutBuilder getOrCreateAssetPayout()

Specified by:

getOrCreateAssetPayout in interface Payout.PayoutBuilder

getCommodityPayout

@RosettaAttribute("CommodityPayout")
@Accessor(GETTER)
@RuneAttribute("CommodityPayout")
public 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

Specified by:

getCommodityPayout in interface Payout.PayoutBuilder

getOrCreateCommodityPayout

public CommodityPayout.CommodityPayoutBuilder getOrCreateCommodityPayout()

Specified by:

getOrCreateCommodityPayout in interface Payout.PayoutBuilder

getCreditDefaultPayout

@RosettaAttribute("CreditDefaultPayout")
@Accessor(GETTER)
@RuneAttribute("CreditDefaultPayout")
public 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

Specified by:

getCreditDefaultPayout in interface Payout.PayoutBuilder

getOrCreateCreditDefaultPayout

public CreditDefaultPayout.CreditDefaultPayoutBuilder getOrCreateCreditDefaultPayout()

Specified by:

getOrCreateCreditDefaultPayout in interface Payout.PayoutBuilder

getFixedPricePayout

@RosettaAttribute("FixedPricePayout")
@Accessor(GETTER)
@RuneAttribute("FixedPricePayout")
public 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

Specified by:

getFixedPricePayout in interface Payout.PayoutBuilder

getOrCreateFixedPricePayout

public FixedPricePayout.FixedPricePayoutBuilder getOrCreateFixedPricePayout()

Specified by:

getOrCreateFixedPricePayout in interface Payout.PayoutBuilder

getInterestRatePayout

@RosettaAttribute("InterestRatePayout")
@Accessor(GETTER)
@RuneAttribute("InterestRatePayout")
public 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

Specified by:

getInterestRatePayout in interface Payout.PayoutBuilder

getOrCreateInterestRatePayout

public InterestRatePayout.InterestRatePayoutBuilder getOrCreateInterestRatePayout()

Specified by:

getOrCreateInterestRatePayout in interface Payout.PayoutBuilder

getOptionPayout

@RosettaAttribute("OptionPayout")
@Accessor(GETTER)
@RuneAttribute("OptionPayout")
public OptionPayout.OptionPayoutBuilder getOptionPayout()

Description copied from interface: Payout

The option payout.

Specified by:

getOptionPayout in interface Payout

Specified by:

getOptionPayout in interface Payout.PayoutBuilder

getOrCreateOptionPayout

public OptionPayout.OptionPayoutBuilder getOrCreateOptionPayout()

Specified by:

getOrCreateOptionPayout in interface Payout.PayoutBuilder

getPerformancePayout

@RosettaAttribute("PerformancePayout")
@Accessor(GETTER)
@RuneAttribute("PerformancePayout")
public 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

Specified by:

getPerformancePayout in interface Payout.PayoutBuilder

getOrCreatePerformancePayout

public PerformancePayout.PerformancePayoutBuilder getOrCreatePerformancePayout()

Specified by:

getOrCreatePerformancePayout in interface Payout.PayoutBuilder

getSettlementPayout

@RosettaAttribute("SettlementPayout")
@Accessor(GETTER)
@RuneAttribute("SettlementPayout")
public 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

Specified by:

getSettlementPayout in interface Payout.PayoutBuilder

getOrCreateSettlementPayout

public SettlementPayout.SettlementPayoutBuilder getOrCreateSettlementPayout()

Specified by:

getOrCreateSettlementPayout in interface Payout.PayoutBuilder

getMeta

@RosettaAttribute("meta")
@Accessor(GETTER)
@RuneAttribute("meta")
@RuneMetaType
public 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

Specified by:

getMeta in interface Payout.PayoutBuilder

getOrCreateMeta

public com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder getOrCreateMeta()

Specified by:

getOrCreateMeta in interface com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder

Specified by:

getOrCreateMeta in interface Payout.PayoutBuilder

setAssetPayout

@RosettaAttribute("AssetPayout")
@Accessor(SETTER)
@RuneAttribute("AssetPayout")
public Payout.PayoutBuilder setAssetPayout(AssetPayout _assetPayout)

Specified by:

setAssetPayout in interface Payout.PayoutBuilder

setCommodityPayout

@RosettaAttribute("CommodityPayout")
@Accessor(SETTER)
@RuneAttribute("CommodityPayout")
public Payout.PayoutBuilder setCommodityPayout(CommodityPayout _commodityPayout)

Specified by:

setCommodityPayout in interface Payout.PayoutBuilder

setCreditDefaultPayout

@RosettaAttribute("CreditDefaultPayout")
@Accessor(SETTER)
@RuneAttribute("CreditDefaultPayout")
public Payout.PayoutBuilder setCreditDefaultPayout(CreditDefaultPayout _creditDefaultPayout)

Specified by:

setCreditDefaultPayout in interface Payout.PayoutBuilder

setFixedPricePayout

@RosettaAttribute("FixedPricePayout")
@Accessor(SETTER)
@RuneAttribute("FixedPricePayout")
public Payout.PayoutBuilder setFixedPricePayout(FixedPricePayout _fixedPricePayout)

Specified by:

setFixedPricePayout in interface Payout.PayoutBuilder

setInterestRatePayout

@RosettaAttribute("InterestRatePayout")
@Accessor(SETTER)
@RuneAttribute("InterestRatePayout")
public Payout.PayoutBuilder setInterestRatePayout(InterestRatePayout _interestRatePayout)

Specified by:

setInterestRatePayout in interface Payout.PayoutBuilder

setOptionPayout

@RosettaAttribute("OptionPayout")
@Accessor(SETTER)
@RuneAttribute("OptionPayout")
public Payout.PayoutBuilder setOptionPayout(OptionPayout _optionPayout)

Specified by:

setOptionPayout in interface Payout.PayoutBuilder

setPerformancePayout

@RosettaAttribute("PerformancePayout")
@Accessor(SETTER)
@RuneAttribute("PerformancePayout")
public Payout.PayoutBuilder setPerformancePayout(PerformancePayout _performancePayout)

Specified by:

setPerformancePayout in interface Payout.PayoutBuilder

setSettlementPayout

@RosettaAttribute("SettlementPayout")
@Accessor(SETTER)
@RuneAttribute("SettlementPayout")
public Payout.PayoutBuilder setSettlementPayout(SettlementPayout _settlementPayout)

Specified by:

setSettlementPayout in interface Payout.PayoutBuilder

setMeta

@RosettaAttribute("meta")
@Accessor(SETTER)
@RuneAttribute("meta")
@RuneMetaType
public Payout.PayoutBuilder setMeta(com.rosetta.model.metafields.MetaFields _meta)

Specified by:

setMeta in interface Payout.PayoutBuilder

build

public Payout build()

Description copied from interface: Payout

Build Methods

Specified by:

build in interface Payout

Specified by:

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

toBuilder

public Payout.PayoutBuilder toBuilder()

Specified by:

toBuilder in interface Payout

Specified by:

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

prune

public Payout.PayoutBuilder prune()

Specified by:

prune in interface Payout.PayoutBuilder

Specified by:

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

hasData

public boolean hasData()

Specified by:

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

merge

public Payout.PayoutBuilder merge(com.rosetta.model.lib.RosettaModelObjectBuilder other,
 com.rosetta.model.lib.process.BuilderMerger merger)

Specified by:

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object