com.prowidesoftware.swift.model.mx.dic.SecuritiesSettlementTransactionInstructionV08 Maven / Gradle / Ivy
Show all versions of pw-iso20022 Show documentation
package com.prowidesoftware.swift.model.mx.dic;
import java.util.ArrayList;
import java.util.List;
import jakarta.xml.bind.annotation.XmlAccessType;
import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlType;
import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.apache.commons.lang3.builder.ToStringStyle;
/**
* Scope
* An account owner sends a SecuritiesSettlementTransactionInstruction to an account servicer to instruct the receipt or delivery of financial instruments with or without payment, physically or by book-entry.
* The account owner/servicer relationship may be:
* - a global custodian which has an account with a local custodian, or
* - an investment management institution which manages a fund account opened at a custodian, or
* - a broker which has an account with a custodian, or
* - a central securities depository participant which has an account with a central securities depository, or
* - a central securities depository which has an account with a custodian, another central securities depository or another settlement market infrastructure, or
* - a central counterparty or a stock exchange or a trade matching utility which need to instruct the settlement of transactions to a central securities depository or another settlement market infrastructure.
*
* Usage
* The instruction may be linked to other settlement instructions, for example, for a turnaround or back-to-back, or other transactions, for example, foreign exchange deal, using the linkage functionality.
* The message may also be used to:
* - re-send a message previously sent,
* - provide a third party with a copy of a message for information,
* - re-send to a third party a copy of a message for information
* using the relevant elements in the Business Application Header.
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "SecuritiesSettlementTransactionInstructionV08", propOrder = {
"txId",
"sttlmTpAndAddtlParams",
"nbCounts",
"lnkgs",
"tradDtls",
"finInstrmId",
"finInstrmAttrbts",
"qtyAndAcctDtls",
"sttlmParams",
"stgSttlmInstrDtls",
"dlvrgSttlmPties",
"rcvgSttlmPties",
"cshPties",
"sttlmAmt",
"othrAmts",
"othrBizPties",
"addtlPhysOrRegnDtls",
"splmtryData"
})
public class SecuritiesSettlementTransactionInstructionV08 {
@XmlElement(name = "TxId", required = true)
protected String txId;
@XmlElement(name = "SttlmTpAndAddtlParams", required = true)
protected SettlementTypeAndAdditionalParameters19 sttlmTpAndAddtlParams;
@XmlElement(name = "NbCounts")
protected NumberCount1Choice nbCounts;
@XmlElement(name = "Lnkgs")
protected List lnkgs;
@XmlElement(name = "TradDtls", required = true)
protected SecuritiesTradeDetails73 tradDtls;
@XmlElement(name = "FinInstrmId", required = true)
protected SecurityIdentification19 finInstrmId;
@XmlElement(name = "FinInstrmAttrbts")
protected FinancialInstrumentAttributes91 finInstrmAttrbts;
@XmlElement(name = "QtyAndAcctDtls", required = true)
protected QuantityAndAccount65 qtyAndAcctDtls;
@XmlElement(name = "SttlmParams", required = true)
protected SettlementDetails142 sttlmParams;
@XmlElement(name = "StgSttlmInstrDtls")
protected StandingSettlementInstruction14 stgSttlmInstrDtls;
@XmlElement(name = "DlvrgSttlmPties")
protected SettlementParties62 dlvrgSttlmPties;
@XmlElement(name = "RcvgSttlmPties")
protected SettlementParties62 rcvgSttlmPties;
@XmlElement(name = "CshPties")
protected CashParties26 cshPties;
@XmlElement(name = "SttlmAmt")
protected AmountAndDirection87 sttlmAmt;
@XmlElement(name = "OthrAmts")
protected OtherAmounts39 othrAmts;
@XmlElement(name = "OthrBizPties")
protected OtherParties27 othrBizPties;
@XmlElement(name = "AddtlPhysOrRegnDtls")
protected RegistrationParameters6 addtlPhysOrRegnDtls;
@XmlElement(name = "SplmtryData")
protected List splmtryData;
/**
* Gets the value of the txId property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getTxId() {
return txId;
}
/**
* Sets the value of the txId property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public SecuritiesSettlementTransactionInstructionV08 setTxId(String value) {
this.txId = value;
return this;
}
/**
* Gets the value of the sttlmTpAndAddtlParams property.
*
* @return
* possible object is
* {@link SettlementTypeAndAdditionalParameters19 }
*
*/
public SettlementTypeAndAdditionalParameters19 getSttlmTpAndAddtlParams() {
return sttlmTpAndAddtlParams;
}
/**
* Sets the value of the sttlmTpAndAddtlParams property.
*
* @param value
* allowed object is
* {@link SettlementTypeAndAdditionalParameters19 }
*
*/
public SecuritiesSettlementTransactionInstructionV08 setSttlmTpAndAddtlParams(SettlementTypeAndAdditionalParameters19 value) {
this.sttlmTpAndAddtlParams = value;
return this;
}
/**
* Gets the value of the nbCounts property.
*
* @return
* possible object is
* {@link NumberCount1Choice }
*
*/
public NumberCount1Choice getNbCounts() {
return nbCounts;
}
/**
* Sets the value of the nbCounts property.
*
* @param value
* allowed object is
* {@link NumberCount1Choice }
*
*/
public SecuritiesSettlementTransactionInstructionV08 setNbCounts(NumberCount1Choice value) {
this.nbCounts = value;
return this;
}
/**
* Gets the value of the lnkgs 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 {@code set} method for the lnkgs property.
*
*
* For example, to add a new item, do as follows:
*
* getLnkgs().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link Linkages37 }
*
*
* @return
* The value of the lnkgs property.
*/
public List getLnkgs() {
if (lnkgs == null) {
lnkgs = new ArrayList<>();
}
return this.lnkgs;
}
/**
* Gets the value of the tradDtls property.
*
* @return
* possible object is
* {@link SecuritiesTradeDetails73 }
*
*/
public SecuritiesTradeDetails73 getTradDtls() {
return tradDtls;
}
/**
* Sets the value of the tradDtls property.
*
* @param value
* allowed object is
* {@link SecuritiesTradeDetails73 }
*
*/
public SecuritiesSettlementTransactionInstructionV08 setTradDtls(SecuritiesTradeDetails73 value) {
this.tradDtls = value;
return this;
}
/**
* Gets the value of the finInstrmId property.
*
* @return
* possible object is
* {@link SecurityIdentification19 }
*
*/
public SecurityIdentification19 getFinInstrmId() {
return finInstrmId;
}
/**
* Sets the value of the finInstrmId property.
*
* @param value
* allowed object is
* {@link SecurityIdentification19 }
*
*/
public SecuritiesSettlementTransactionInstructionV08 setFinInstrmId(SecurityIdentification19 value) {
this.finInstrmId = value;
return this;
}
/**
* Gets the value of the finInstrmAttrbts property.
*
* @return
* possible object is
* {@link FinancialInstrumentAttributes91 }
*
*/
public FinancialInstrumentAttributes91 getFinInstrmAttrbts() {
return finInstrmAttrbts;
}
/**
* Sets the value of the finInstrmAttrbts property.
*
* @param value
* allowed object is
* {@link FinancialInstrumentAttributes91 }
*
*/
public SecuritiesSettlementTransactionInstructionV08 setFinInstrmAttrbts(FinancialInstrumentAttributes91 value) {
this.finInstrmAttrbts = value;
return this;
}
/**
* Gets the value of the qtyAndAcctDtls property.
*
* @return
* possible object is
* {@link QuantityAndAccount65 }
*
*/
public QuantityAndAccount65 getQtyAndAcctDtls() {
return qtyAndAcctDtls;
}
/**
* Sets the value of the qtyAndAcctDtls property.
*
* @param value
* allowed object is
* {@link QuantityAndAccount65 }
*
*/
public SecuritiesSettlementTransactionInstructionV08 setQtyAndAcctDtls(QuantityAndAccount65 value) {
this.qtyAndAcctDtls = value;
return this;
}
/**
* Gets the value of the sttlmParams property.
*
* @return
* possible object is
* {@link SettlementDetails142 }
*
*/
public SettlementDetails142 getSttlmParams() {
return sttlmParams;
}
/**
* Sets the value of the sttlmParams property.
*
* @param value
* allowed object is
* {@link SettlementDetails142 }
*
*/
public SecuritiesSettlementTransactionInstructionV08 setSttlmParams(SettlementDetails142 value) {
this.sttlmParams = value;
return this;
}
/**
* Gets the value of the stgSttlmInstrDtls property.
*
* @return
* possible object is
* {@link StandingSettlementInstruction14 }
*
*/
public StandingSettlementInstruction14 getStgSttlmInstrDtls() {
return stgSttlmInstrDtls;
}
/**
* Sets the value of the stgSttlmInstrDtls property.
*
* @param value
* allowed object is
* {@link StandingSettlementInstruction14 }
*
*/
public SecuritiesSettlementTransactionInstructionV08 setStgSttlmInstrDtls(StandingSettlementInstruction14 value) {
this.stgSttlmInstrDtls = value;
return this;
}
/**
* Gets the value of the dlvrgSttlmPties property.
*
* @return
* possible object is
* {@link SettlementParties62 }
*
*/
public SettlementParties62 getDlvrgSttlmPties() {
return dlvrgSttlmPties;
}
/**
* Sets the value of the dlvrgSttlmPties property.
*
* @param value
* allowed object is
* {@link SettlementParties62 }
*
*/
public SecuritiesSettlementTransactionInstructionV08 setDlvrgSttlmPties(SettlementParties62 value) {
this.dlvrgSttlmPties = value;
return this;
}
/**
* Gets the value of the rcvgSttlmPties property.
*
* @return
* possible object is
* {@link SettlementParties62 }
*
*/
public SettlementParties62 getRcvgSttlmPties() {
return rcvgSttlmPties;
}
/**
* Sets the value of the rcvgSttlmPties property.
*
* @param value
* allowed object is
* {@link SettlementParties62 }
*
*/
public SecuritiesSettlementTransactionInstructionV08 setRcvgSttlmPties(SettlementParties62 value) {
this.rcvgSttlmPties = value;
return this;
}
/**
* Gets the value of the cshPties property.
*
* @return
* possible object is
* {@link CashParties26 }
*
*/
public CashParties26 getCshPties() {
return cshPties;
}
/**
* Sets the value of the cshPties property.
*
* @param value
* allowed object is
* {@link CashParties26 }
*
*/
public SecuritiesSettlementTransactionInstructionV08 setCshPties(CashParties26 value) {
this.cshPties = value;
return this;
}
/**
* Gets the value of the sttlmAmt property.
*
* @return
* possible object is
* {@link AmountAndDirection87 }
*
*/
public AmountAndDirection87 getSttlmAmt() {
return sttlmAmt;
}
/**
* Sets the value of the sttlmAmt property.
*
* @param value
* allowed object is
* {@link AmountAndDirection87 }
*
*/
public SecuritiesSettlementTransactionInstructionV08 setSttlmAmt(AmountAndDirection87 value) {
this.sttlmAmt = value;
return this;
}
/**
* Gets the value of the othrAmts property.
*
* @return
* possible object is
* {@link OtherAmounts39 }
*
*/
public OtherAmounts39 getOthrAmts() {
return othrAmts;
}
/**
* Sets the value of the othrAmts property.
*
* @param value
* allowed object is
* {@link OtherAmounts39 }
*
*/
public SecuritiesSettlementTransactionInstructionV08 setOthrAmts(OtherAmounts39 value) {
this.othrAmts = value;
return this;
}
/**
* Gets the value of the othrBizPties property.
*
* @return
* possible object is
* {@link OtherParties27 }
*
*/
public OtherParties27 getOthrBizPties() {
return othrBizPties;
}
/**
* Sets the value of the othrBizPties property.
*
* @param value
* allowed object is
* {@link OtherParties27 }
*
*/
public SecuritiesSettlementTransactionInstructionV08 setOthrBizPties(OtherParties27 value) {
this.othrBizPties = value;
return this;
}
/**
* Gets the value of the addtlPhysOrRegnDtls property.
*
* @return
* possible object is
* {@link RegistrationParameters6 }
*
*/
public RegistrationParameters6 getAddtlPhysOrRegnDtls() {
return addtlPhysOrRegnDtls;
}
/**
* Sets the value of the addtlPhysOrRegnDtls property.
*
* @param value
* allowed object is
* {@link RegistrationParameters6 }
*
*/
public SecuritiesSettlementTransactionInstructionV08 setAddtlPhysOrRegnDtls(RegistrationParameters6 value) {
this.addtlPhysOrRegnDtls = value;
return this;
}
/**
* Gets the value of the splmtryData 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 {@code set} method for the splmtryData property.
*
*
* For example, to add a new item, do as follows:
*
* getSplmtryData().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link SupplementaryData1 }
*
*
* @return
* The value of the splmtryData property.
*/
public List getSplmtryData() {
if (splmtryData == null) {
splmtryData = new ArrayList<>();
}
return this.splmtryData;
}
@Override
public String toString() {
return ToStringBuilder.reflectionToString(this, ToStringStyle.MULTI_LINE_STYLE);
}
@Override
public boolean equals(Object that) {
return EqualsBuilder.reflectionEquals(this, that);
}
@Override
public int hashCode() {
return HashCodeBuilder.reflectionHashCode(this);
}
/**
* Adds a new item to the lnkgs list.
* @see #getLnkgs()
*
*/
public SecuritiesSettlementTransactionInstructionV08 addLnkgs(Linkages37 lnkgs) {
getLnkgs().add(lnkgs);
return this;
}
/**
* Adds a new item to the splmtryData list.
* @see #getSplmtryData()
*
*/
public SecuritiesSettlementTransactionInstructionV08 addSplmtryData(SupplementaryData1 splmtryData) {
getSplmtryData().add(splmtryData);
return this;
}
}