Package cdm.product.template

Class ForwardPayout.ForwardPayoutBuilderImpl

java.lang.Object

cdm.product.common.settlement.PayoutBase.PayoutBaseBuilderImpl

cdm.product.template.ForwardPayout.ForwardPayoutBuilderImpl

All Implemented Interfaces:

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

Enclosing interface:

ForwardPayout

public static class ForwardPayout.ForwardPayoutBuilderImpl
extends PayoutBase.PayoutBaseBuilderImpl
implements ForwardPayout.ForwardPayoutBuilder

Builder Implementation of ForwardPayout

Nested Class Summary

Nested classes/interfaces inherited from interface cdm.product.template.ForwardPayout

ForwardPayout.ForwardPayoutBuilder, ForwardPayout.ForwardPayoutBuilderImpl, ForwardPayout.ForwardPayoutImpl

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 AssetDeliveryInformation.AssetDeliveryInformationBuilder	delivery
protected String	deliveryTerm
protected com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder	meta
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.ForwardPayout

metaData

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

metaData

Constructor Summary

Constructors

Constructor	Description
ForwardPayoutBuilderImpl()

Method Summary

Modifier and Type	Method	Description
ForwardPayout	build()	Build Methods
boolean	equals(Object o)
AssetDeliveryInformation.AssetDeliveryInformationBuilder	getDelivery()	Contains the information relative to the delivery of the asset.
String	getDeliveryTerm()	Also called contract month or delivery month.
com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder	getMeta()
AssetDeliveryInformation.AssetDeliveryInformationBuilder	getOrCreateDelivery()
com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder	getOrCreateMeta()
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()	Underlying product that the forward is written on, which can be of any type: FX, a contractual product, a security, etc.
boolean	hasData()
int	hashCode()
ForwardPayout.ForwardPayoutBuilder	merge(com.rosetta.model.lib.RosettaModelObjectBuilder other, com.rosetta.model.lib.process.BuilderMerger merger)
ForwardPayout.ForwardPayoutBuilder	prune()
ForwardPayout.ForwardPayoutBuilder	setDelivery(AssetDeliveryInformation _delivery)
ForwardPayout.ForwardPayoutBuilder	setDeliveryTerm(String _deliveryTerm)
ForwardPayout.ForwardPayoutBuilder	setMeta(com.rosetta.model.metafields.MetaFields _meta)
ForwardPayout.ForwardPayoutBuilder	setPayerReceiver(PayerReceiver _payerReceiver)
ForwardPayout.ForwardPayoutBuilder	setPriceQuantity(ResolvablePriceQuantity _priceQuantity)
ForwardPayout.ForwardPayoutBuilder	setPrincipalPayment(PrincipalPayments _principalPayment)
ForwardPayout.ForwardPayoutBuilder	setSchedule(CalculationSchedule _schedule)
ForwardPayout.ForwardPayoutBuilder	setSettlementTerms(SettlementTerms _settlementTerms)
ForwardPayout.ForwardPayoutBuilder	setUnderlier(Product _underlier)
ForwardPayout.ForwardPayoutBuilder	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.ForwardPayout

getType, metaData, process

Methods inherited from interface cdm.product.template.ForwardPayout.ForwardPayoutBuilder

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

underlier

protected Product.ProductBuilder underlier

deliveryTerm

protected String deliveryTerm

delivery

protected AssetDeliveryInformation.AssetDeliveryInformationBuilder delivery

schedule

protected CalculationSchedule.CalculationScheduleBuilder schedule

meta

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

Constructor Details

ForwardPayoutBuilderImpl

public ForwardPayoutBuilderImpl()

Method Details

getUnderlier

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

Description copied from interface: ForwardPayout

Underlying product that the forward is written on, which can be of any type: FX, a contractual product, a security, etc.

Specified by:

getUnderlier in interface ForwardPayout

Specified by:

getUnderlier in interface ForwardPayout.ForwardPayoutBuilder

getOrCreateUnderlier

public Product.ProductBuilder getOrCreateUnderlier()

Specified by:

getOrCreateUnderlier in interface ForwardPayout.ForwardPayoutBuilder

getDeliveryTerm

@RosettaAttribute("deliveryTerm")
@RuneAttribute("deliveryTerm")
public String getDeliveryTerm()

Description copied from interface: ForwardPayout

Also called contract month or delivery month. However, it's not always a month. It is usually expressed using a code, e.g. Z23 would be the Dec 2023 contract, (Z = December). For crude oil, the corresponding contract might be called CLZ23.

Specified by:

getDeliveryTerm in interface ForwardPayout

getDelivery

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

Description copied from interface: ForwardPayout

Contains the information relative to the delivery of the asset.

Specified by:

