Package net.finmath.smartcontract.product.xml

Class Facility

java.lang.Object

net.finmath.smartcontract.product.xml.Asset

net.finmath.smartcontract.product.xml.IdentifiedAsset

net.finmath.smartcontract.product.xml.FacilityIdentifier

net.finmath.smartcontract.product.xml.FacilitySummary

net.finmath.smartcontract.product.xml.Facility

Direct Known Subclasses:

DelayedDraw, LetterOfCreditFacility, Revolver, TermLoan

public abstract class Facility
extends FacilitySummary

An abstract type defining a facility baseline structure.

Java class for Facility complex type.

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

 <complexType name="Facility">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}FacilitySummary">
       <sequence>
         <element name="governingLaw" type="{http://www.fpml.org/FpML-5/confirmation}GoverningLaw" minOccurs="0"/>
         <group ref="{http://www.fpml.org/FpML-5/confirmation}FacilityFeatures.model"/>
         <group ref="{http://www.fpml.org/FpML-5/confirmation}FacilityOptionsFeesAndRates.model"/>
         <element name="multiCurrency" type="{http://www.fpml.org/FpML-5/confirmation}MultiCurrency" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected List<AccruingFeeOption>	accruingFeeOption
protected AccruingPikOption	accruingPikOption
protected PeriodRate	defaultRate
protected List<FacilityFeature>	feature
protected List<AccrualOptionBase>	fixedRateOptionOrFloatingRateOptionOrLcOption
protected GoverningLaw	governingLaw
protected Lien	lien
protected PeriodRate	mandatoryCostRate
protected MultiCurrency	multiCurrency
protected PeriodRate	penaltyRate
protected CreditSeniority	seniority

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

agentPartyReference, borrowerPartyReference, coBorrowerPartyReference, commitmentSchedule, currentCommitment, dealFxRate, expiryDate, guarantorPartyReference, lcIssuingBankPartyReference, maturityDate, originalCommitment, startDate

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

description, instrumentId

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

id

Constructor Summary

Constructors

Constructor	Description
Facility()

Method Summary

Modifier and Type	Method	Description
List<AccruingFeeOption>	getAccruingFeeOption()	Gets the value of the accruingFeeOption property.
AccruingPikOption	getAccruingPikOption()	Gets the value of the accruingPikOption property.
PeriodRate	getDefaultRate()	Gets the value of the defaultRate property.
List<FacilityFeature>	getFeature()	Gets the value of the feature property.
List<AccrualOptionBase>	getFixedRateOptionOrFloatingRateOptionOrLcOption()	Gets the value of the fixedRateOptionOrFloatingRateOptionOrLcOption property.
GoverningLaw	getGoverningLaw()	Gets the value of the governingLaw property.
Lien	getLien()	Gets the value of the lien property.
PeriodRate	getMandatoryCostRate()	Gets the value of the mandatoryCostRate property.
MultiCurrency	getMultiCurrency()	Gets the value of the multiCurrency property.
PeriodRate	getPenaltyRate()	Gets the value of the penaltyRate property.
CreditSeniority	getSeniority()	Gets the value of the seniority property.
void	setAccruingPikOption(AccruingPikOption value)	Sets the value of the accruingPikOption property.
void	setDefaultRate(PeriodRate value)	Sets the value of the defaultRate property.
void	setGoverningLaw(GoverningLaw value)	Sets the value of the governingLaw property.
void	setLien(Lien value)	Sets the value of the lien property.
void	setMandatoryCostRate(PeriodRate value)	Sets the value of the mandatoryCostRate property.
void	setMultiCurrency(MultiCurrency value)	Sets the value of the multiCurrency property.
void	setPenaltyRate(PeriodRate value)	Sets the value of the penaltyRate property.
void	setSeniority(CreditSeniority value)	Sets the value of the seniority property.

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

getAgentPartyReference, getBorrowerPartyReference, getCoBorrowerPartyReference, getCommitmentSchedule, getCurrentCommitment, getDealFxRate, getExpiryDate, getGuarantorPartyReference, getLcIssuingBankPartyReference, getMaturityDate, getOriginalCommitment, getStartDate, setAgentPartyReference, setBorrowerPartyReference, setCommitmentSchedule, setCurrentCommitment, setDealFxRate, setExpiryDate, setMaturityDate, setOriginalCommitment, setStartDate

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

getDescription, getInstrumentId, setDescription

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

