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
Builder Implementation of Payout
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.rosetta.model.lib.GlobalKey
com.rosetta.model.lib.GlobalKey.GlobalKeyBuilderNested classes/interfaces inherited from interface cdm.product.template.Payout
Payout.PayoutBuilder, Payout.PayoutBuilderImpl, Payout.PayoutImpl -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected List<AssetPayout.AssetPayoutBuilder> protected List<Cashflow.CashflowBuilder> protected List<CommodityPayout.CommodityPayoutBuilder> protected List<FixedPricePayout.FixedPricePayoutBuilder> protected List<ForwardPayout.ForwardPayoutBuilder> protected List<InterestRatePayout.InterestRatePayoutBuilder> protected com.rosetta.model.metafields.MetaFields.MetaFieldsBuilderprotected List<OptionPayout.OptionPayoutBuilder> protected List<PerformancePayout.PerformancePayoutBuilder> protected List<SecurityPayout.SecurityPayoutBuilder> -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAssetPayout(AssetPayout _assetPayout) addAssetPayout(AssetPayout _assetPayout, int idx) addAssetPayout(List<? extends AssetPayout> assetPayouts) addCashflow(Cashflow _cashflow) addCashflow(Cashflow _cashflow, int idx) addCashflow(List<? extends Cashflow> cashflows) addCommodityPayout(CommodityPayout _commodityPayout) addCommodityPayout(CommodityPayout _commodityPayout, int idx) addCommodityPayout(List<? extends CommodityPayout> commodityPayouts) addFixedPricePayout(FixedPricePayout _fixedPricePayout) addFixedPricePayout(FixedPricePayout _fixedPricePayout, int idx) addFixedPricePayout(List<? extends FixedPricePayout> fixedPricePayouts) addForwardPayout(ForwardPayout _forwardPayout) addForwardPayout(ForwardPayout _forwardPayout, int idx) addForwardPayout(List<? extends ForwardPayout> forwardPayouts) addInterestRatePayout(InterestRatePayout _interestRatePayout) addInterestRatePayout(InterestRatePayout _interestRatePayout, int idx) addInterestRatePayout(List<? extends InterestRatePayout> interestRatePayouts) addOptionPayout(OptionPayout _optionPayout) addOptionPayout(OptionPayout _optionPayout, int idx) addOptionPayout(List<? extends OptionPayout> optionPayouts) addPerformancePayout(PerformancePayout _performancePayout) addPerformancePayout(PerformancePayout _performancePayout, int idx) addPerformancePayout(List<? extends PerformancePayout> performancePayouts) addSecurityPayout(SecurityPayout _securityPayout) addSecurityPayout(SecurityPayout _securityPayout, int idx) addSecurityPayout(List<? extends SecurityPayout> securityPayouts) build()Build MethodsbooleanList<? extends AssetPayout.AssetPayoutBuilder> The security payout when the product involves some form of securities, such as collateral in a securities financing transactionList<? extends Cashflow.CashflowBuilder> A cashflow between the parties to the trade.List<? extends CommodityPayout.CommodityPayoutBuilder> Defines the payout for the floating leg of a Commodity Swap.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.List<? extends FixedPricePayout.FixedPricePayoutBuilder> Defines a payout in which one or more payouts are defined as a fixed price.List<? extends ForwardPayout.ForwardPayoutBuilder> Represents a forward settling payout.List<? extends InterestRatePayout.InterestRatePayoutBuilder> 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.MetaFieldsBuildergetMeta()List<? extends OptionPayout.OptionPayoutBuilder> The option payout.getOrCreateAssetPayout(int index) getOrCreateCashflow(int index) getOrCreateCommodityPayout(int index) getOrCreateFixedPricePayout(int index) getOrCreateForwardPayout(int index) getOrCreateInterestRatePayout(int index) com.rosetta.model.metafields.MetaFields.MetaFieldsBuildergetOrCreateOptionPayout(int index) getOrCreatePerformancePayout(int index) getOrCreateSecurityPayout(int index) List<? extends PerformancePayout.PerformancePayoutBuilder> The performance payout, which encompasses the equity price returns, dividend returns, volatility return, variance return and correlation provisions.List<? extends SecurityPayout.SecurityPayoutBuilder> The security payout when the product involves some form of securities, such as collateral in a securities financing transactionbooleanhasData()inthashCode()merge(com.rosetta.model.lib.RosettaModelObjectBuilder other, com.rosetta.model.lib.process.BuilderMerger merger) prune()setAssetPayout(List<? extends AssetPayout> assetPayouts) setCashflow(List<? extends Cashflow> cashflows) setCommodityPayout(List<? extends CommodityPayout> commodityPayouts) setCreditDefaultPayout(CreditDefaultPayout _creditDefaultPayout) setFixedPricePayout(List<? extends FixedPricePayout> fixedPricePayouts) setForwardPayout(List<? extends ForwardPayout> forwardPayouts) setInterestRatePayout(List<? extends InterestRatePayout> interestRatePayouts) setMeta(com.rosetta.model.metafields.MetaFields _meta) setOptionPayout(List<? extends OptionPayout> optionPayouts) setPerformancePayout(List<? extends PerformancePayout> performancePayouts) setSecurityPayout(List<? extends SecurityPayout> securityPayouts) toString()Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface cdm.product.template.Payout.PayoutBuilder
processMethods inherited from interface com.rosetta.model.lib.RosettaModelObject
processRosetta, processRosettaMethods inherited from interface com.rosetta.model.lib.RosettaModelObjectBuilder
getIndex, processRosetta, processRosetta
-
Field Details
-
interestRatePayout
-
creditDefaultPayout
-
optionPayout
-
commodityPayout
-
forwardPayout
-
fixedPricePayout
-
securityPayout
-
cashflow
-
performancePayout
-
assetPayout
-
meta
protected com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder meta
-
-
Constructor Details
-
PayoutBuilderImpl
public PayoutBuilderImpl()
-
-
Method Details
-
getInterestRatePayout
@RosettaAttribute("interestRatePayout") @RuneAttribute("interestRatePayout") public List<? extends InterestRatePayout.InterestRatePayoutBuilder> getInterestRatePayout()Description copied from interface:PayoutAll 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:
getInterestRatePayoutin interfacePayout- Specified by:
getInterestRatePayoutin interfacePayout.PayoutBuilder
-
getOrCreateInterestRatePayout
- Specified by:
getOrCreateInterestRatePayoutin interfacePayout.PayoutBuilder
-
getCreditDefaultPayout
@RosettaAttribute("creditDefaultPayout") @RuneAttribute("creditDefaultPayout") public CreditDefaultPayout.CreditDefaultPayoutBuilder getCreditDefaultPayout()Description copied from interface:PayoutThe 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:
getCreditDefaultPayoutin interfacePayout- Specified by:
getCreditDefaultPayoutin interfacePayout.PayoutBuilder
-
getOrCreateCreditDefaultPayout
- Specified by:
getOrCreateCreditDefaultPayoutin interfacePayout.PayoutBuilder
-
getOptionPayout
@RosettaAttribute("optionPayout") @RuneAttribute("optionPayout") public List<? extends OptionPayout.OptionPayoutBuilder> getOptionPayout()Description copied from interface:PayoutThe option payout.- Specified by:
getOptionPayoutin interfacePayout- Specified by:
getOptionPayoutin interfacePayout.PayoutBuilder
-
getOrCreateOptionPayout
- Specified by:
getOrCreateOptionPayoutin interfacePayout.PayoutBuilder
-
getCommodityPayout
@RosettaAttribute("commodityPayout") @RuneAttribute("commodityPayout") public List<? extends CommodityPayout.CommodityPayoutBuilder> getCommodityPayout()Description copied from interface:PayoutDefines the payout for the floating leg of a Commodity Swap.- Specified by:
getCommodityPayoutin interfacePayout- Specified by:
getCommodityPayoutin interfacePayout.PayoutBuilder
-
getOrCreateCommodityPayout
- Specified by:
getOrCreateCommodityPayoutin interfacePayout.PayoutBuilder
-
getForwardPayout
@RosettaAttribute("forwardPayout") @RuneAttribute("forwardPayout") public List<? extends ForwardPayout.ForwardPayoutBuilder> getForwardPayout()Description copied from interface:PayoutRepresents 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:
getForwardPayoutin interfacePayout- Specified by:
getForwardPayoutin interfacePayout.PayoutBuilder
-
getOrCreateForwardPayout
- Specified by:
getOrCreateForwardPayoutin interfacePayout.PayoutBuilder
-
getFixedPricePayout
@RosettaAttribute("fixedPricePayout") @RuneAttribute("fixedPricePayout") public List<? extends FixedPricePayout.FixedPricePayoutBuilder> getFixedPricePayout()Description copied from interface:PayoutDefines a payout in which one or more payouts are defined as a fixed price.- Specified by:
getFixedPricePayoutin interfacePayout- Specified by:
getFixedPricePayoutin interfacePayout.PayoutBuilder
-
getOrCreateFixedPricePayout
- Specified by:
getOrCreateFixedPricePayoutin interfacePayout.PayoutBuilder
-
getSecurityPayout
@RosettaAttribute("securityPayout") @RuneAttribute("securityPayout") public List<? extends SecurityPayout.SecurityPayoutBuilder> getSecurityPayout()Description copied from interface:PayoutThe security payout when the product involves some form of securities, such as collateral in a securities financing transaction- Specified by:
getSecurityPayoutin interfacePayout- Specified by:
getSecurityPayoutin interfacePayout.PayoutBuilder
-
getOrCreateSecurityPayout
- Specified by:
getOrCreateSecurityPayoutin interfacePayout.PayoutBuilder
-
getCashflow
@RosettaAttribute("cashflow") @RuneAttribute("cashflow") public List<? extends Cashflow.CashflowBuilder> getCashflow()Description copied from interface:PayoutA cashflow between the parties to the trade. For interest rate and equity products, this corresponds to the FpML additionalPayment element. For credit default swaps, this corresponds to the FpML initialPayment element and the singlePayment element of the fee leg. For option products, it represents the FpML premium element.- Specified by:
getCashflowin interfacePayout- Specified by:
getCashflowin interfacePayout.PayoutBuilder
-
getOrCreateCashflow
- Specified by:
getOrCreateCashflowin interfacePayout.PayoutBuilder
-
getPerformancePayout
@RosettaAttribute("performancePayout") @RuneAttribute("performancePayout") public List<? extends PerformancePayout.PerformancePayoutBuilder> getPerformancePayout()Description copied from interface:PayoutThe performance payout, which encompasses the equity price returns, dividend returns, volatility return, variance return and correlation provisions.- Specified by:
getPerformancePayoutin interfacePayout- Specified by:
getPerformancePayoutin interfacePayout.PayoutBuilder
-
getOrCreatePerformancePayout
- Specified by:
getOrCreatePerformancePayoutin interfacePayout.PayoutBuilder
-
getAssetPayout
@RosettaAttribute("assetPayout") @RuneAttribute("assetPayout") public List<? extends AssetPayout.AssetPayoutBuilder> getAssetPayout()Description copied from interface:PayoutThe security payout when the product involves some form of securities, such as collateral in a securities financing transaction- Specified by:
getAssetPayoutin interfacePayout- Specified by:
getAssetPayoutin interfacePayout.PayoutBuilder
-
getOrCreateAssetPayout
- Specified by:
getOrCreateAssetPayoutin interfacePayout.PayoutBuilder
-
getMeta
@RosettaAttribute("meta") @RuneAttribute("meta") @RuneMetaType public com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder getMeta()- Specified by:
getMetain interfacecom.rosetta.model.lib.GlobalKey- Specified by:
getMetain interfacecom.rosetta.model.lib.GlobalKey.GlobalKeyBuilder- Specified by:
getMetain interfacePayout- Specified by:
getMetain interfacePayout.PayoutBuilder
-
getOrCreateMeta
public com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder getOrCreateMeta()- Specified by:
getOrCreateMetain interfacecom.rosetta.model.lib.GlobalKey.GlobalKeyBuilder- Specified by:
getOrCreateMetain interfacePayout.PayoutBuilder
-
addInterestRatePayout
@RosettaAttribute("interestRatePayout") @RuneAttribute("interestRatePayout") public Payout.PayoutBuilder addInterestRatePayout(InterestRatePayout _interestRatePayout) - Specified by:
addInterestRatePayoutin interfacePayout.PayoutBuilder
-
addInterestRatePayout
- Specified by:
addInterestRatePayoutin interfacePayout.PayoutBuilder
-
addInterestRatePayout
public Payout.PayoutBuilder addInterestRatePayout(List<? extends InterestRatePayout> interestRatePayouts) - Specified by:
addInterestRatePayoutin interfacePayout.PayoutBuilder
-
setInterestRatePayout
@RuneAttribute("interestRatePayout") public Payout.PayoutBuilder setInterestRatePayout(List<? extends InterestRatePayout> interestRatePayouts) - Specified by:
setInterestRatePayoutin interfacePayout.PayoutBuilder
-
setCreditDefaultPayout
@RosettaAttribute("creditDefaultPayout") @RuneAttribute("creditDefaultPayout") public Payout.PayoutBuilder setCreditDefaultPayout(CreditDefaultPayout _creditDefaultPayout) - Specified by:
setCreditDefaultPayoutin interfacePayout.PayoutBuilder
-
addOptionPayout
@RosettaAttribute("optionPayout") @RuneAttribute("optionPayout") public Payout.PayoutBuilder addOptionPayout(OptionPayout _optionPayout) - Specified by:
addOptionPayoutin interfacePayout.PayoutBuilder
-
addOptionPayout
- Specified by:
addOptionPayoutin interfacePayout.PayoutBuilder
-
addOptionPayout
- Specified by:
addOptionPayoutin interfacePayout.PayoutBuilder
-
setOptionPayout
@RuneAttribute("optionPayout") public Payout.PayoutBuilder setOptionPayout(List<? extends OptionPayout> optionPayouts) - Specified by:
setOptionPayoutin interfacePayout.PayoutBuilder
-
addCommodityPayout
@RosettaAttribute("commodityPayout") @RuneAttribute("commodityPayout") public Payout.PayoutBuilder addCommodityPayout(CommodityPayout _commodityPayout) - Specified by:
addCommodityPayoutin interfacePayout.PayoutBuilder
-
addCommodityPayout
- Specified by:
addCommodityPayoutin interfacePayout.PayoutBuilder
-
addCommodityPayout
- Specified by:
addCommodityPayoutin interfacePayout.PayoutBuilder
-
setCommodityPayout
@RuneAttribute("commodityPayout") public Payout.PayoutBuilder setCommodityPayout(List<? extends CommodityPayout> commodityPayouts) - Specified by:
setCommodityPayoutin interfacePayout.PayoutBuilder
-
addForwardPayout
@RosettaAttribute("forwardPayout") @RuneAttribute("forwardPayout") public Payout.PayoutBuilder addForwardPayout(ForwardPayout _forwardPayout) - Specified by:
addForwardPayoutin interfacePayout.PayoutBuilder
-
addForwardPayout
- Specified by:
addForwardPayoutin interfacePayout.PayoutBuilder
-
addForwardPayout
- Specified by:
addForwardPayoutin interfacePayout.PayoutBuilder
-
setForwardPayout
@RuneAttribute("forwardPayout") public Payout.PayoutBuilder setForwardPayout(List<? extends ForwardPayout> forwardPayouts) - Specified by:
setForwardPayoutin interfacePayout.PayoutBuilder
-
addFixedPricePayout
@RosettaAttribute("fixedPricePayout") @RuneAttribute("fixedPricePayout") public Payout.PayoutBuilder addFixedPricePayout(FixedPricePayout _fixedPricePayout) - Specified by:
addFixedPricePayoutin interfacePayout.PayoutBuilder
-
addFixedPricePayout
- Specified by:
addFixedPricePayoutin interfacePayout.PayoutBuilder
-
addFixedPricePayout
- Specified by:
addFixedPricePayoutin interfacePayout.PayoutBuilder
-
setFixedPricePayout
@RuneAttribute("fixedPricePayout") public Payout.PayoutBuilder setFixedPricePayout(List<? extends FixedPricePayout> fixedPricePayouts) - Specified by:
setFixedPricePayoutin interfacePayout.PayoutBuilder
-
addSecurityPayout
@RosettaAttribute("securityPayout") @RuneAttribute("securityPayout") public Payout.PayoutBuilder addSecurityPayout(SecurityPayout _securityPayout) - Specified by:
addSecurityPayoutin interfacePayout.PayoutBuilder
-
addSecurityPayout
- Specified by:
addSecurityPayoutin interfacePayout.PayoutBuilder
-
addSecurityPayout
- Specified by:
addSecurityPayoutin interfacePayout.PayoutBuilder
-
setSecurityPayout
@RuneAttribute("securityPayout") public Payout.PayoutBuilder setSecurityPayout(List<? extends SecurityPayout> securityPayouts) - Specified by:
setSecurityPayoutin interfacePayout.PayoutBuilder
-
addCashflow
@RosettaAttribute("cashflow") @RuneAttribute("cashflow") public Payout.PayoutBuilder addCashflow(Cashflow _cashflow) - Specified by:
addCashflowin interfacePayout.PayoutBuilder
-
addCashflow
- Specified by:
addCashflowin interfacePayout.PayoutBuilder
-
addCashflow
- Specified by:
addCashflowin interfacePayout.PayoutBuilder
-
setCashflow
@RuneAttribute("cashflow") public Payout.PayoutBuilder setCashflow(List<? extends Cashflow> cashflows) - Specified by:
setCashflowin interfacePayout.PayoutBuilder
-
addPerformancePayout
@RosettaAttribute("performancePayout") @RuneAttribute("performancePayout") public Payout.PayoutBuilder addPerformancePayout(PerformancePayout _performancePayout) - Specified by:
addPerformancePayoutin interfacePayout.PayoutBuilder
-
addPerformancePayout
- Specified by:
addPerformancePayoutin interfacePayout.PayoutBuilder
-
addPerformancePayout
public Payout.PayoutBuilder addPerformancePayout(List<? extends PerformancePayout> performancePayouts) - Specified by:
addPerformancePayoutin interfacePayout.PayoutBuilder
-
setPerformancePayout
@RuneAttribute("performancePayout") public Payout.PayoutBuilder setPerformancePayout(List<? extends PerformancePayout> performancePayouts) - Specified by:
setPerformancePayoutin interfacePayout.PayoutBuilder
-
addAssetPayout
@RosettaAttribute("assetPayout") @RuneAttribute("assetPayout") public Payout.PayoutBuilder addAssetPayout(AssetPayout _assetPayout) - Specified by:
addAssetPayoutin interfacePayout.PayoutBuilder
-
addAssetPayout
- Specified by:
addAssetPayoutin interfacePayout.PayoutBuilder
-
addAssetPayout
- Specified by:
addAssetPayoutin interfacePayout.PayoutBuilder
-
setAssetPayout
@RuneAttribute("assetPayout") public Payout.PayoutBuilder setAssetPayout(List<? extends AssetPayout> assetPayouts) - Specified by:
setAssetPayoutin interfacePayout.PayoutBuilder
-
setMeta
@RosettaAttribute("meta") @RuneAttribute("meta") @RuneMetaType public Payout.PayoutBuilder setMeta(com.rosetta.model.metafields.MetaFields _meta) - Specified by:
setMetain interfacePayout.PayoutBuilder
-
build
Description copied from interface:PayoutBuild Methods -
toBuilder
-
prune
- Specified by:
prunein interfacePayout.PayoutBuilder- Specified by:
prunein interfacecom.rosetta.model.lib.RosettaModelObjectBuilder
-
hasData
public boolean hasData()- Specified by:
hasDatain interfacecom.rosetta.model.lib.RosettaModelObjectBuilder
-
merge
public Payout.PayoutBuilder merge(com.rosetta.model.lib.RosettaModelObjectBuilder other, com.rosetta.model.lib.process.BuilderMerger merger) - Specified by:
mergein interfacecom.rosetta.model.lib.RosettaModelObjectBuilder
-
equals
-
hashCode
public int hashCode() -
toString
-