Package cdm.product.template

Class OptionPayout.OptionPayoutBuilderImpl

java.lang.Object

cdm.product.common.settlement.PayoutBase.PayoutBaseBuilderImpl

cdm.product.template.OptionPayout.OptionPayoutBuilderImpl

All Implemented Interfaces:

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

Enclosing interface:

OptionPayout

public static class OptionPayout.OptionPayoutBuilderImpl
extends PayoutBase.PayoutBaseBuilderImpl
implements OptionPayout.OptionPayoutBuilder

Builder Implementation of OptionPayout

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.OptionPayout

OptionPayout.OptionPayoutBuilder, OptionPayout.OptionPayoutBuilderImpl, OptionPayout.OptionPayoutImpl

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 BuyerSeller.BuyerSellerBuilder	buyerSeller
protected AssetDeliveryInformation.AssetDeliveryInformationBuilder	delivery
protected OptionExercise.OptionExerciseBuilder	exerciseTerms
protected OptionFeature.OptionFeatureBuilder	feature
protected com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder	meta
protected ObservationTerms.ObservationTermsBuilder	observationTerms
protected OptionTypeEnum	optionType
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.template.OptionPayout

metaData

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

metaData

Constructor Summary

Constructors

Constructor	Description
OptionPayoutBuilderImpl()

Method Summary

