Package net.finmath.smartcontract.product.xml

Class SingleUnderlyer

java.lang.Object

net.finmath.smartcontract.product.xml.SingleUnderlyer

public class SingleUnderlyer
extends Object

A type describing a single underlyer

Java class for SingleUnderlyer complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="SingleUnderlyer">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{http://www.fpml.org/FpML-5/confirmation}underlyingAsset"/>
         <element name="openUnits" type="{http://www.w3.org/2001/XMLSchema}decimal" minOccurs="0"/>
         <element name="dividendPayout" type="{http://www.fpml.org/FpML-5/confirmation}DividendPayout" minOccurs="0"/>
         <element name="couponPayment" type="{http://www.fpml.org/FpML-5/confirmation}PendingPayment" minOccurs="0"/>
         <element name="averageDailyTradingVolume" type="{http://www.fpml.org/FpML-5/confirmation}AverageDailyTradingVolumeLimit" minOccurs="0"/>
         <element name="depositoryReceipt" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected AverageDailyTradingVolumeLimit	averageDailyTradingVolume
protected PendingPayment	couponPayment
protected Boolean	depositoryReceipt
protected DividendPayout	dividendPayout
protected BigDecimal	openUnits
protected jakarta.xml.bind.JAXBElement<? extends Asset>	underlyingAsset

Constructor Summary

Constructors

Constructor	Description
SingleUnderlyer()

Method Summary

Modifier and Type	Method	Description
AverageDailyTradingVolumeLimit	getAverageDailyTradingVolume()	Gets the value of the averageDailyTradingVolume property.
PendingPayment	getCouponPayment()	Gets the value of the couponPayment property.
DividendPayout	getDividendPayout()	Gets the value of the dividendPayout property.
BigDecimal	getOpenUnits()	Gets the value of the openUnits property.
jakarta.xml.bind.JAXBElement<? extends Asset>	getUnderlyingAsset()	Gets the value of the underlyingAsset property.
Boolean	isDepositoryReceipt()	Gets the value of the depositoryReceipt property.
void	setAverageDailyTradingVolume(AverageDailyTradingVolumeLimit value)	Sets the value of the averageDailyTradingVolume property.
void	setCouponPayment(PendingPayment value)	Sets the value of the couponPayment property.
void	setDepositoryReceipt(Boolean value)	Sets the value of the depositoryReceipt property.
void	setDividendPayout(DividendPayout value)	Sets the value of the dividendPayout property.
void	setOpenUnits(BigDecimal value)	Sets the value of the openUnits property.
void	setUnderlyingAsset(jakarta.xml.bind.JAXBElement<? extends Asset> value)	Sets the value of the underlyingAsset property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

underlyingAsset

protected jakarta.xml.bind.JAXBElement<? extends Asset> underlyingAsset

openUnits

protected BigDecimal openUnits

dividendPayout

protected DividendPayout dividendPayout

couponPayment

protected PendingPayment couponPayment

averageDailyTradingVolume

protected AverageDailyTradingVolumeLimit averageDailyTradingVolume

depositoryReceipt

protected Boolean depositoryReceipt

Constructor Details

SingleUnderlyer

public SingleUnderlyer()

Method Details

getUnderlyingAsset

public jakarta.xml.bind.JAXBElement<? extends Asset> getUnderlyingAsset()

Gets the value of the underlyingAsset property.

Returns:

possible object is JAXBElement<Mortgage> JAXBElement<MutualFund> JAXBElement<ConvertibleBond> JAXBElement<ExchangeTradedOption> JAXBElement<Commodity> JAXBElement<Basket> JAXBElement<Future> JAXBElement<EquityAsset> JAXBElement<Cash> JAXBElement<Loan> JAXBElement<Bond> JAXBElement<ExchangeTradedFund> JAXBElement<Index> JAXBElement<Asset>

setUnderlyingAsset

public void setUnderlyingAsset(jakarta.xml.bind.JAXBElement<? extends Asset> value)

Sets the value of the underlyingAsset property.

Parameters:

value - allowed object is JAXBElement<Mortgage> JAXBElement<MutualFund> JAXBElement<ConvertibleBond> JAXBElement<ExchangeTradedOption> JAXBElement<Commodity> JAXBElement<Basket> JAXBElement<Future> JAXBElement<EquityAsset> JAXBElement<Cash> JAXBElement<Loan> JAXBElement<Bond> JAXBElement<ExchangeTradedFund> JAXBElement<Index> JAXBElement<Asset>

getOpenUnits

public BigDecimal getOpenUnits()

Gets the value of the openUnits property.

Returns:

possible object is BigDecimal

setOpenUnits

public void setOpenUnits(BigDecimal value)

Sets the value of the openUnits property.

Parameters:

value - allowed object is BigDecimal

getDividendPayout

public DividendPayout getDividendPayout()

Gets the value of the dividendPayout property.

Returns:

possible object is DividendPayout

setDividendPayout

public void setDividendPayout(DividendPayout value)

Sets the value of the dividendPayout property.

Parameters:

value - allowed object is DividendPayout

getCouponPayment

public PendingPayment getCouponPayment()

Gets the value of the couponPayment property.

Returns:

possible object is PendingPayment

setCouponPayment

public void setCouponPayment(PendingPayment value)

Sets the value of the couponPayment property.

Parameters:

value - allowed object is PendingPayment

getAverageDailyTradingVolume

public AverageDailyTradingVolumeLimit getAverageDailyTradingVolume()

Gets the value of the averageDailyTradingVolume property.

Returns:

possible object is AverageDailyTradingVolumeLimit

setAverageDailyTradingVolume

public void setAverageDailyTradingVolume(AverageDailyTradingVolumeLimit value)

Sets the value of the averageDailyTradingVolume property.

Parameters:

value - allowed object is AverageDailyTradingVolumeLimit

isDepositoryReceipt

public Boolean isDepositoryReceipt()

Gets the value of the depositoryReceipt property.

Returns:

possible object is Boolean

setDepositoryReceipt

public void setDepositoryReceipt(Boolean value)

Sets the value of the depositoryReceipt property.

Parameters:

value - allowed object is Boolean