Class Mortgage
java.lang.Object
net.finmath.smartcontract.product.xml.Asset
net.finmath.smartcontract.product.xml.IdentifiedAsset
net.finmath.smartcontract.product.xml.UnderlyingAsset
net.finmath.smartcontract.product.xml.Mortgage
A type describing a mortgage asset.
Java class for Mortgage complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="Mortgage">
<complexContent>
<extension base="{http://www.fpml.org/FpML-5/confirmation}UnderlyingAsset">
<sequence>
<choice minOccurs="0">
<element name="insurer" type="{http://www.fpml.org/FpML-5/confirmation}LegalEntity"/>
<element name="insurerReference" type="{http://www.fpml.org/FpML-5/confirmation}LegalEntityReference"/>
</choice>
<group ref="{http://www.fpml.org/FpML-5/confirmation}FixedIncomeSecurityContent.model"/>
<group ref="{http://www.fpml.org/FpML-5/confirmation}BondCalculation.model"/>
<element name="originalPrincipalAmount" type="{http://www.w3.org/2001/XMLSchema}decimal" minOccurs="0"/>
<element name="pool" type="{http://www.fpml.org/FpML-5/confirmation}AssetPool" minOccurs="0"/>
<element name="sector" type="{http://www.fpml.org/FpML-5/confirmation}MortgageSector" minOccurs="0"/>
<element name="tranche" type="{http://www.fpml.org/FpML-5/confirmation}Token" minOccurs="0"/>
</sequence>
</extension>
</complexContent>
</complexType>
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected BigDecimalprotected CouponTypeprotected DayCountFractionprotected LegalEntityprotected LegalEntityReferenceprotected Stringprotected PartyReferenceprotected XMLGregorianCalendarprotected BigDecimalprotected Periodprotected AssetPoolprotected MortgageSectorprotected CreditSeniorityprotected StringFields inherited from class net.finmath.smartcontract.product.xml.UnderlyingAsset
clearanceSystem, currency, definition, exchangeIdFields inherited from class net.finmath.smartcontract.product.xml.IdentifiedAsset
description, instrumentId -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the value of the couponRate property.Gets the value of the couponType property.Gets the value of the dayCountFraction property.Gets the value of the insurer property.Gets the value of the insurerReference property.Gets the value of the issuerName property.Gets the value of the issuerPartyReference property.Gets the value of the maturity property.Gets the value of the originalPrincipalAmount property.Gets the value of the paymentFrequency property.getPool()Gets the value of the pool property.Gets the value of the sector property.Gets the value of the seniority property.Gets the value of the tranche property.voidsetCouponRate(BigDecimal value) Sets the value of the couponRate property.voidsetCouponType(CouponType value) Sets the value of the couponType property.voidSets the value of the dayCountFraction property.voidsetInsurer(LegalEntity value) Sets the value of the insurer property.voidSets the value of the insurerReference property.voidsetIssuerName(String value) Sets the value of the issuerName property.voidSets the value of the issuerPartyReference property.voidsetMaturity(XMLGregorianCalendar value) Sets the value of the maturity property.voidSets the value of the originalPrincipalAmount property.voidsetPaymentFrequency(Period value) Sets the value of the paymentFrequency property.voidSets the value of the pool property.voidsetSector(MortgageSector value) Sets the value of the sector property.voidsetSeniority(CreditSeniority value) Sets the value of the seniority property.voidsetTranche(String value) Sets the value of the tranche property.Methods inherited from class net.finmath.smartcontract.product.xml.UnderlyingAsset
getClearanceSystem, getCurrency, getDefinition, getExchangeId, setClearanceSystem, setCurrency, setDefinition, setExchangeIdMethods inherited from class net.finmath.smartcontract.product.xml.IdentifiedAsset
getDescription, getInstrumentId, setDescription
-
Field Details
-
insurer
-
insurerReference
-
issuerName
-
issuerPartyReference
-
seniority
-
couponType
-
couponRate
-
maturity
-
paymentFrequency
-
dayCountFraction
-
originalPrincipalAmount
-
pool
-
sector
-
tranche
-
-
Constructor Details
-
Mortgage
public Mortgage()
-
-
Method Details
-
getInsurer
Gets the value of the insurer property.- Returns:
- possible object is
LegalEntity
-
setInsurer
Sets the value of the insurer property.- Parameters:
value- allowed object isLegalEntity
-
getInsurerReference
Gets the value of the insurerReference property.- Returns:
- possible object is
LegalEntityReference
-
setInsurerReference
Sets the value of the insurerReference property.- Parameters:
value- allowed object isLegalEntityReference
-
getIssuerName
-
setIssuerName
-
getIssuerPartyReference
Gets the value of the issuerPartyReference property.- Returns:
- possible object is
PartyReference
-
setIssuerPartyReference
Sets the value of the issuerPartyReference property.- Parameters:
value- allowed object isPartyReference
-
getSeniority
Gets the value of the seniority property.- Returns:
- possible object is
CreditSeniority
-
setSeniority
Sets the value of the seniority property.- Parameters:
value- allowed object isCreditSeniority
-
getCouponType
Gets the value of the couponType property.- Returns:
- possible object is
CouponType
-
setCouponType
Sets the value of the couponType property.- Parameters:
value- allowed object isCouponType
-
getCouponRate
Gets the value of the couponRate property.- Returns:
- possible object is
BigDecimal
-
setCouponRate
Sets the value of the couponRate property.- Parameters:
value- allowed object isBigDecimal
-
getMaturity
Gets the value of the maturity property.- Returns:
- possible object is
XMLGregorianCalendar
-
setMaturity
Sets the value of the maturity property.- Parameters:
value- allowed object isXMLGregorianCalendar
-
getPaymentFrequency
-
setPaymentFrequency
-
getDayCountFraction
Gets the value of the dayCountFraction property.- Returns:
- possible object is
DayCountFraction
-
setDayCountFraction
Sets the value of the dayCountFraction property.- Parameters:
value- allowed object isDayCountFraction
-
getOriginalPrincipalAmount
Gets the value of the originalPrincipalAmount property.- Returns:
- possible object is
BigDecimal
-
setOriginalPrincipalAmount
Sets the value of the originalPrincipalAmount property.- Parameters:
value- allowed object isBigDecimal
-
getPool
-
setPool
-
getSector
Gets the value of the sector property.- Returns:
- possible object is
MortgageSector
-
setSector
Sets the value of the sector property.- Parameters:
value- allowed object isMortgageSector
-
getTranche
-
setTranche
-