Package cdm.product.asset

Class CommodityPayout.CommodityPayoutBuilderImpl

java.lang.Object

cdm.product.common.settlement.PayoutBase.PayoutBaseBuilderImpl

cdm.product.asset.CommodityPayout.CommodityPayoutBuilderImpl

All Implemented Interfaces:

CommodityPayout, CommodityPayout.CommodityPayoutBuilder, PayoutBase, PayoutBase.PayoutBaseBuilder, com.rosetta.model.lib.GlobalKey, com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder, com.rosetta.model.lib.RosettaModelObject, com.rosetta.model.lib.RosettaModelObjectBuilder

Enclosing interface:

CommodityPayout

public static class CommodityPayout.CommodityPayoutBuilderImpl
extends PayoutBase.PayoutBaseBuilderImpl
implements CommodityPayout.CommodityPayoutBuilder

Builder Implementation of CommodityPayout

Nested Class Summary

Nested classes/interfaces inherited from interface cdm.product.asset.CommodityPayout

CommodityPayout.CommodityPayoutBuilder, CommodityPayout.CommodityPayoutBuilderImpl, CommodityPayout.CommodityPayoutImpl

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
protected AveragingCalculation.AveragingCalculationBuilder	averagingFeature
protected CalculationPeriodDates.CalculationPeriodDatesBuilder	calculationPeriodDates
protected CommodityPriceReturnTerms.CommodityPriceReturnTermsBuilder	commodityPriceReturnTerms
protected AssetDeliveryInformation.AssetDeliveryInformationBuilder	delivery
protected FxFeature.FxFeatureBuilder	fxFeature
protected com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder	meta
protected PaymentDates.PaymentDatesBuilder	paymentDates
protected PricingDates.PricingDatesBuilder	pricingDates
protected CalculationSchedule.CalculationScheduleBuilder	schedule
protected Product.ProductBuilder	underlier

Fields inherited from class cdm.product.common.settlement.PayoutBase.PayoutBaseBuilderImpl

payerReceiver, priceQuantity, principalPayment, settlementTerms

Fields inherited from interface cdm.product.asset.CommodityPayout

metaData

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

metaData

Constructor Summary

Constructors

Constructor	Description
CommodityPayoutBuilderImpl()

Method Summary

Modifier and Type	Method	Description
CommodityPayout	build()	Build Methods
boolean	equals(Object o)
AveragingCalculation.AveragingCalculationBuilder	getAveragingFeature()	Indicates if the averaging calculation, when applicable, is weighted or unweighted.
CalculationPeriodDates.CalculationPeriodDatesBuilder	getCalculationPeriodDates()	Defines the calculation period dates schedule.
CommodityPriceReturnTerms.CommodityPriceReturnTermsBuilder	getCommodityPriceReturnTerms()	Defines parameters in which the commodity price is assessed.
AssetDeliveryInformation.AssetDeliveryInformationBuilder	getDelivery()	Contains the information relative to the delivery of the asset.
FxFeature.FxFeatureBuilder	getFxFeature()	Defines quanto or composite FX features that are included in the swap leg.
com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder	getMeta()
AveragingCalculation.AveragingCalculationBuilder	getOrCreateAveragingFeature()
CalculationPeriodDates.CalculationPeriodDatesBuilder	getOrCreateCalculationPeriodDates()
CommodityPriceReturnTerms.CommodityPriceReturnTermsBuilder	getOrCreateCommodityPriceReturnTerms()
AssetDeliveryInformation.AssetDeliveryInformationBuilder	getOrCreateDelivery()
FxFeature.FxFeatureBuilder	getOrCreateFxFeature()
com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder	getOrCreateMeta()
PaymentDates.PaymentDatesBuilder	getOrCreatePaymentDates()
PricingDates.PricingDatesBuilder	getOrCreatePricingDates()
CalculationSchedule.CalculationScheduleBuilder	getOrCreateSchedule()
Product.ProductBuilder	getOrCreateUnderlier()
PaymentDates.PaymentDatesBuilder	getPaymentDates()	Defines the payment date schedule, as defined by the parameters that are needed to specify it, either in a parametric way or by reference to another schedule of dates (e.g. the valuation dates).
PricingDates.PricingDatesBuilder	getPricingDates()	Specifies specific dates or parametric rules for the dates on which the price will be determined.
CalculationSchedule.CalculationScheduleBuilder	getSchedule()	Allows the full representation of a payout by defining a set of schedule periods.
Product.ProductBuilder	getUnderlier()	Identifies the underlying product that is referenced for pricing of the applicable leg in a swap.
boolean	hasData()
int	hashCode()
CommodityPayout.CommodityPayoutBuilder	merge(com.rosetta.model.lib.RosettaModelObjectBuilder other, com.rosetta.model.lib.process.BuilderMerger merger)
CommodityPayout.CommodityPayoutBuilder	prune()
CommodityPayout.CommodityPayoutBuilder	setAveragingFeature(AveragingCalculation _averagingFeature)
CommodityPayout.CommodityPayoutBuilder	setCalculationPeriodDates(CalculationPeriodDates _calculationPeriodDates)
CommodityPayout.CommodityPayoutBuilder	setCommodityPriceReturnTerms(CommodityPriceReturnTerms _commodityPriceReturnTerms)
CommodityPayout.CommodityPayoutBuilder	setDelivery(AssetDeliveryInformation _delivery)
CommodityPayout.CommodityPayoutBuilder	setFxFeature(FxFeature _fxFeature)
CommodityPayout.CommodityPayoutBuilder	setMeta(com.rosetta.model.metafields.MetaFields _meta)
CommodityPayout.CommodityPayoutBuilder	setPayerReceiver(PayerReceiver _payerReceiver)
CommodityPayout.CommodityPayoutBuilder	setPaymentDates(PaymentDates _paymentDates)
CommodityPayout.CommodityPayoutBuilder	setPriceQuantity(ResolvablePriceQuantity _priceQuantity)
CommodityPayout.CommodityPayoutBuilder	setPricingDates(PricingDates _pricingDates)
CommodityPayout.CommodityPayoutBuilder	setPrincipalPayment(PrincipalPayments _principalPayment)
CommodityPayout.CommodityPayoutBuilder	setSchedule(CalculationSchedule _schedule)
CommodityPayout.CommodityPayoutBuilder	setSettlementTerms(SettlementTerms _settlementTerms)
CommodityPayout.CommodityPayoutBuilder	setUnderlier(Product _underlier)
CommodityPayout.CommodityPayoutBuilder	toBuilder()
String	toString()

