Package cdm.product.template

Class SettlementPayout.SettlementPayoutBuilderImpl

java.lang.Object

cdm.product.common.settlement.PayoutBase.PayoutBaseBuilderImpl

cdm.product.template.SettlementPayout.SettlementPayoutBuilderImpl

All Implemented Interfaces:

PayoutBase, PayoutBase.PayoutBaseBuilder, SettlementPayout, SettlementPayout.SettlementPayoutBuilder, com.rosetta.model.lib.RosettaModelObject, com.rosetta.model.lib.RosettaModelObjectBuilder

Enclosing interface:

SettlementPayout

public static class SettlementPayout.SettlementPayoutBuilderImpl
extends PayoutBase.PayoutBaseBuilderImpl
implements SettlementPayout.SettlementPayoutBuilder

Builder Implementation of SettlementPayout

Nested Class Summary

Nested classes/interfaces inherited from interface cdm.product.common.settlement.PayoutBase

PayoutBase.PayoutBaseBuilder, PayoutBase.PayoutBaseBuilderImpl, PayoutBase.PayoutBaseImpl

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

SettlementPayout.SettlementPayoutBuilder, SettlementPayout.SettlementPayoutBuilderImpl, SettlementPayout.SettlementPayoutImpl

Field Summary

Fields

Modifier and Type	Field	Description
protected AssetDeliveryInformation.AssetDeliveryInformationBuilder	delivery
protected String	deliveryTerm
protected CalculationSchedule.CalculationScheduleBuilder	schedule
protected Underlier.UnderlierBuilder	underlier

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

payerReceiver, priceQuantity, principalPayment, settlementTerms

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

metaData

Fields inherited from interface cdm.product.template.SettlementPayout

metaData

Constructor Summary

Constructors

Constructor	Description
SettlementPayoutBuilderImpl()

Method Summary

Modifier and Type	Method	Description
SettlementPayout	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.
AssetDeliveryInformation.AssetDeliveryInformationBuilder	getOrCreateDelivery()
CalculationSchedule.CalculationScheduleBuilder	getOrCreateSchedule()
Underlier.UnderlierBuilder	getOrCreateUnderlier()
CalculationSchedule.CalculationScheduleBuilder	getSchedule()	Allows the full representation of a payout by defining a set of schedule periods.
Underlier.UnderlierBuilder	getUnderlier()	The underlying financial product that will be physically or cash settled, which can be of any type, eg an asset such as cash or a security, or the cash settlement of an index rate.
boolean	hasData()
int	hashCode()
SettlementPayout.SettlementPayoutBuilder	merge(com.rosetta.model.lib.RosettaModelObjectBuilder other, com.rosetta.model.lib.process.BuilderMerger merger)
SettlementPayout.SettlementPayoutBuilder	prune()
SettlementPayout.SettlementPayoutBuilder	setDelivery(AssetDeliveryInformation _delivery)
SettlementPayout.SettlementPayoutBuilder	setDeliveryTerm(String _deliveryTerm)
SettlementPayout.SettlementPayoutBuilder	setPayerReceiver(PayerReceiver _payerReceiver)
SettlementPayout.SettlementPayoutBuilder	setPriceQuantity(ResolvablePriceQuantity _priceQuantity)
SettlementPayout.SettlementPayoutBuilder	setPrincipalPayment(PrincipalPayments _principalPayment)
SettlementPayout.SettlementPayoutBuilder	setSchedule(CalculationSchedule _schedule)
SettlementPayout.SettlementPayoutBuilder	setSettlementTerms(SettlementTerms _settlementTerms)
SettlementPayout.SettlementPayoutBuilder	setUnderlier(Underlier _underlier)
SettlementPayout.SettlementPayoutBuilder	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.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

Methods inherited from interface cdm.product.template.SettlementPayout

getType, metaData, process

Methods inherited from interface cdm.product.template.SettlementPayout.SettlementPayoutBuilder

process

Field Details

underlier

protected Underlier.UnderlierBuilder underlier

deliveryTerm

protected String deliveryTerm

delivery

protected AssetDeliveryInformation.AssetDeliveryInformationBuilder delivery

schedule

protected CalculationSchedule.CalculationScheduleBuilder schedule

Constructor Details

SettlementPayoutBuilderImpl

public SettlementPayoutBuilderImpl()

Method Details

getUnderlier

@RosettaAttribute("underlier")
@Accessor(GETTER)
@Required
@RuneAttribute("underlier")
public Underlier.UnderlierBuilder getUnderlier()

Description copied from interface: SettlementPayout

The underlying financial product that will be physically or cash settled, which can be of any type, eg an asset such as cash or a security, or the cash settlement of an index rate.

Specified by:

getUnderlier in interface SettlementPayout

Specified by:

getUnderlier in interface SettlementPayout.SettlementPayoutBuilder

getOrCreateUnderlier

public Underlier.UnderlierBuilder getOrCreateUnderlier()

Specified by:

getOrCreateUnderlier in interface SettlementPayout.SettlementPayoutBuilder

getDeliveryTerm

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

Description copied from interface: SettlementPayout

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 SettlementPayout

getDelivery

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

Description copied from interface: SettlementPayout

