Package net.finmath.smartcontract.product.xml

Class AccruingPikPayment

java.lang.Object

net.finmath.smartcontract.product.xml.AbstractEventRequireId

net.finmath.smartcontract.product.xml.LoanEvent

net.finmath.smartcontract.product.xml.FacilityEvent

net.finmath.smartcontract.product.xml.AccruingPikPayment

public class AccruingPikPayment
extends FacilityEvent

An event representing a payment to facilitate capitalization of interest on all outstanding contracts against a particular facility.

Java class for AccruingPikPayment complex type.

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

 <complexType name="AccruingPikPayment">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}FacilityEvent">
       <sequence>
         <sequence>
           <group ref="{http://www.fpml.org/FpML-5/confirmation}Period.model"/>
           <element name="amount" type="{http://www.fpml.org/FpML-5/confirmation}MoneyWithParticipantShare"/>
           <element name="accrualSchedule" type="{http://www.fpml.org/FpML-5/confirmation}AccrualPeriod" maxOccurs="unbounded" minOccurs="0"/>
         </sequence>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected List<AccrualPeriod>	accrualSchedule
protected MoneyWithParticipantShare	amount
protected XMLGregorianCalendar	endDate
protected XMLGregorianCalendar	startDate

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

facilityReference

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

agentPartyReference, borrowerPartyReference, businessEventGroupId, cashPayable, comment, effectiveDate, lenderPartyReference, previousInaccurateEventId

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

eventIdentifier

Constructor Summary

Constructors

Constructor	Description
AccruingPikPayment()

Method Summary

Modifier and Type	Method	Description
List<AccrualPeriod>	getAccrualSchedule()	Gets the value of the accrualSchedule property.
MoneyWithParticipantShare	getAmount()	Gets the value of the amount property.
XMLGregorianCalendar	getEndDate()	Gets the value of the endDate property.
XMLGregorianCalendar	getStartDate()	Gets the value of the startDate property.
void	setAmount(MoneyWithParticipantShare value)	Sets the value of the amount property.
void	setEndDate(XMLGregorianCalendar value)	Sets the value of the endDate property.
void	setStartDate(XMLGregorianCalendar value)	Sets the value of the startDate property.

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

getFacilityReference, setFacilityReference

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

getAgentPartyReference, getBorrowerPartyReference, getBusinessEventGroupId, getCashPayable, getComment, getEffectiveDate, getLenderPartyReference, getPreviousInaccurateEventId, setAgentPartyReference, setBorrowerPartyReference, setBusinessEventGroupId, setCashPayable, setComment, setEffectiveDate, setLenderPartyReference, setPreviousInaccurateEventId

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

getEventIdentifier

Methods inherited from class java.lang.Object

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

Field Details

startDate

protected XMLGregorianCalendar startDate

endDate

protected XMLGregorianCalendar endDate

amount

protected MoneyWithParticipantShare amount

accrualSchedule

protected List<AccrualPeriod> accrualSchedule

Constructor Details

AccruingPikPayment

public AccruingPikPayment()

Method Details

getStartDate

public XMLGregorianCalendar getStartDate()

Gets the value of the startDate property.

Returns:

possible object is XMLGregorianCalendar

setStartDate

public void setStartDate(XMLGregorianCalendar value)

Sets the value of the startDate property.

Parameters:

value - allowed object is XMLGregorianCalendar

getEndDate

public XMLGregorianCalendar getEndDate()

Gets the value of the endDate property.

Returns:

possible object is XMLGregorianCalendar

setEndDate

public void setEndDate(XMLGregorianCalendar value)

Sets the value of the endDate property.

Parameters:

value - allowed object is XMLGregorianCalendar

getAmount

public MoneyWithParticipantShare getAmount()

Gets the value of the amount property.

Returns:

possible object is MoneyWithParticipantShare

setAmount

public void setAmount(MoneyWithParticipantShare value)

Sets the value of the amount property.

Parameters:

value - allowed object is MoneyWithParticipantShare

getAccrualSchedule

public List<AccrualPeriod> getAccrualSchedule()

Gets the value of the accrualSchedule 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 accrualSchedule property.

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

    getAccrualSchedule().add(newItem);
 

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