Package net.finmath.smartcontract.product.xml

Class Premium

java.lang.Object

net.finmath.smartcontract.product.xml.PaymentBase

net.finmath.smartcontract.product.xml.SimplePayment

net.finmath.smartcontract.product.xml.Premium

public class Premium
extends SimplePayment

A type for defining a premium.

Java class for Premium complex type.

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

 <complexType name="Premium">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}SimplePayment">
       <sequence>
         <group ref="{http://www.fpml.org/FpML-5/confirmation}Premium.model" minOccurs="0"/>
         <group ref="{http://www.fpml.org/FpML-5/confirmation}PaymentDiscounting.model" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected BigDecimal	discountFactor
protected BigDecimal	percentageOfNotional
protected PremiumTypeEnum	premiumType
protected Money	presentValueAmount
protected Money	pricePerOption

Fields inherited from class net.finmath.smartcontract.product.xml.SimplePayment

payerAccountReference, payerPartyReference, paymentAmount, paymentDate, receiverAccountReference, receiverPartyReference

Fields inherited from class net.finmath.smartcontract.product.xml.PaymentBase

id

Constructor Summary

Constructors

Constructor	Description
Premium()

Method Summary

Modifier and Type	Method	Description
BigDecimal	getDiscountFactor()	Gets the value of the discountFactor property.
BigDecimal	getPercentageOfNotional()	Gets the value of the percentageOfNotional property.
PremiumTypeEnum	getPremiumType()	Gets the value of the premiumType property.
Money	getPresentValueAmount()	Gets the value of the presentValueAmount property.
Money	getPricePerOption()	Gets the value of the pricePerOption property.
void	setDiscountFactor(BigDecimal value)	Sets the value of the discountFactor property.
void	setPercentageOfNotional(BigDecimal value)	Sets the value of the percentageOfNotional property.
void	setPremiumType(PremiumTypeEnum value)	Sets the value of the premiumType property.
void	setPresentValueAmount(Money value)	Sets the value of the presentValueAmount property.
void	setPricePerOption(Money value)	Sets the value of the pricePerOption property.

Methods inherited from class net.finmath.smartcontract.product.xml.SimplePayment

getPayerAccountReference, getPayerPartyReference, getPaymentAmount, getPaymentDate, getReceiverAccountReference, getReceiverPartyReference, setPayerAccountReference, setPayerPartyReference, setPaymentAmount, setPaymentDate, setReceiverAccountReference, setReceiverPartyReference

Methods inherited from class net.finmath.smartcontract.product.xml.PaymentBase

getId, setId

Methods inherited from class java.lang.Object

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

Field Details

premiumType

protected PremiumTypeEnum premiumType

pricePerOption

protected Money pricePerOption

percentageOfNotional

protected BigDecimal percentageOfNotional

discountFactor

protected BigDecimal discountFactor

presentValueAmount

protected Money presentValueAmount

Constructor Details

Premium

public Premium()

Method Details

getPremiumType

public PremiumTypeEnum getPremiumType()

Gets the value of the premiumType property.

Returns:

possible object is PremiumTypeEnum

setPremiumType

public void setPremiumType(PremiumTypeEnum value)

Sets the value of the premiumType property.

Parameters:

value - allowed object is PremiumTypeEnum

getPricePerOption

public Money getPricePerOption()

Gets the value of the pricePerOption property.

Returns:

possible object is Money

setPricePerOption

public void setPricePerOption(Money value)

Sets the value of the pricePerOption property.

Parameters:

value - allowed object is Money

getPercentageOfNotional

public BigDecimal getPercentageOfNotional()

Gets the value of the percentageOfNotional property.

Returns:

possible object is BigDecimal

setPercentageOfNotional

public void setPercentageOfNotional(BigDecimal value)

Sets the value of the percentageOfNotional property.

Parameters:

value - allowed object is BigDecimal

getDiscountFactor

public BigDecimal getDiscountFactor()

Gets the value of the discountFactor property.

Returns:

possible object is BigDecimal

setDiscountFactor

public void setDiscountFactor(BigDecimal value)

Sets the value of the discountFactor property.

Parameters:

value - allowed object is BigDecimal

getPresentValueAmount

public Money getPresentValueAmount()

Gets the value of the presentValueAmount property.

Returns:

possible object is Money

setPresentValueAmount

public void setPresentValueAmount(Money value)

Sets the value of the presentValueAmount property.

Parameters:

value - allowed object is Money