Package net.finmath.smartcontract.product.xml

Class CashPayable

java.lang.Object

net.finmath.smartcontract.product.xml.CashPayable

public class CashPayable
extends Object

This structure represents payable cash, together with reference to any withholding tax being applied. This is used as a generic cash flow container across all loan business events (within the event header).

Java class for CashPayable complex type.

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

 <complexType name="CashPayable">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <group ref="{http://www.fpml.org/FpML-5/confirmation}PayerReceiver.model"/>
         <element name="netAmount" type="{http://www.fpml.org/FpML-5/confirmation}NonNegativeMoney"/>
         <element name="taxWithholding" type="{http://www.fpml.org/FpML-5/confirmation}TaxWithholding" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected NonNegativeMoney	netAmount
protected AccountReference	payerAccountReference
protected PartyReference	payerPartyReference
protected AccountReference	receiverAccountReference
protected PartyReference	receiverPartyReference
protected List<TaxWithholding>	taxWithholding

Constructor Summary

Constructors

Constructor	Description
CashPayable()

Method Summary

Modifier and Type	Method	Description
NonNegativeMoney	getNetAmount()	Gets the value of the netAmount property.
AccountReference	getPayerAccountReference()	Gets the value of the payerAccountReference property.
PartyReference	getPayerPartyReference()	Gets the value of the payerPartyReference property.
AccountReference	getReceiverAccountReference()	Gets the value of the receiverAccountReference property.
PartyReference	getReceiverPartyReference()	Gets the value of the receiverPartyReference property.
List<TaxWithholding>	getTaxWithholding()	Gets the value of the taxWithholding property.
void	setNetAmount(NonNegativeMoney value)	Sets the value of the netAmount property.
void	setPayerAccountReference(AccountReference value)	Sets the value of the payerAccountReference property.
void	setPayerPartyReference(PartyReference value)	Sets the value of the payerPartyReference property.
void	setReceiverAccountReference(AccountReference value)	Sets the value of the receiverAccountReference property.
void	setReceiverPartyReference(PartyReference value)	Sets the value of the receiverPartyReference property.

Methods inherited from class java.lang.Object

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

Field Details

payerPartyReference

protected PartyReference payerPartyReference

payerAccountReference

protected AccountReference payerAccountReference

receiverPartyReference

protected PartyReference receiverPartyReference

receiverAccountReference

protected AccountReference receiverAccountReference

netAmount

protected NonNegativeMoney netAmount

taxWithholding

protected List<TaxWithholding> taxWithholding

Constructor Details

CashPayable

public CashPayable()

Method Details

getPayerPartyReference

public PartyReference getPayerPartyReference()

Gets the value of the payerPartyReference property.

Returns:

possible object is PartyReference

setPayerPartyReference

public void setPayerPartyReference(PartyReference value)

Sets the value of the payerPartyReference property.

Parameters:

value - allowed object is PartyReference

getPayerAccountReference

public AccountReference getPayerAccountReference()

Gets the value of the payerAccountReference property.

Returns:

possible object is AccountReference

setPayerAccountReference

public void setPayerAccountReference(AccountReference value)

Sets the value of the payerAccountReference property.

Parameters:

value - allowed object is AccountReference

getReceiverPartyReference

public PartyReference getReceiverPartyReference()

Gets the value of the receiverPartyReference property.

Returns:

possible object is PartyReference

setReceiverPartyReference

public void setReceiverPartyReference(PartyReference value)

Sets the value of the receiverPartyReference property.

Parameters:

value - allowed object is PartyReference

getReceiverAccountReference

public AccountReference getReceiverAccountReference()

Gets the value of the receiverAccountReference property.

Returns:

possible object is AccountReference

setReceiverAccountReference

public void setReceiverAccountReference(AccountReference value)

Sets the value of the receiverAccountReference property.

Parameters:

value - allowed object is AccountReference

getNetAmount

public NonNegativeMoney getNetAmount()

Gets the value of the netAmount property.

Returns:

possible object is NonNegativeMoney

setNetAmount

public void setNetAmount(NonNegativeMoney value)

Sets the value of the netAmount property.

Parameters:

value - allowed object is NonNegativeMoney

getTaxWithholding

public List<TaxWithholding> getTaxWithholding()

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

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

    getTaxWithholding().add(newItem);
 

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