Package net.finmath.smartcontract.product.xml

Class EquitySwapTransactionSupplement

java.lang.Object

net.finmath.smartcontract.product.xml.Product

net.finmath.smartcontract.product.xml.ReturnSwapBase

net.finmath.smartcontract.product.xml.EquitySwapTransactionSupplement

public class EquitySwapTransactionSupplement
extends ReturnSwapBase

A type for defining Equity Swap Transaction Supplement

Java class for EquitySwapTransactionSupplement complex type.

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

 <complexType name="EquitySwapTransactionSupplement">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}ReturnSwapBase">
       <sequence>
         <group ref="{http://www.fpml.org/FpML-5/confirmation}MutualOrOptionalEarlyTermination.model" minOccurs="0"/>
         <group ref="{http://www.fpml.org/FpML-5/confirmation}EquityUnderlyerProvisions.model" minOccurs="0"/>
         <element name="extraordinaryEvents" type="{http://www.fpml.org/FpML-5/confirmation}ExtraordinaryEvents" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected FeeElectionEnum	breakFeeElection
protected BigDecimal	breakFeeRate
protected Boolean	breakFundingRecovery
protected Boolean	componentSecurityIndexAnnexFallback
protected ExtraordinaryEvents	extraordinaryEvents
protected CountryCode	localJurisdiction
protected Boolean	multipleExchangeIndexAnnexFallback
protected Boolean	mutualEarlyTermination
protected Boolean	optionalEarlyTermination
protected EarlyTerminationDateEnum	optionalEarlyTerminationDate
protected PartyReference	optionalEarlyTerminationElectingPartyReference
protected CountryCode	relevantJurisdiction

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

additionalPayment, buyerAccountReference, buyerPartyReference, principalExchangeFeatures, returnSwapLeg, sellerAccountReference, sellerPartyReference

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

assetClass, id, primaryAssetClass, productId, productType, secondaryAssetClass

Constructor Summary

Constructors

Constructor	Description
EquitySwapTransactionSupplement()

Method Summary

Modifier and Type	Method	Description
FeeElectionEnum	getBreakFeeElection()	Gets the value of the breakFeeElection property.
BigDecimal	getBreakFeeRate()	Gets the value of the breakFeeRate property.
ExtraordinaryEvents	getExtraordinaryEvents()	Gets the value of the extraordinaryEvents property.
CountryCode	getLocalJurisdiction()	Gets the value of the localJurisdiction property.
EarlyTerminationDateEnum	getOptionalEarlyTerminationDate()	Gets the value of the optionalEarlyTerminationDate property.
PartyReference	getOptionalEarlyTerminationElectingPartyReference()	Gets the value of the optionalEarlyTerminationElectingPartyReference property.
CountryCode	getRelevantJurisdiction()	Gets the value of the relevantJurisdiction property.
Boolean	isBreakFundingRecovery()	Gets the value of the breakFundingRecovery property.
Boolean	isComponentSecurityIndexAnnexFallback()	Gets the value of the componentSecurityIndexAnnexFallback property.
Boolean	isMultipleExchangeIndexAnnexFallback()	Gets the value of the multipleExchangeIndexAnnexFallback property.
Boolean	isMutualEarlyTermination()	Gets the value of the mutualEarlyTermination property.
Boolean	isOptionalEarlyTermination()	Gets the value of the optionalEarlyTermination property.
void	setBreakFeeElection(FeeElectionEnum value)	Sets the value of the breakFeeElection property.
void	setBreakFeeRate(BigDecimal value)	Sets the value of the breakFeeRate property.
void	setBreakFundingRecovery(Boolean value)	Sets the value of the breakFundingRecovery property.
void	setComponentSecurityIndexAnnexFallback(Boolean value)	Sets the value of the componentSecurityIndexAnnexFallback property.
void	setExtraordinaryEvents(ExtraordinaryEvents value)	Sets the value of the extraordinaryEvents property.
void	setLocalJurisdiction(CountryCode value)	Sets the value of the localJurisdiction property.
void	setMultipleExchangeIndexAnnexFallback(Boolean value)	Sets the value of the multipleExchangeIndexAnnexFallback property.
void	setMutualEarlyTermination(Boolean value)	Sets the value of the mutualEarlyTermination property.
void	setOptionalEarlyTermination(Boolean value)	Sets the value of the optionalEarlyTermination property.
void	setOptionalEarlyTerminationDate(EarlyTerminationDateEnum value)	Sets the value of the optionalEarlyTerminationDate property.
void	setOptionalEarlyTerminationElectingPartyReference(PartyReference value)	Sets the value of the optionalEarlyTerminationElectingPartyReference property.
void	setRelevantJurisdiction(CountryCode value)	Sets the value of the relevantJurisdiction property.

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

getAdditionalPayment, getBuyerAccountReference, getBuyerPartyReference, getPrincipalExchangeFeatures, getReturnSwapLeg, getSellerAccountReference, getSellerPartyReference, setBuyerAccountReference, setBuyerPartyReference, setPrincipalExchangeFeatures, setSellerAccountReference, setSellerPartyReference

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

getAssetClass, getId, getPrimaryAssetClass, getProductId, getProductType, getSecondaryAssetClass, setId, setPrimaryAssetClass

Methods inherited from class java.lang.Object

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

Field Details

mutualEarlyTermination

protected Boolean mutualEarlyTermination

optionalEarlyTermination

protected Boolean optionalEarlyTermination

optionalEarlyTerminationDate