getDelivery in interface ForwardPayout

Specified by:

getDelivery in interface ForwardPayout.ForwardPayoutBuilder

getOrCreateDelivery

public AssetDeliveryInformation.AssetDeliveryInformationBuilder getOrCreateDelivery()

Specified by:

getOrCreateDelivery in interface ForwardPayout.ForwardPayoutBuilder

getSchedule

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

Description copied from interface: ForwardPayout

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 ForwardPayout

Specified by:

getSchedule in interface ForwardPayout.ForwardPayoutBuilder

getOrCreateSchedule

public CalculationSchedule.CalculationScheduleBuilder getOrCreateSchedule()

Specified by:

getOrCreateSchedule in interface ForwardPayout.ForwardPayoutBuilder

getMeta

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

Specified by:

getMeta in interface ForwardPayout

Specified by:

getMeta in interface ForwardPayout.ForwardPayoutBuilder

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 ForwardPayout.ForwardPayoutBuilder

Specified by:

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

setPayerReceiver

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

Specified by:

setPayerReceiver in interface ForwardPayout.ForwardPayoutBuilder

Specified by:

setPayerReceiver in interface PayoutBase.PayoutBaseBuilder

Overrides:

setPayerReceiver in class PayoutBase.PayoutBaseBuilderImpl

setPriceQuantity

@RosettaAttribute("priceQuantity")
@RuneAttribute("priceQuantity")
public ForwardPayout.ForwardPayoutBuilder setPriceQuantity(ResolvablePriceQuantity _priceQuantity)

Specified by:

setPriceQuantity in interface ForwardPayout.ForwardPayoutBuilder

Specified by:

setPriceQuantity in interface PayoutBase.PayoutBaseBuilder

Overrides:

setPriceQuantity in class PayoutBase.PayoutBaseBuilderImpl

setPrincipalPayment

@RosettaAttribute("principalPayment")
@RuneAttribute("principalPayment")
public ForwardPayout.ForwardPayoutBuilder setPrincipalPayment(PrincipalPayments _principalPayment)

Specified by:

setPrincipalPayment in interface ForwardPayout.ForwardPayoutBuilder

Specified by:

setPrincipalPayment in interface PayoutBase.PayoutBaseBuilder

Overrides:

setPrincipalPayment in class PayoutBase.PayoutBaseBuilderImpl

setSettlementTerms

@RosettaAttribute("settlementTerms")
@RuneAttribute("settlementTerms")
public ForwardPayout.ForwardPayoutBuilder setSettlementTerms(SettlementTerms _settlementTerms)

Specified by:

setSettlementTerms in interface ForwardPayout.ForwardPayoutBuilder

Specified by:

setSettlementTerms in interface PayoutBase.PayoutBaseBuilder

Overrides:

setSettlementTerms in class PayoutBase.PayoutBaseBuilderImpl

setUnderlier

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

Specified by:

setUnderlier in interface ForwardPayout.ForwardPayoutBuilder

setDeliveryTerm

@RosettaAttribute("deliveryTerm")
@RuneAttribute("deliveryTerm")
public ForwardPayout.ForwardPayoutBuilder setDeliveryTerm(String _deliveryTerm)

Specified by:

setDeliveryTerm in interface ForwardPayout.ForwardPayoutBuilder

setDelivery

@RosettaAttribute("delivery")
@RuneAttribute("delivery")
public ForwardPayout.ForwardPayoutBuilder setDelivery(AssetDeliveryInformation _delivery)

Specified by:

setDelivery in interface ForwardPayout.ForwardPayoutBuilder

setSchedule

@RosettaAttribute("schedule")
@RuneAttribute("schedule")
public ForwardPayout.ForwardPayoutBuilder setSchedule(CalculationSchedule _schedule)

Specified by:

setSchedule in interface ForwardPayout.ForwardPayoutBuilder

setMeta

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

Specified by:

setMeta in interface ForwardPayout.ForwardPayoutBuilder

build

public ForwardPayout build()

Description copied from interface: PayoutBase

Build Methods

Specified by:

build in interface ForwardPayout

Specified by:

build in interface PayoutBase

Specified by:

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

Overrides:

build in class PayoutBase.PayoutBaseBuilderImpl

toBuilder

public ForwardPayout.ForwardPayoutBuilder toBuilder()

Specified by:

toBuilder in interface ForwardPayout

Specified by:

toBuilder in interface PayoutBase

Specified by:

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

Overrides:

toBuilder in class PayoutBase.PayoutBaseBuilderImpl

prune

public ForwardPayout.ForwardPayoutBuilder prune()

Specified by:

prune in interface ForwardPayout.ForwardPayoutBuilder

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 ForwardPayout.ForwardPayoutBuilder 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