Modifier and Type	Method	Description
OptionPayout	build()	Build Methods
boolean	equals(Object o)
BuyerSeller.BuyerSellerBuilder	getBuyerSeller()	Getter Methods
AssetDeliveryInformation.AssetDeliveryInformationBuilder	getDelivery()	Contains the information relative to the delivery of the asset.
OptionExercise.OptionExerciseBuilder	getExerciseTerms()	The terms for exercising the option, which include the option style (e.g.
OptionFeature.OptionFeatureBuilder	getFeature()	The option feature, such as quanto, Asian, barrier, knock.
com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder	getMeta()
ObservationTerms.ObservationTermsBuilder	getObservationTerms()	Class containing terms that are associated with observing a price/benchmark/index across either single or multple observations.
OptionTypeEnum	getOptionType()	The type of option transaction.
BuyerSeller.BuyerSellerBuilder	getOrCreateBuyerSeller()
AssetDeliveryInformation.AssetDeliveryInformationBuilder	getOrCreateDelivery()
OptionExercise.OptionExerciseBuilder	getOrCreateExerciseTerms()
OptionFeature.OptionFeatureBuilder	getOrCreateFeature()
com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder	getOrCreateMeta()
ObservationTerms.ObservationTermsBuilder	getOrCreateObservationTerms()
CalculationSchedule.CalculationScheduleBuilder	getOrCreateSchedule()
Product.ProductBuilder	getOrCreateUnderlier()
CalculationSchedule.CalculationScheduleBuilder	getSchedule()	Allows the full representation of a payout by defining a set of schedule periods.
Product.ProductBuilder	getUnderlier()	The product underlying the option, which can be of any type including ContractualProduct or Security.
boolean	hasData()
int	hashCode()
OptionPayout.OptionPayoutBuilder	merge(com.rosetta.model.lib.RosettaModelObjectBuilder other, com.rosetta.model.lib.process.BuilderMerger merger)
OptionPayout.OptionPayoutBuilder	prune()
OptionPayout.OptionPayoutBuilder	setBuyerSeller(BuyerSeller _buyerSeller)
OptionPayout.OptionPayoutBuilder	setDelivery(AssetDeliveryInformation _delivery)
OptionPayout.OptionPayoutBuilder	setExerciseTerms(OptionExercise _exerciseTerms)
OptionPayout.OptionPayoutBuilder	setFeature(OptionFeature _feature)
OptionPayout.OptionPayoutBuilder	setMeta(com.rosetta.model.metafields.MetaFields _meta)
OptionPayout.OptionPayoutBuilder	setObservationTerms(ObservationTerms _observationTerms)
OptionPayout.OptionPayoutBuilder	setOptionType(OptionTypeEnum _optionType)
OptionPayout.OptionPayoutBuilder	setPayerReceiver(PayerReceiver _payerReceiver)
OptionPayout.OptionPayoutBuilder	setPriceQuantity(ResolvablePriceQuantity _priceQuantity)
OptionPayout.OptionPayoutBuilder	setPrincipalPayment(PrincipalPayments _principalPayment)
OptionPayout.OptionPayoutBuilder	setSchedule(CalculationSchedule _schedule)
OptionPayout.OptionPayoutBuilder	setSettlementTerms(SettlementTerms _settlementTerms)
OptionPayout.OptionPayoutBuilder	setUnderlier(Product _underlier)
OptionPayout.OptionPayoutBuilder	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.template.OptionPayout

getType, metaData, process

Methods inherited from interface cdm.product.template.OptionPayout.OptionPayoutBuilder

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

buyerSeller

protected BuyerSeller.BuyerSellerBuilder buyerSeller

optionType

protected OptionTypeEnum optionType

feature

protected OptionFeature.OptionFeatureBuilder feature

exerciseTerms

protected OptionExercise.OptionExerciseBuilder exerciseTerms

underlier

protected Product.ProductBuilder underlier

observationTerms

protected ObservationTerms.ObservationTermsBuilder observationTerms

schedule

protected CalculationSchedule.CalculationScheduleBuilder schedule

delivery

protected AssetDeliveryInformation.AssetDeliveryInformationBuilder delivery

meta

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

Constructor Details

OptionPayoutBuilderImpl

public OptionPayoutBuilderImpl()

Method Details

getBuyerSeller

@RosettaAttribute(value="buyerSeller",
                  isRequired=true)
@RuneAttribute(value="buyerSeller",
               isRequired=true)
public BuyerSeller.BuyerSellerBuilder getBuyerSeller()

Description copied from interface: OptionPayout

Getter Methods

Specified by:

getBuyerSeller in interface OptionPayout

Specified by:

getBuyerSeller in interface OptionPayout.OptionPayoutBuilder

getOrCreateBuyerSeller

public BuyerSeller.BuyerSellerBuilder getOrCreateBuyerSeller()

Specified by:

getOrCreateBuyerSeller in interface OptionPayout.OptionPayoutBuilder

getOptionType

@RosettaAttribute("optionType")
@RuneAttribute("optionType")
public OptionTypeEnum getOptionType()

Description copied from interface: OptionPayout

The type of option transaction. From a usage standpoint, put/call is the default option type, while payer/receiver indicator is used for options on index credit default swaps, consistently with the industry practice. Straddle is used for the case of straddle strategy, that combine a call and a put with the same strike.

Specified by:

getOptionType in interface OptionPayout

getFeature

@RosettaAttribute("feature")
@RuneAttribute("feature")
public OptionFeature.OptionFeatureBuilder getFeature()

Description copied from interface: OptionPayout

The option feature, such as quanto, Asian, barrier, knock.

Specified by:

getFeature in interface OptionPayout

Specified by:

getFeature in interface OptionPayout.OptionPayoutBuilder

getOrCreateFeature

public OptionFeature.OptionFeatureBuilder getOrCreateFeature()

Specified by:

getOrCreateFeature in interface OptionPayout.OptionPayoutBuilder

getExerciseTerms

@RosettaAttribute(value="exerciseTerms",
                  isRequired=true)
@RuneAttribute(value="exerciseTerms",
               isRequired=true)
public OptionExercise.OptionExerciseBuilder getExerciseTerms()

Description copied from interface: OptionPayout

The terms for exercising the option, which include the option style (e.g. American style option), the exercise procedure (e.g. manual exercise) and the settlement terms (e.g. physical vs. cash).

Specified by:

getExerciseTerms in interface OptionPayout

Specified by:

getExerciseTerms in interface OptionPayout.OptionPayoutBuilder

getOrCreateExerciseTerms

public OptionExercise.OptionExerciseBuilder getOrCreateExerciseTerms()

Specified by:

getOrCreateExerciseTerms in interface OptionPayout.OptionPayoutBuilder

getUnderlier

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

Description copied from interface: OptionPayout

The product underlying the option, which can be of any type including ContractualProduct or Security.

Specified by:

getUnderlier in interface OptionPayout

Specified by:

getUnderlier in interface OptionPayout.OptionPayoutBuilder

getOrCreateUnderlier

public Product.ProductBuilder getOrCreateUnderlier()

Specified by:

getOrCreateUnderlier in interface OptionPayout.OptionPayoutBuilder

getObservationTerms

@RosettaAttribute("observationTerms")
@RuneAttribute("observationTerms")
public ObservationTerms.ObservationTermsBuilder getObservationTerms()

Description copied from interface: OptionPayout

Class containing terms that are associated with observing a price/benchmark/index across either single or multple observations. To be used for option contracts that reference a benchmark price.

Specified by:

getObservationTerms in interface OptionPayout

Specified by:

getObservationTerms in interface OptionPayout.OptionPayoutBuilder

getOrCreateObservationTerms

public ObservationTerms.ObservationTermsBuilder getOrCreateObservationTerms()

Specified by:

getOrCreateObservationTerms in interface OptionPayout.OptionPayoutBuilder

getSchedule

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

Description copied from interface: OptionPayout

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 OptionPayout

Specified by:

getSchedule in interface OptionPayout.OptionPayoutBuilder

getOrCreateSchedule

public CalculationSchedule.CalculationScheduleBuilder getOrCreateSchedule()

Specified by:

getOrCreateSchedule in interface OptionPayout.OptionPayoutBuilder

getDelivery

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

Description copied from interface: OptionPayout

Contains the information relative to the delivery of the asset.

Specified by:

getDelivery in interface OptionPayout

Specified by:

getDelivery in interface OptionPayout.OptionPayoutBuilder

getOrCreateDelivery

public AssetDeliveryInformation.AssetDeliveryInformationBuilder getOrCreateDelivery()

Specified by:

getOrCreateDelivery in interface OptionPayout.OptionPayoutBuilder

getMeta

@RosettaAttribute("meta")
@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 OptionPayout

Specified by:

getMeta in interface OptionPayout.OptionPayoutBuilder

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 OptionPayout.OptionPayoutBuilder

setPayerReceiver

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

Specified by:

setPayerReceiver in interface OptionPayout.OptionPayoutBuilder

Specified by:

setPayerReceiver in interface PayoutBase.PayoutBaseBuilder

Overrides:

setPayerReceiver in class PayoutBase.PayoutBaseBuilderImpl

setPriceQuantity

@RosettaAttribute("priceQuantity")
@RuneAttribute("priceQuantity")
public OptionPayout.OptionPayoutBuilder setPriceQuantity(ResolvablePriceQuantity _priceQuantity)

Specified by:

setPriceQuantity in interface OptionPayout.OptionPayoutBuilder

Specified by:

setPriceQuantity in interface PayoutBase.PayoutBaseBuilder

Overrides:

setPriceQuantity in class PayoutBase.PayoutBaseBuilderImpl

setPrincipalPayment

@RosettaAttribute("principalPayment")
@RuneAttribute("principalPayment")
public OptionPayout.OptionPayoutBuilder setPrincipalPayment(PrincipalPayments _principalPayment)

Specified by:

setPrincipalPayment in interface OptionPayout.OptionPayoutBuilder

Specified by:

setPrincipalPayment in interface PayoutBase.PayoutBaseBuilder

Overrides:

setPrincipalPayment in class PayoutBase.PayoutBaseBuilderImpl

setSettlementTerms

@RosettaAttribute("settlementTerms")
@RuneAttribute("settlementTerms")
public OptionPayout.OptionPayoutBuilder setSettlementTerms(SettlementTerms _settlementTerms)

Specified by:

setSettlementTerms in interface OptionPayout.OptionPayoutBuilder

Specified by:

setSettlementTerms in interface PayoutBase.PayoutBaseBuilder

Overrides:

setSettlementTerms in class PayoutBase.PayoutBaseBuilderImpl

setBuyerSeller

@RosettaAttribute(value="buyerSeller",
                  isRequired=true)
@RuneAttribute(value="buyerSeller",
               isRequired=true)
public OptionPayout.OptionPayoutBuilder setBuyerSeller(BuyerSeller _buyerSeller)

Specified by:

setBuyerSeller in interface OptionPayout.OptionPayoutBuilder

setOptionType

@RosettaAttribute("optionType")
@RuneAttribute("optionType")
public OptionPayout.OptionPayoutBuilder setOptionType(OptionTypeEnum _optionType)

Specified by:

setOptionType in interface OptionPayout.OptionPayoutBuilder

setFeature

@RosettaAttribute("feature")
@RuneAttribute("feature")
public OptionPayout.OptionPayoutBuilder setFeature(OptionFeature _feature)

Specified by:

setFeature in interface OptionPayout.OptionPayoutBuilder

setExerciseTerms

@RosettaAttribute(value="exerciseTerms",
                  isRequired=true)
@RuneAttribute(value="exerciseTerms",
               isRequired=true)
public OptionPayout.OptionPayoutBuilder setExerciseTerms(OptionExercise _exerciseTerms)

Specified by:

setExerciseTerms in interface OptionPayout.OptionPayoutBuilder

setUnderlier

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

Specified by:

setUnderlier in interface OptionPayout.OptionPayoutBuilder

setObservationTerms

@RosettaAttribute("observationTerms")
@RuneAttribute("observationTerms")
public OptionPayout.OptionPayoutBuilder setObservationTerms(ObservationTerms _observationTerms)

Specified by:

setObservationTerms in interface OptionPayout.OptionPayoutBuilder

setSchedule

@RosettaAttribute("schedule")
@RuneAttribute("schedule")
public OptionPayout.OptionPayoutBuilder setSchedule(CalculationSchedule _schedule)

Specified by:

setSchedule in interface OptionPayout.OptionPayoutBuilder

setDelivery

@RosettaAttribute("delivery")
@RuneAttribute("delivery")
public OptionPayout.OptionPayoutBuilder setDelivery(AssetDeliveryInformation _delivery)

Specified by:

setDelivery in interface OptionPayout.OptionPayoutBuilder

setMeta

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

Specified by:

setMeta in interface OptionPayout.OptionPayoutBuilder

build

public OptionPayout build()

Description copied from interface: PayoutBase

Build Methods

Specified by:

build in interface OptionPayout

Specified by:

build in interface PayoutBase

Specified by:

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

Overrides:

build in class PayoutBase.PayoutBaseBuilderImpl

toBuilder

public OptionPayout.OptionPayoutBuilder toBuilder()

Specified by:

toBuilder in interface OptionPayout

Specified by:

toBuilder in interface PayoutBase

Specified by:

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

Overrides:

toBuilder in class PayoutBase.PayoutBaseBuilderImpl

prune

public OptionPayout.OptionPayoutBuilder prune()

Specified by:

prune in interface OptionPayout.OptionPayoutBuilder

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 OptionPayout.OptionPayoutBuilder 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