Methods inherited from class cdm.product.common.settlement.PayoutBase.PayoutBaseBuilderImpl

getOrCreatePayerReceiver, getOrCreatePriceQuantity, getOrCreatePrincipalPayment, getOrCreateSettlementTerms, getPayerReceiver, getPriceQuantity, getPrincipalPayment, getSettlementTerms

Methods inherited from class java.lang.Object

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

Methods inherited from interface cdm.product.asset.CommodityPayout

getType, metaData, process

Methods inherited from interface cdm.product.asset.CommodityPayout.CommodityPayoutBuilder

process

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

getOrCreatePayerReceiver, getOrCreatePriceQuantity, getOrCreatePrincipalPayment, getOrCreateSettlementTerms, getPayerReceiver, getPriceQuantity, getPrincipalPayment, getSettlementTerms

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

averagingFeature

protected AveragingCalculation.AveragingCalculationBuilder averagingFeature

commodityPriceReturnTerms

protected CommodityPriceReturnTerms.CommodityPriceReturnTermsBuilder commodityPriceReturnTerms

pricingDates

protected PricingDates.PricingDatesBuilder pricingDates

schedule

protected CalculationSchedule.CalculationScheduleBuilder schedule

calculationPeriodDates

protected CalculationPeriodDates.CalculationPeriodDatesBuilder calculationPeriodDates

paymentDates

protected PaymentDates.PaymentDatesBuilder paymentDates

underlier

protected Product.ProductBuilder underlier

fxFeature

protected FxFeature.FxFeatureBuilder fxFeature

delivery

protected AssetDeliveryInformation.AssetDeliveryInformationBuilder delivery

meta

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

Constructor Details

CommodityPayoutBuilderImpl

public CommodityPayoutBuilderImpl()

Method Details

getAveragingFeature

@RosettaAttribute("averagingFeature")
@RuneAttribute("averagingFeature")
public AveragingCalculation.AveragingCalculationBuilder getAveragingFeature()

Description copied from interface: CommodityPayout

Indicates if the averaging calculation, when applicable, is weighted or unweighted.

Specified by:

getAveragingFeature in interface CommodityPayout

Specified by:

getAveragingFeature in interface CommodityPayout.CommodityPayoutBuilder

getOrCreateAveragingFeature

public AveragingCalculation.AveragingCalculationBuilder getOrCreateAveragingFeature()

