Package cdm.product.asset

Interface CommodityPayout.CommodityPayoutBuilder

All Superinterfaces:

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

All Known Implementing Classes:

CommodityPayout.CommodityPayoutBuilderImpl

Enclosing interface:

CommodityPayout

public static interface CommodityPayout.CommodityPayoutBuilder
extends CommodityPayout, PayoutBase.PayoutBaseBuilder, com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder

Builder Interface

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 inherited from interface cdm.product.asset.CommodityPayout

metaData

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

metaData

Method Summary

Modifier and Type	Method	Description
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.
default void	process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.BuilderProcessor processor)
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)

Methods inherited from interface cdm.product.asset.CommodityPayout

build, getType, metaData, process, toBuilder

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, hasData, merge, processRosetta, processRosetta

Method Details

getOrCreateAveragingFeature

AveragingCalculation.AveragingCalculationBuilder getOrCreateAveragingFeature()

getAveragingFeature

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

getOrCreateCommodityPriceReturnTerms

CommodityPriceReturnTerms.CommodityPriceReturnTermsBuilder getOrCreateCommodityPriceReturnTerms()

getCommodityPriceReturnTerms

CommodityPriceReturnTerms.CommodityPriceReturnTermsBuilder getCommodityPriceReturnTerms()

Description copied from interface: CommodityPayout

Defines parameters in which the commodity price is assessed.

Specified by:

getCommodityPriceReturnTerms in interface CommodityPayout

getOrCreatePricingDates

PricingDates.PricingDatesBuilder getOrCreatePricingDates()

getPricingDates

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

getOrCreateSchedule

CalculationSchedule.CalculationScheduleBuilder getOrCreateSchedule()

getSchedule

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

getOrCreateCalculationPeriodDates

CalculationPeriodDates.CalculationPeriodDatesBuilder getOrCreateCalculationPeriodDates()

getCalculationPeriodDates

CalculationPeriodDates.CalculationPeriodDatesBuilder getCalculationPeriodDates()

Description copied from interface: CommodityPayout

Defines the calculation period dates schedule.

Specified by:

getCalculationPeriodDates in interface CommodityPayout

getOrCreatePaymentDates

PaymentDates.PaymentDatesBuilder getOrCreatePaymentDates()

getPaymentDates

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

getOrCreateUnderlier

Product.ProductBuilder getOrCreateUnderlier()

getUnderlier

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

getOrCreateFxFeature

FxFeature.FxFeatureBuilder getOrCreateFxFeature()

getFxFeature

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

getOrCreateDelivery

AssetDeliveryInformation.AssetDeliveryInformationBuilder getOrCreateDelivery()

getDelivery

AssetDeliveryInformation.AssetDeliveryInformationBuilder getDelivery()

Description copied from interface: CommodityPayout

Contains the information relative to the delivery of the asset.

Specified by:

getDelivery in interface CommodityPayout

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 CommodityPayout

Specified by:

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

Specified by:

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

setPayerReceiver

CommodityPayout.CommodityPayoutBuilder setPayerReceiver(PayerReceiver payerReceiver)

Specified by:

setPayerReceiver in interface PayoutBase.PayoutBaseBuilder

setPriceQuantity

CommodityPayout.CommodityPayoutBuilder setPriceQuantity(ResolvablePriceQuantity priceQuantity)

Specified by:

setPriceQuantity in interface PayoutBase.PayoutBaseBuilder

setPrincipalPayment

CommodityPayout.CommodityPayoutBuilder setPrincipalPayment(PrincipalPayments principalPayment)

Specified by:

setPrincipalPayment in interface PayoutBase.PayoutBaseBuilder

setSettlementTerms

CommodityPayout.CommodityPayoutBuilder setSettlementTerms(SettlementTerms settlementTerms)

Specified by:

setSettlementTerms in interface PayoutBase.PayoutBaseBuilder

setAveragingFeature

CommodityPayout.CommodityPayoutBuilder setAveragingFeature(AveragingCalculation averagingFeature)

setCommodityPriceReturnTerms

CommodityPayout.CommodityPayoutBuilder setCommodityPriceReturnTerms(CommodityPriceReturnTerms commodityPriceReturnTerms)

setPricingDates

CommodityPayout.CommodityPayoutBuilder setPricingDates(PricingDates pricingDates)

setSchedule

CommodityPayout.CommodityPayoutBuilder setSchedule(CalculationSchedule schedule)

setCalculationPeriodDates

CommodityPayout.CommodityPayoutBuilder setCalculationPeriodDates(CalculationPeriodDates calculationPeriodDates)

setPaymentDates

CommodityPayout.CommodityPayoutBuilder setPaymentDates(PaymentDates paymentDates)

setUnderlier

CommodityPayout.CommodityPayoutBuilder setUnderlier(Product underlier)

setFxFeature

CommodityPayout.CommodityPayoutBuilder setFxFeature(FxFeature fxFeature)

setDelivery

CommodityPayout.CommodityPayoutBuilder setDelivery(AssetDeliveryInformation delivery)

setMeta

CommodityPayout.CommodityPayoutBuilder 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 PayoutBase.PayoutBaseBuilder

Specified by:

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

prune

CommodityPayout.CommodityPayoutBuilder prune()

Specified by:

prune in interface PayoutBase.PayoutBaseBuilder

Specified by:

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