Contains the information relative to the delivery of the asset.

Specified by:

getDelivery in interface SettlementPayout

Specified by:

getDelivery in interface SettlementPayout.SettlementPayoutBuilder

getOrCreateDelivery

public AssetDeliveryInformation.AssetDeliveryInformationBuilder getOrCreateDelivery()

Specified by:

getOrCreateDelivery in interface SettlementPayout.SettlementPayoutBuilder

getSchedule

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

Description copied from interface: SettlementPayout

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 SettlementPayout

Specified by:

getSchedule in interface SettlementPayout.SettlementPayoutBuilder

getOrCreateSchedule

public CalculationSchedule.CalculationScheduleBuilder getOrCreateSchedule()

Specified by:

getOrCreateSchedule in interface SettlementPayout.SettlementPayoutBuilder

setPayerReceiver

@RosettaAttribute("payerReceiver")
@Accessor(SETTER)
@Required
@RuneAttribute("payerReceiver")
public SettlementPayout.SettlementPayoutBuilder setPayerReceiver(PayerReceiver _payerReceiver)

Specified by:

setPayerReceiver in interface PayoutBase.PayoutBaseBuilder

Specified by:

setPayerReceiver in interface SettlementPayout.SettlementPayoutBuilder

Overrides:

setPayerReceiver in class PayoutBase.PayoutBaseBuilderImpl

setPriceQuantity

@RosettaAttribute("priceQuantity")
@Accessor(SETTER)
@RuneAttribute("priceQuantity")
public SettlementPayout.SettlementPayoutBuilder setPriceQuantity(ResolvablePriceQuantity _priceQuantity)

Specified by:

setPriceQuantity in interface PayoutBase.PayoutBaseBuilder

Specified by:

setPriceQuantity in interface SettlementPayout.SettlementPayoutBuilder

Overrides:

setPriceQuantity in class PayoutBase.PayoutBaseBuilderImpl

setPrincipalPayment

@RosettaAttribute("principalPayment")
@Accessor(SETTER)
@RuneAttribute("principalPayment")
public SettlementPayout.SettlementPayoutBuilder setPrincipalPayment(PrincipalPayments _principalPayment)

Specified by:

setPrincipalPayment in interface PayoutBase.PayoutBaseBuilder

Specified by:

setPrincipalPayment in interface SettlementPayout.SettlementPayoutBuilder

Overrides:

setPrincipalPayment in class PayoutBase.PayoutBaseBuilderImpl

setSettlementTerms

@RosettaAttribute("settlementTerms")
@Accessor(SETTER)
@RuneAttribute("settlementTerms")
public SettlementPayout.SettlementPayoutBuilder setSettlementTerms(SettlementTerms _settlementTerms)

Specified by:

setSettlementTerms in interface PayoutBase.PayoutBaseBuilder

Specified by:

setSettlementTerms in interface SettlementPayout.SettlementPayoutBuilder

Overrides:

setSettlementTerms in class PayoutBase.PayoutBaseBuilderImpl

setUnderlier

@RosettaAttribute("underlier")
@Accessor(SETTER)
@Required
@RuneAttribute("underlier")
public SettlementPayout.SettlementPayoutBuilder setUnderlier(Underlier _underlier)

Specified by:

setUnderlier in interface SettlementPayout.SettlementPayoutBuilder

setDeliveryTerm

@RosettaAttribute("deliveryTerm")
@Accessor(SETTER)
@RuneAttribute("deliveryTerm")
public SettlementPayout.SettlementPayoutBuilder setDeliveryTerm(String _deliveryTerm)

Specified by:

setDeliveryTerm in interface SettlementPayout.SettlementPayoutBuilder

setDelivery

@RosettaAttribute("delivery")
@Accessor(SETTER)
@RuneAttribute("delivery")
public SettlementPayout.SettlementPayoutBuilder setDelivery(AssetDeliveryInformation _delivery)

Specified by:

setDelivery in interface SettlementPayout.SettlementPayoutBuilder

setSchedule

@RosettaAttribute("schedule")
@Accessor(SETTER)
@RuneAttribute("schedule")
public SettlementPayout.SettlementPayoutBuilder setSchedule(CalculationSchedule _schedule)

Specified by:

setSchedule in interface SettlementPayout.SettlementPayoutBuilder

build

public SettlementPayout build()

Description copied from interface: PayoutBase

Build Methods

Specified by:

build in interface PayoutBase

Specified by:

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

Specified by:

build in interface SettlementPayout

Overrides:

build in class PayoutBase.PayoutBaseBuilderImpl

toBuilder

public SettlementPayout.SettlementPayoutBuilder toBuilder()

Specified by:

toBuilder in interface PayoutBase

Specified by:

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

Specified by:

toBuilder in interface SettlementPayout

Overrides:

toBuilder in class PayoutBase.PayoutBaseBuilderImpl

prune

public SettlementPayout.SettlementPayoutBuilder prune()

Specified by:

prune in interface PayoutBase.PayoutBaseBuilder

Specified by:

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

Specified by:

prune in interface SettlementPayout.SettlementPayoutBuilder

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 SettlementPayout.SettlementPayoutBuilder 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