Package net.finmath.smartcontract.product.xml

Class SettlementInstruction

java.lang.Object

net.finmath.smartcontract.product.xml.SettlementInstruction

public class SettlementInstruction
extends Object

A type that models a complete instruction for settling a currency payment, including the settlement method to be used, the correspondent bank, any intermediary banks and the ultimate beneficary.

Java class for SettlementInstruction complex type.

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

 <complexType name="SettlementInstruction">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="settlementMethod" type="{http://www.fpml.org/FpML-5/confirmation}SettlementMethod" minOccurs="0"/>
         <element name="correspondentInformation" type="{http://www.fpml.org/FpML-5/confirmation}CorrespondentInformation" minOccurs="0"/>
         <element name="intermediaryInformation" type="{http://www.fpml.org/FpML-5/confirmation}IntermediaryInformation" maxOccurs="unbounded" minOccurs="0"/>
         <element name="beneficiaryBank" type="{http://www.fpml.org/FpML-5/confirmation}Beneficiary" minOccurs="0"/>
         <element name="beneficiary" type="{http://www.fpml.org/FpML-5/confirmation}Beneficiary"/>
         <element name="depositoryPartyReference" type="{http://www.fpml.org/FpML-5/confirmation}PartyReference" minOccurs="0"/>
         <element name="splitSettlement" type="{http://www.fpml.org/FpML-5/confirmation}SplitSettlement" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected Beneficiary	beneficiary
protected Beneficiary	beneficiaryBank
protected CorrespondentInformation	correspondentInformation
protected PartyReference	depositoryPartyReference
protected List<IntermediaryInformation>	intermediaryInformation
protected SettlementMethod	settlementMethod
protected List<SplitSettlement>	splitSettlement

Constructor Summary

Constructors

Constructor	Description
SettlementInstruction()

Method Summary

Modifier and Type	Method	Description
Beneficiary	getBeneficiary()	Gets the value of the beneficiary property.
Beneficiary	getBeneficiaryBank()	Gets the value of the beneficiaryBank property.
CorrespondentInformation	getCorrespondentInformation()	Gets the value of the correspondentInformation property.
PartyReference	getDepositoryPartyReference()	Gets the value of the depositoryPartyReference property.
List<IntermediaryInformation>	getIntermediaryInformation()	Gets the value of the intermediaryInformation property.
SettlementMethod	getSettlementMethod()	Gets the value of the settlementMethod property.
List<SplitSettlement>	getSplitSettlement()	Gets the value of the splitSettlement property.
void	setBeneficiary(Beneficiary value)	Sets the value of the beneficiary property.
void	setBeneficiaryBank(Beneficiary value)	Sets the value of the beneficiaryBank property.
void	setCorrespondentInformation(CorrespondentInformation value)	Sets the value of the correspondentInformation property.
void	setDepositoryPartyReference(PartyReference value)	Sets the value of the depositoryPartyReference property.
void	setSettlementMethod(SettlementMethod value)	Sets the value of the settlementMethod property.

Methods inherited from class java.lang.Object

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

Field Details

settlementMethod

protected SettlementMethod settlementMethod

correspondentInformation

protected CorrespondentInformation correspondentInformation

intermediaryInformation

protected List<IntermediaryInformation> intermediaryInformation

beneficiaryBank

protected Beneficiary beneficiaryBank

beneficiary

protected Beneficiary beneficiary

depositoryPartyReference

protected PartyReference depositoryPartyReference

splitSettlement

protected List<SplitSettlement> splitSettlement

Constructor Details

SettlementInstruction

public SettlementInstruction()

Method Details

getSettlementMethod

public SettlementMethod getSettlementMethod()

Gets the value of the settlementMethod property.

Returns:

possible object is SettlementMethod

setSettlementMethod

public void setSettlementMethod(SettlementMethod value)

Sets the value of the settlementMethod property.

Parameters:

value - allowed object is SettlementMethod

getCorrespondentInformation

public CorrespondentInformation getCorrespondentInformation()

Gets the value of the correspondentInformation property.

Returns:

possible object is CorrespondentInformation

setCorrespondentInformation

public void setCorrespondentInformation(CorrespondentInformation value)

Sets the value of the correspondentInformation property.

Parameters:

value - allowed object is CorrespondentInformation

getIntermediaryInformation

public List<IntermediaryInformation> getIntermediaryInformation()

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

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

    getIntermediaryInformation().add(newItem);
 

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

getBeneficiaryBank

public Beneficiary getBeneficiaryBank()

Gets the value of the beneficiaryBank property.

Returns:

possible object is Beneficiary

setBeneficiaryBank

public void setBeneficiaryBank(Beneficiary value)

Sets the value of the beneficiaryBank property.

Parameters:

value - allowed object is Beneficiary

getBeneficiary

public Beneficiary getBeneficiary()

Gets the value of the beneficiary property.

Returns:

possible object is Beneficiary

setBeneficiary

public void setBeneficiary(Beneficiary value)

Sets the value of the beneficiary property.

Parameters:

value - allowed object is Beneficiary

getDepositoryPartyReference

public PartyReference getDepositoryPartyReference()

Gets the value of the depositoryPartyReference property.

Returns:

possible object is PartyReference

setDepositoryPartyReference

public void setDepositoryPartyReference(PartyReference value)

Sets the value of the depositoryPartyReference property.

Parameters:

value - allowed object is PartyReference

getSplitSettlement

public List<SplitSettlement> getSplitSettlement()

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

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

    getSplitSettlement().add(newItem);
 

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