protected EarlyTerminationDateEnum optionalEarlyTerminationDate

optionalEarlyTerminationElectingPartyReference

protected PartyReference optionalEarlyTerminationElectingPartyReference

breakFundingRecovery

protected Boolean breakFundingRecovery

breakFeeElection

protected FeeElectionEnum breakFeeElection

breakFeeRate

protected BigDecimal breakFeeRate

multipleExchangeIndexAnnexFallback

protected Boolean multipleExchangeIndexAnnexFallback

componentSecurityIndexAnnexFallback

protected Boolean componentSecurityIndexAnnexFallback

localJurisdiction

protected CountryCode localJurisdiction

relevantJurisdiction

protected CountryCode relevantJurisdiction

extraordinaryEvents

protected ExtraordinaryEvents extraordinaryEvents

Constructor Details

EquitySwapTransactionSupplement

public EquitySwapTransactionSupplement()

Method Details

isMutualEarlyTermination

public Boolean isMutualEarlyTermination()

Gets the value of the mutualEarlyTermination property.

Returns:

possible object is Boolean

setMutualEarlyTermination

public void setMutualEarlyTermination(Boolean value)

Sets the value of the mutualEarlyTermination property.

Parameters:

value - allowed object is Boolean

isOptionalEarlyTermination

public Boolean isOptionalEarlyTermination()

Gets the value of the optionalEarlyTermination property.

Returns:

possible object is Boolean

setOptionalEarlyTermination

public void setOptionalEarlyTermination(Boolean value)

Sets the value of the optionalEarlyTermination property.

Parameters:

value - allowed object is Boolean

getOptionalEarlyTerminationDate

public EarlyTerminationDateEnum getOptionalEarlyTerminationDate()

Gets the value of the optionalEarlyTerminationDate property.

Returns:

possible object is EarlyTerminationDateEnum

setOptionalEarlyTerminationDate

public void setOptionalEarlyTerminationDate(EarlyTerminationDateEnum value)

Sets the value of the optionalEarlyTerminationDate property.

Parameters:

value - allowed object is EarlyTerminationDateEnum

getOptionalEarlyTerminationElectingPartyReference

public PartyReference getOptionalEarlyTerminationElectingPartyReference()

Gets the value of the optionalEarlyTerminationElectingPartyReference property.

Returns:

possible object is PartyReference

setOptionalEarlyTerminationElectingPartyReference

public void setOptionalEarlyTerminationElectingPartyReference(PartyReference value)

Sets the value of the optionalEarlyTerminationElectingPartyReference property.

Parameters:

value - allowed object is PartyReference

isBreakFundingRecovery

public Boolean isBreakFundingRecovery()

Gets the value of the breakFundingRecovery property.

Returns:

possible object is Boolean

setBreakFundingRecovery

public void setBreakFundingRecovery(Boolean value)

Sets the value of the breakFundingRecovery property.

Parameters:

value - allowed object is Boolean

getBreakFeeElection

public FeeElectionEnum getBreakFeeElection()

Gets the value of the breakFeeElection property.

Returns:

possible object is FeeElectionEnum

setBreakFeeElection

public void setBreakFeeElection(FeeElectionEnum value)

Sets the value of the breakFeeElection property.

Parameters:

value - allowed object is FeeElectionEnum

getBreakFeeRate

public BigDecimal getBreakFeeRate()

Gets the value of the breakFeeRate property.

Returns:

possible object is BigDecimal

setBreakFeeRate

public void setBreakFeeRate(BigDecimal value)

Sets the value of the breakFeeRate property.

Parameters:

value - allowed object is BigDecimal

isMultipleExchangeIndexAnnexFallback

public Boolean isMultipleExchangeIndexAnnexFallback()

Gets the value of the multipleExchangeIndexAnnexFallback property.

Returns:

possible object is Boolean

setMultipleExchangeIndexAnnexFallback

public void setMultipleExchangeIndexAnnexFallback(Boolean value)

Sets the value of the multipleExchangeIndexAnnexFallback property.

Parameters:

value - allowed object is Boolean

isComponentSecurityIndexAnnexFallback

public Boolean isComponentSecurityIndexAnnexFallback()

Gets the value of the componentSecurityIndexAnnexFallback property.

Returns:

possible object is Boolean

setComponentSecurityIndexAnnexFallback

public void setComponentSecurityIndexAnnexFallback(Boolean value)

Sets the value of the componentSecurityIndexAnnexFallback property.

Parameters:

value - allowed object is Boolean

getLocalJurisdiction

public CountryCode getLocalJurisdiction()

Gets the value of the localJurisdiction property.

Returns:

possible object is CountryCode

setLocalJurisdiction

public void setLocalJurisdiction(CountryCode value)

Sets the value of the localJurisdiction property.

Parameters:

value - allowed object is CountryCode

getRelevantJurisdiction

public CountryCode getRelevantJurisdiction()

Gets the value of the relevantJurisdiction property.

Returns:

possible object is CountryCode

setRelevantJurisdiction

public void setRelevantJurisdiction(CountryCode value)

Sets the value of the relevantJurisdiction property.

Parameters:

value - allowed object is CountryCode

getExtraordinaryEvents

public ExtraordinaryEvents getExtraordinaryEvents()

Gets the value of the extraordinaryEvents property.

Returns:

possible object is ExtraordinaryEvents

setExtraordinaryEvents

public void setExtraordinaryEvents(ExtraordinaryEvents value)

Sets the value of the extraordinaryEvents property.

Parameters:

value - allowed object is ExtraordinaryEvents