com.prowidesoftware.swift.model.mx.dic.SecuritiesSettlementTransactionReversalAdviceV02 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 servicer sends a SecuritiesSettlementTransactionReversalAdvice to an account owner to reverse the confirmation of a partial or full delivery or receipt of financial instruments, free or against of payment, physically or by book-entry.
* The account servicer/owner relationship may be:
* - a central securities depository or another settlement market infrastructure acting on behalf of their participants
* - an agent (sub-custodian) acting on behalf of their global custodian customer, or
* - a custodian acting on behalf of an investment management institution or a broker/dealer.
* Usage
* 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.
* ISO 15022 - 20022 Coexistence
* This ISO 20022 message is reversed engineered from ISO 15022. Both standards will coexist for a certain number of years. Until this coexistence period ends, the usage of certain data types is restricted to ensure interoperability between ISO 15022 and 20022 users. Compliance to these rules is mandatory in a coexistence environment. The coexistence restrictions are described in a Textual Rule linked to the Message Items they concern. These coexistence textual rules are clearly identified as follows: “CoexistenceXxxxRule”.
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "SecuritiesSettlementTransactionReversalAdviceV02", propOrder = {
"txIdDtls",
"confRef",
"addtlParams",
"tradDtls",
"finInstrmId",
"finInstrmAttrbts",
"qtyAndAcctDtls",
"sttlmParams",
"stgSttlmInstrDtls",
"dlvrgSttlmPties",
"rcvgSttlmPties",
"cshPties",
"sttldAmt",
"othrAmts",
"othrBizPties",
"addtlPhysOrRegnDtls",
"splmtryData"
})
public class SecuritiesSettlementTransactionReversalAdviceV02 {
@XmlElement(name = "TxIdDtls", required = true)
protected SettlementTypeAndIdentification9 txIdDtls;
@XmlElement(name = "ConfRef", required = true)
protected Identification1 confRef;
@XmlElement(name = "AddtlParams")
protected AdditionalParameters4 addtlParams;
@XmlElement(name = "TradDtls", required = true)
protected SecuritiesTradeDetails2 tradDtls;
@XmlElement(name = "FinInstrmId", required = true)
protected SecurityIdentification14 finInstrmId;
@XmlElement(name = "FinInstrmAttrbts")
protected FinancialInstrumentAttributes20 finInstrmAttrbts;
@XmlElement(name = "QtyAndAcctDtls", required = true)
protected QuantityAndAccount15 qtyAndAcctDtls;
@XmlElement(name = "SttlmParams", required = true)
protected SettlementDetails26 sttlmParams;
@XmlElement(name = "StgSttlmInstrDtls")
protected StandingSettlementInstruction5 stgSttlmInstrDtls;
@XmlElement(name = "DlvrgSttlmPties")
protected SettlementParties14 dlvrgSttlmPties;
@XmlElement(name = "RcvgSttlmPties")
protected SettlementParties14 rcvgSttlmPties;
@XmlElement(name = "CshPties")
protected CashParties9 cshPties;
@XmlElement(name = "SttldAmt")
protected AmountAndDirection2 sttldAmt;
@XmlElement(name = "OthrAmts")
protected OtherAmounts9 othrAmts;
@XmlElement(name = "OthrBizPties")
protected OtherParties12 othrBizPties;
@XmlElement(name = "AddtlPhysOrRegnDtls")
protected RegistrationParameters1 addtlPhysOrRegnDtls;
@XmlElement(name = "SplmtryData")
protected List splmtryData;
/**
* Gets the value of the txIdDtls property.
*
* @return
* possible object is
* {@link SettlementTypeAndIdentification9 }
*
*/
public SettlementTypeAndIdentification9 getTxIdDtls() {
return txIdDtls;
}
/**
* Sets the value of the txIdDtls property.
*
* @param value
* allowed object is
* {@link SettlementTypeAndIdentification9 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02 setTxIdDtls(SettlementTypeAndIdentification9 value) {
this.txIdDtls = value;
return this;
}
/**
* Gets the value of the confRef property.
*
* @return
* possible object is
* {@link Identification1 }
*
*/
public Identification1 getConfRef() {
return confRef;
}
/**
* Sets the value of the confRef property.
*
* @param value
* allowed object is
* {@link Identification1 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02 setConfRef(Identification1 value) {
this.confRef = value;
return this;
}
/**
* Gets the value of the addtlParams property.
*
* @return
* possible object is
* {@link AdditionalParameters4 }
*
*/
public AdditionalParameters4 getAddtlParams() {
return addtlParams;
}
/**
* Sets the value of the addtlParams property.
*
* @param value
* allowed object is
* {@link AdditionalParameters4 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02 setAddtlParams(AdditionalParameters4 value) {
this.addtlParams = value;
return this;
}
/**
* Gets the value of the tradDtls property.
*
* @return
* possible object is
* {@link SecuritiesTradeDetails2 }
*
*/
public SecuritiesTradeDetails2 getTradDtls() {
return tradDtls;
}
/**
* Sets the value of the tradDtls property.
*
* @param value
* allowed object is
* {@link SecuritiesTradeDetails2 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02 setTradDtls(SecuritiesTradeDetails2 value) {
this.tradDtls = value;
return this;
}
/**
* Gets the value of the finInstrmId property.
*
* @return
* possible object is
* {@link SecurityIdentification14 }
*
*/
public SecurityIdentification14 getFinInstrmId() {
return finInstrmId;
}
/**
* Sets the value of the finInstrmId property.
*
* @param value
* allowed object is
* {@link SecurityIdentification14 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02 setFinInstrmId(SecurityIdentification14 value) {
this.finInstrmId = value;
return this;
}
/**
* Gets the value of the finInstrmAttrbts property.
*
* @return
* possible object is
* {@link FinancialInstrumentAttributes20 }
*
*/
public FinancialInstrumentAttributes20 getFinInstrmAttrbts() {
return finInstrmAttrbts;
}
/**
* Sets the value of the finInstrmAttrbts property.
*
* @param value
* allowed object is
* {@link FinancialInstrumentAttributes20 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02 setFinInstrmAttrbts(FinancialInstrumentAttributes20 value) {
this.finInstrmAttrbts = value;
return this;
}
/**
* Gets the value of the qtyAndAcctDtls property.
*
* @return
* possible object is
* {@link QuantityAndAccount15 }
*
*/
public QuantityAndAccount15 getQtyAndAcctDtls() {
return qtyAndAcctDtls;
}
/**
* Sets the value of the qtyAndAcctDtls property.
*
* @param value
* allowed object is
* {@link QuantityAndAccount15 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02 setQtyAndAcctDtls(QuantityAndAccount15 value) {
this.qtyAndAcctDtls = value;
return this;
}
/**
* Gets the value of the sttlmParams property.
*
* @return
* possible object is
* {@link SettlementDetails26 }
*
*/
public SettlementDetails26 getSttlmParams() {
return sttlmParams;
}
/**
* Sets the value of the sttlmParams property.
*
* @param value
* allowed object is
* {@link SettlementDetails26 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02 setSttlmParams(SettlementDetails26 value) {
this.sttlmParams = value;
return this;
}
/**
* Gets the value of the stgSttlmInstrDtls property.
*
* @return
* possible object is
* {@link StandingSettlementInstruction5 }
*
*/
public StandingSettlementInstruction5 getStgSttlmInstrDtls() {
return stgSttlmInstrDtls;
}
/**
* Sets the value of the stgSttlmInstrDtls property.
*
* @param value
* allowed object is
* {@link StandingSettlementInstruction5 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02 setStgSttlmInstrDtls(StandingSettlementInstruction5 value) {
this.stgSttlmInstrDtls = value;
return this;
}
/**
* Gets the value of the dlvrgSttlmPties property.
*
* @return
* possible object is
* {@link SettlementParties14 }
*
*/
public SettlementParties14 getDlvrgSttlmPties() {
return dlvrgSttlmPties;
}
/**
* Sets the value of the dlvrgSttlmPties property.
*
* @param value
* allowed object is
* {@link SettlementParties14 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02 setDlvrgSttlmPties(SettlementParties14 value) {
this.dlvrgSttlmPties = value;
return this;
}
/**
* Gets the value of the rcvgSttlmPties property.
*
* @return
* possible object is
* {@link SettlementParties14 }
*
*/
public SettlementParties14 getRcvgSttlmPties() {
return rcvgSttlmPties;
}
/**
* Sets the value of the rcvgSttlmPties property.
*
* @param value
* allowed object is
* {@link SettlementParties14 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02 setRcvgSttlmPties(SettlementParties14 value) {
this.rcvgSttlmPties = value;
return this;
}
/**
* Gets the value of the cshPties property.
*
* @return
* possible object is
* {@link CashParties9 }
*
*/
public CashParties9 getCshPties() {
return cshPties;
}
/**
* Sets the value of the cshPties property.
*
* @param value
* allowed object is
* {@link CashParties9 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02 setCshPties(CashParties9 value) {
this.cshPties = value;
return this;
}
/**
* Gets the value of the sttldAmt property.
*
* @return
* possible object is
* {@link AmountAndDirection2 }
*
*/
public AmountAndDirection2 getSttldAmt() {
return sttldAmt;
}
/**
* Sets the value of the sttldAmt property.
*
* @param value
* allowed object is
* {@link AmountAndDirection2 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02 setSttldAmt(AmountAndDirection2 value) {
this.sttldAmt = value;
return this;
}
/**
* Gets the value of the othrAmts property.
*
* @return
* possible object is
* {@link OtherAmounts9 }
*
*/
public OtherAmounts9 getOthrAmts() {
return othrAmts;
}
/**
* Sets the value of the othrAmts property.
*
* @param value
* allowed object is
* {@link OtherAmounts9 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02 setOthrAmts(OtherAmounts9 value) {
this.othrAmts = value;
return this;
}
/**
* Gets the value of the othrBizPties property.
*
* @return
* possible object is
* {@link OtherParties12 }
*
*/
public OtherParties12 getOthrBizPties() {
return othrBizPties;
}
/**
* Sets the value of the othrBizPties property.
*
* @param value
* allowed object is
* {@link OtherParties12 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02 setOthrBizPties(OtherParties12 value) {
this.othrBizPties = value;
return this;
}
/**
* Gets the value of the addtlPhysOrRegnDtls property.
*
* @return
* possible object is
* {@link RegistrationParameters1 }
*
*/
public RegistrationParameters1 getAddtlPhysOrRegnDtls() {
return addtlPhysOrRegnDtls;
}
/**
* Sets the value of the addtlPhysOrRegnDtls property.
*
* @param value
* allowed object is
* {@link RegistrationParameters1 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02 setAddtlPhysOrRegnDtls(RegistrationParameters1 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 splmtryData list.
* @see #getSplmtryData()
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02 addSplmtryData(SupplementaryData1 splmtryData) {
getSplmtryData().add(splmtryData);
return this;
}
}