getId, setId

Methods inherited from class java.lang.Object

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

Field Details

governingLaw

protected GoverningLaw governingLaw

feature

protected List<FacilityFeature> feature

lien

protected Lien lien

seniority

protected CreditSeniority seniority

fixedRateOptionOrFloatingRateOptionOrLcOption

protected List<AccrualOptionBase> fixedRateOptionOrFloatingRateOptionOrLcOption

accruingPikOption

protected AccruingPikOption accruingPikOption

accruingFeeOption

protected List<AccruingFeeOption> accruingFeeOption

defaultRate

protected PeriodRate defaultRate

mandatoryCostRate

protected PeriodRate mandatoryCostRate

penaltyRate

protected PeriodRate penaltyRate

multiCurrency

protected MultiCurrency multiCurrency

Constructor Details

Facility

public Facility()

Method Details

getGoverningLaw

public GoverningLaw getGoverningLaw()

Gets the value of the governingLaw property.

Returns:

possible object is GoverningLaw

setGoverningLaw

public void setGoverningLaw(GoverningLaw value)

Sets the value of the governingLaw property.

Parameters:

value - allowed object is GoverningLaw

getFeature

public List<FacilityFeature> getFeature()

Gets the value of the feature property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the feature property.

For example, to add a new item, do as follows:

    getFeature().add(newItem);
 

Objects of the following type(s) are allowed in the list FacilityFeature

getLien

public Lien getLien()

Gets the value of the lien property.

Returns:

possible object is Lien

setLien

public void setLien(Lien value)

Sets the value of the lien property.

Parameters:

value - allowed object is Lien

getSeniority

public CreditSeniority getSeniority()

Gets the value of the seniority property.

Returns:

possible object is CreditSeniority

setSeniority

public void setSeniority(CreditSeniority value)

Sets the value of the seniority property.

Parameters:

value - allowed object is CreditSeniority

getFixedRateOptionOrFloatingRateOptionOrLcOption

public List<AccrualOptionBase> getFixedRateOptionOrFloatingRateOptionOrLcOption()

Gets the value of the fixedRateOptionOrFloatingRateOptionOrLcOption property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the fixedRateOptionOrFloatingRateOptionOrLcOption property.

For example, to add a new item, do as follows:

    getFixedRateOptionOrFloatingRateOptionOrLcOption().add(newItem);
 

Objects of the following type(s) are allowed in the list FixedRateOption FloatingRateOption LcOption

getAccruingPikOption

public AccruingPikOption getAccruingPikOption()

Gets the value of the accruingPikOption property.

Returns:

possible object is AccruingPikOption

setAccruingPikOption

public void setAccruingPikOption(AccruingPikOption value)

Sets the value of the accruingPikOption property.

Parameters:

value - allowed object is AccruingPikOption

getAccruingFeeOption

public List<AccruingFeeOption> getAccruingFeeOption()

Gets the value of the accruingFeeOption property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the accruingFeeOption property.

For example, to add a new item, do as follows:

    getAccruingFeeOption().add(newItem);
 

Objects of the following type(s) are allowed in the list AccruingFeeOption

getDefaultRate

public PeriodRate getDefaultRate()

Gets the value of the defaultRate property.

Returns:

possible object is PeriodRate

setDefaultRate

public void setDefaultRate(PeriodRate value)

Sets the value of the defaultRate property.

Parameters:

value - allowed object is PeriodRate

getMandatoryCostRate

public PeriodRate getMandatoryCostRate()

Gets the value of the mandatoryCostRate property.

Returns:

possible object is PeriodRate

setMandatoryCostRate

public void setMandatoryCostRate(PeriodRate value)

Sets the value of the mandatoryCostRate property.

Parameters:

value - allowed object is PeriodRate

getPenaltyRate

public PeriodRate getPenaltyRate()

Gets the value of the penaltyRate property.

Returns:

possible object is PeriodRate

setPenaltyRate

public void setPenaltyRate(PeriodRate value)

Sets the value of the penaltyRate property.

Parameters:

value - allowed object is PeriodRate

getMultiCurrency

public MultiCurrency getMultiCurrency()

Gets the value of the multiCurrency property.

Returns:

possible object is MultiCurrency

setMultiCurrency

public void setMultiCurrency(MultiCurrency value)

Sets the value of the multiCurrency property.

Parameters:

value - allowed object is MultiCurrency