Specified by:

getOrCreateAveragingFeature in interface CommodityPayout.CommodityPayoutBuilder

getCommodityPriceReturnTerms

@RosettaAttribute("commodityPriceReturnTerms")
@RuneAttribute("commodityPriceReturnTerms")
public CommodityPriceReturnTerms.CommodityPriceReturnTermsBuilder getCommodityPriceReturnTerms()

Description copied from interface: CommodityPayout

Defines parameters in which the commodity price is assessed.

Specified by:

getCommodityPriceReturnTerms in interface CommodityPayout

Specified by:

getCommodityPriceReturnTerms in interface CommodityPayout.CommodityPayoutBuilder

getOrCreateCommodityPriceReturnTerms

public CommodityPriceReturnTerms.CommodityPriceReturnTermsBuilder getOrCreateCommodityPriceReturnTerms()

Specified by:

getOrCreateCommodityPriceReturnTerms in interface CommodityPayout.CommodityPayoutBuilder

getPricingDates

@RosettaAttribute(value="pricingDates",
                  isRequired=true)
@RuneAttribute(value="pricingDates",
               isRequired=true)
public PricingDates.PricingDatesBuilder getPricingDates()

Description copied from interface: CommodityPayout

Specifies specific dates or parametric rules for the dates on which the price will be determined.

Specified by:

getPricingDates in interface CommodityPayout

Specified by:

getPricingDates in interface CommodityPayout.CommodityPayoutBuilder

getOrCreatePricingDates

public PricingDates.PricingDatesBuilder getOrCreatePricingDates()

Specified by:

getOrCreatePricingDates in interface CommodityPayout.CommodityPayoutBuilder

getSchedule

@RosettaAttribute("schedule")
@RuneAttribute("schedule")
public CalculationSchedule.CalculationScheduleBuilder getSchedule()

Description copied from interface: CommodityPayout

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.

Specified by:

getSchedule in interface CommodityPayout

Specified by:

getSchedule in interface CommodityPayout.CommodityPayoutBuilder

getOrCreateSchedule

public CalculationSchedule.CalculationScheduleBuilder getOrCreateSchedule()

Specified by:

getOrCreateSchedule in interface CommodityPayout.CommodityPayoutBuilder

getCalculationPeriodDates

@RosettaAttribute("calculationPeriodDates")
@RuneAttribute("calculationPeriodDates")
public CalculationPeriodDates.CalculationPeriodDatesBuilder getCalculationPeriodDates()

Description copied from interface: CommodityPayout

Defines the calculation period dates schedule.

Specified by:

getCalculationPeriodDates in interface CommodityPayout

Specified by:

getCalculationPeriodDates in interface CommodityPayout.CommodityPayoutBuilder

getOrCreateCalculationPeriodDates

public CalculationPeriodDates.CalculationPeriodDatesBuilder getOrCreateCalculationPeriodDates()

Specified by:

getOrCreateCalculationPeriodDates in interface CommodityPayout.CommodityPayoutBuilder

getPaymentDates

@RosettaAttribute(value="paymentDates",
                  isRequired=true)
@RuneAttribute(value="paymentDates",
               isRequired=true)
public PaymentDates.PaymentDatesBuilder getPaymentDates()

Description copied from interface: CommodityPayout

Defines the payment date schedule, as defined by the parameters that are needed to specify it, either in a parametric way or by reference to another schedule of dates (e.g. the valuation dates).

Specified by:

getPaymentDates in interface CommodityPayout

Specified by:

getPaymentDates in interface CommodityPayout.CommodityPayoutBuilder

getOrCreatePaymentDates

public PaymentDates.PaymentDatesBuilder getOrCreatePaymentDates()

Specified by:

getOrCreatePaymentDates in interface CommodityPayout.CommodityPayoutBuilder

getUnderlier

@RosettaAttribute(value="underlier",
                  isRequired=true)
@RuneAttribute(value="underlier",
               isRequired=true)
public Product.ProductBuilder getUnderlier()

Description copied from interface: CommodityPayout

Identifies the underlying product that is referenced for pricing of the applicable leg in a swap. Referenced in the '2018 ISDA CDM Equity Confirmation for Security Equity Swap' as Security.

Specified by:

getUnderlier in interface CommodityPayout

Specified by:

getUnderlier in interface CommodityPayout.CommodityPayoutBuilder

getOrCreateUnderlier

public Product.ProductBuilder getOrCreateUnderlier()

Specified by:

getOrCreateUnderlier in interface CommodityPayout.CommodityPayoutBuilder

getFxFeature

@RosettaAttribute("fxFeature")
@RuneAttribute("fxFeature")
public FxFeature.FxFeatureBuilder getFxFeature()

Description copied from interface: CommodityPayout

Defines quanto or composite FX features that are included in the swap leg.

Specified by:

getFxFeature in interface CommodityPayout

Specified by:

getFxFeature in interface CommodityPayout.CommodityPayoutBuilder

getOrCreateFxFeature

public FxFeature.FxFeatureBuilder getOrCreateFxFeature()

Specified by:

getOrCreateFxFeature in interface CommodityPayout.CommodityPayoutBuilder

getDelivery

@RosettaAttribute("delivery")
@RuneAttribute("delivery")
public AssetDeliveryInformation.AssetDeliveryInformationBuilder getDelivery()

Description copied from interface: CommodityPayout

Contains the information relative to the delivery of the asset.

Specified by:

getDelivery in interface CommodityPayout

Specified by:

getDelivery in interface CommodityPayout.CommodityPayoutBuilder

getOrCreateDelivery

public AssetDeliveryInformation.AssetDeliveryInformationBuilder getOrCreateDelivery()

Specified by:

getOrCreateDelivery in interface CommodityPayout.CommodityPayoutBuilder

getMeta

@RosettaAttribute("meta")
@RuneAttribute("meta")
@RuneMetaType
public com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder getMeta()

Specified by:

getMeta in interface CommodityPayout

Specified by:

getMeta in interface CommodityPayout.CommodityPayoutBuilder

Specified by:

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

Specified by:

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

getOrCreateMeta

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

Specified by:

getOrCreateMeta in interface CommodityPayout.CommodityPayoutBuilder

Specified by:

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

setPayerReceiver

@RosettaAttribute(value="payerReceiver",
                  isRequired=true)
@RuneAttribute(value="payerReceiver",
               isRequired=true)
public CommodityPayout.CommodityPayoutBuilder setPayerReceiver(PayerReceiver _payerReceiver)

Specified by:

setPayerReceiver in interface CommodityPayout.CommodityPayoutBuilder

Specified by:

setPayerReceiver in interface PayoutBase.PayoutBaseBuilder

Overrides:

setPayerReceiver in class PayoutBase.PayoutBaseBuilderImpl

setPriceQuantity

@RosettaAttribute("priceQuantity")
@RuneAttribute("priceQuantity")
public CommodityPayout.CommodityPayoutBuilder setPriceQuantity(ResolvablePriceQuantity _priceQuantity)

Specified by:

setPriceQuantity in interface CommodityPayout.CommodityPayoutBuilder

Specified by:

setPriceQuantity in interface PayoutBase.PayoutBaseBuilder

Overrides:

setPriceQuantity in class PayoutBase.PayoutBaseBuilderImpl

setPrincipalPayment

@RosettaAttribute("principalPayment")
@RuneAttribute("principalPayment")
public CommodityPayout.CommodityPayoutBuilder setPrincipalPayment(PrincipalPayments _principalPayment)

Specified by:

setPrincipalPayment in interface CommodityPayout.CommodityPayoutBuilder

Specified by:

setPrincipalPayment in interface PayoutBase.PayoutBaseBuilder

Overrides:

setPrincipalPayment in class PayoutBase.PayoutBaseBuilderImpl

setSettlementTerms

@RosettaAttribute("settlementTerms")
@RuneAttribute("settlementTerms")
public CommodityPayout.CommodityPayoutBuilder setSettlementTerms(SettlementTerms _settlementTerms)

Specified by:

setSettlementTerms in interface CommodityPayout.CommodityPayoutBuilder

Specified by:

setSettlementTerms in interface PayoutBase.PayoutBaseBuilder

Overrides:

setSettlementTerms in class PayoutBase.PayoutBaseBuilderImpl

setAveragingFeature

@RosettaAttribute("averagingFeature")
@RuneAttribute("averagingFeature")
public CommodityPayout.CommodityPayoutBuilder setAveragingFeature(AveragingCalculation _averagingFeature)

Specified by:

setAveragingFeature in interface CommodityPayout.CommodityPayoutBuilder

setCommodityPriceReturnTerms

@RosettaAttribute("commodityPriceReturnTerms")
@RuneAttribute("commodityPriceReturnTerms")
public CommodityPayout.CommodityPayoutBuilder setCommodityPriceReturnTerms(CommodityPriceReturnTerms _commodityPriceReturnTerms)

Specified by:

setCommodityPriceReturnTerms in interface CommodityPayout.CommodityPayoutBuilder

setPricingDates

@RosettaAttribute(value="pricingDates",
                  isRequired=true)
@RuneAttribute(value="pricingDates",
               isRequired=true)
public CommodityPayout.CommodityPayoutBuilder setPricingDates(PricingDates _pricingDates)

Specified by:

setPricingDates in interface CommodityPayout.CommodityPayoutBuilder

setSchedule

@RosettaAttribute("schedule")
@RuneAttribute("schedule")
public CommodityPayout.CommodityPayoutBuilder setSchedule(CalculationSchedule _schedule)

Specified by:

setSchedule in interface CommodityPayout.CommodityPayoutBuilder

setCalculationPeriodDates

@RosettaAttribute("calculationPeriodDates")
@RuneAttribute("calculationPeriodDates")
public CommodityPayout.CommodityPayoutBuilder setCalculationPeriodDates(CalculationPeriodDates _calculationPeriodDates)

Specified by:

setCalculationPeriodDates in interface CommodityPayout.CommodityPayoutBuilder

setPaymentDates

@RosettaAttribute(value="paymentDates",
                  isRequired=true)
@RuneAttribute(value="paymentDates",
               isRequired=true)
public CommodityPayout.CommodityPayoutBuilder setPaymentDates(PaymentDates _paymentDates)

Specified by:

setPaymentDates in interface CommodityPayout.CommodityPayoutBuilder

setUnderlier

@RosettaAttribute(value="underlier",
                  isRequired=true)
@RuneAttribute(value="underlier",
               isRequired=true)
public CommodityPayout.CommodityPayoutBuilder setUnderlier(Product _underlier)

Specified by:

setUnderlier in interface CommodityPayout.CommodityPayoutBuilder

setFxFeature

@RosettaAttribute("fxFeature")
@RuneAttribute("fxFeature")
public CommodityPayout.CommodityPayoutBuilder setFxFeature(FxFeature _fxFeature)

Specified by:

setFxFeature in interface CommodityPayout.CommodityPayoutBuilder

setDelivery

@RosettaAttribute("delivery")
@RuneAttribute("delivery")
public CommodityPayout.CommodityPayoutBuilder setDelivery(AssetDeliveryInformation _delivery)

Specified by:

setDelivery in interface CommodityPayout.CommodityPayoutBuilder

setMeta

@RosettaAttribute("meta")
@RuneAttribute("meta")
@RuneMetaType
public CommodityPayout.CommodityPayoutBuilder setMeta(com.rosetta.model.metafields.MetaFields _meta)

Specified by:

setMeta in interface CommodityPayout.CommodityPayoutBuilder

build

public CommodityPayout build()

Description copied from interface: PayoutBase

Build Methods

Specified by:

build in interface CommodityPayout

Specified by:

build in interface PayoutBase

Specified by:

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

Overrides:

build in class PayoutBase.PayoutBaseBuilderImpl

toBuilder

public CommodityPayout.CommodityPayoutBuilder toBuilder()

Specified by:

toBuilder in interface CommodityPayout

Specified by:

toBuilder in interface PayoutBase

Specified by:

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

Overrides:

toBuilder in class PayoutBase.PayoutBaseBuilderImpl

prune

public CommodityPayout.CommodityPayoutBuilder prune()

Specified by:

prune in interface CommodityPayout.CommodityPayoutBuilder

Specified by:

prune in interface PayoutBase.PayoutBaseBuilder

Specified by:

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

Overrides:

prune in class PayoutBase.PayoutBaseBuilderImpl

hasData

public boolean hasData()

Specified by:

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

Overrides:

hasData in class PayoutBase.PayoutBaseBuilderImpl

merge

public CommodityPayout.CommodityPayoutBuilder merge(com.rosetta.model.lib.RosettaModelObjectBuilder other,
 com.rosetta.model.lib.process.BuilderMerger merger)

Specified by:

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

Overrides:

merge in class PayoutBase.PayoutBaseBuilderImpl

equals

public boolean equals(Object o)

Overrides:

equals in class PayoutBase.PayoutBaseBuilderImpl

hashCode

public int hashCode()

Overrides:

hashCode in class PayoutBase.PayoutBaseBuilderImpl

toString

public String toString()

Overrides:

toString in class PayoutBase.PayoutBaseBuilderImpl