com.prowidesoftware.swift.model.mx.dic.SecuritiesSettlementTransactionReversalAdviceV02Subset 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 Subset
* This message definition is a subset of an ISO 20022 message that was reversed engineered from ISO 15022. A subset is a message definition that is compatible with another definition, but is more restrictive
* The ISO 15022 and ISO 20022 standards will coexist for a 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. These restrictions, which are described by textual usage rules in the ISO 20022 message, have been made mandatory in this subset.
* NOTE: The ISO 20022 message coexistence textual rules have been kept in the subset to explain why specific data types have been restricted. These textual rules are identified as follows: CoexistenceXxxxRule.
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "SecuritiesSettlementTransactionReversalAdviceV02Subset", propOrder = {
"txIdDtls",
"confRef",
"addtlParams",
"tradDtls",
"finInstrmId",
"finInstrmAttrbts",
"qtyAndAcctDtls",
"sttlmParams",
"stgSttlmInstrDtls",
"dlvrgSttlmPties",
"rcvgSttlmPties",
"cshPties",
"sttldAmt",
"othrAmts",
"othrBizPties",
"addtlPhysOrRegnDtls",
"splmtryData"
})
public class SecuritiesSettlementTransactionReversalAdviceV02Subset {
@XmlElement(name = "TxIdDtls", required = true)
protected SettlementTypeAndIdentification11 txIdDtls;
@XmlElement(name = "ConfRef", required = true)
protected Identification4 confRef;
@XmlElement(name = "AddtlParams")
protected AdditionalParameters5 addtlParams;
@XmlElement(name = "TradDtls", required = true)
protected SecuritiesTradeDetails16 tradDtls;
@XmlElement(name = "FinInstrmId", required = true)
protected SecurityIdentification15 finInstrmId;
@XmlElement(name = "FinInstrmAttrbts")
protected FinancialInstrumentAttributes28 finInstrmAttrbts;
@XmlElement(name = "QtyAndAcctDtls", required = true)
protected QuantityAndAccount20 qtyAndAcctDtls;
@XmlElement(name = "SttlmParams", required = true)
protected SettlementDetails36 sttlmParams;
@XmlElement(name = "StgSttlmInstrDtls")
protected StandingSettlementInstruction8 stgSttlmInstrDtls;
@XmlElement(name = "DlvrgSttlmPties")
protected SettlementParties20 dlvrgSttlmPties;
@XmlElement(name = "RcvgSttlmPties")
protected SettlementParties20 rcvgSttlmPties;
@XmlElement(name = "CshPties")
protected CashParties16 cshPties;
@XmlElement(name = "SttldAmt")
protected AmountAndDirection16 sttldAmt;
@XmlElement(name = "OthrAmts")
protected OtherAmounts10 othrAmts;
@XmlElement(name = "OthrBizPties")
protected OtherParties17 othrBizPties;
@XmlElement(name = "AddtlPhysOrRegnDtls")
protected RegistrationParameters2 addtlPhysOrRegnDtls;
@XmlElement(name = "SplmtryData")
protected List splmtryData;
/**
* Gets the value of the txIdDtls property.
*
* @return
* possible object is
* {@link SettlementTypeAndIdentification11 }
*
*/
public SettlementTypeAndIdentification11 getTxIdDtls() {
return txIdDtls;
}
/**
* Sets the value of the txIdDtls property.
*
* @param value
* allowed object is
* {@link SettlementTypeAndIdentification11 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02Subset setTxIdDtls(SettlementTypeAndIdentification11 value) {
this.txIdDtls = value;
return this;
}
/**
* Gets the value of the confRef property.
*
* @return
* possible object is
* {@link Identification4 }
*
*/
public Identification4 getConfRef() {
return confRef;
}
/**
* Sets the value of the confRef property.
*
* @param value
* allowed object is
* {@link Identification4 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02Subset setConfRef(Identification4 value) {
this.confRef = value;
return this;
}
/**
* Gets the value of the addtlParams property.
*
* @return
* possible object is
* {@link AdditionalParameters5 }
*
*/
public AdditionalParameters5 getAddtlParams() {
return addtlParams;
}
/**
* Sets the value of the addtlParams property.
*
* @param value
* allowed object is
* {@link AdditionalParameters5 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02Subset setAddtlParams(AdditionalParameters5 value) {
this.addtlParams = value;
return this;
}
/**
* Gets the value of the tradDtls property.
*
* @return
* possible object is
* {@link SecuritiesTradeDetails16 }
*
*/
public SecuritiesTradeDetails16 getTradDtls() {
return tradDtls;
}
/**
* Sets the value of the tradDtls property.
*
* @param value
* allowed object is
* {@link SecuritiesTradeDetails16 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02Subset setTradDtls(SecuritiesTradeDetails16 value) {
this.tradDtls = value;
return this;
}
/**
* Gets the value of the finInstrmId property.
*
* @return
* possible object is
* {@link SecurityIdentification15 }
*
*/
public SecurityIdentification15 getFinInstrmId() {
return finInstrmId;
}
/**
* Sets the value of the finInstrmId property.
*
* @param value
* allowed object is
* {@link SecurityIdentification15 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02Subset setFinInstrmId(SecurityIdentification15 value) {
this.finInstrmId = value;
return this;
}
/**
* Gets the value of the finInstrmAttrbts property.
*
* @return
* possible object is
* {@link FinancialInstrumentAttributes28 }
*
*/
public FinancialInstrumentAttributes28 getFinInstrmAttrbts() {
return finInstrmAttrbts;
}
/**
* Sets the value of the finInstrmAttrbts property.
*
* @param value
* allowed object is
* {@link FinancialInstrumentAttributes28 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02Subset setFinInstrmAttrbts(FinancialInstrumentAttributes28 value) {
this.finInstrmAttrbts = value;
return this;
}
/**
* Gets the value of the qtyAndAcctDtls property.
*
* @return
* possible object is
* {@link QuantityAndAccount20 }
*
*/
public QuantityAndAccount20 getQtyAndAcctDtls() {
return qtyAndAcctDtls;
}
/**
* Sets the value of the qtyAndAcctDtls property.
*
* @param value
* allowed object is
* {@link QuantityAndAccount20 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02Subset setQtyAndAcctDtls(QuantityAndAccount20 value) {
this.qtyAndAcctDtls = value;
return this;
}
/**
* Gets the value of the sttlmParams property.
*
* @return
* possible object is
* {@link SettlementDetails36 }
*
*/
public SettlementDetails36 getSttlmParams() {
return sttlmParams;
}
/**
* Sets the value of the sttlmParams property.
*
* @param value
* allowed object is
* {@link SettlementDetails36 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02Subset setSttlmParams(SettlementDetails36 value) {
this.sttlmParams = value;
return this;
}
/**
* Gets the value of the stgSttlmInstrDtls property.
*
* @return
* possible object is
* {@link StandingSettlementInstruction8 }
*
*/
public StandingSettlementInstruction8 getStgSttlmInstrDtls() {
return stgSttlmInstrDtls;
}
/**
* Sets the value of the stgSttlmInstrDtls property.
*
* @param value
* allowed object is
* {@link StandingSettlementInstruction8 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02Subset setStgSttlmInstrDtls(StandingSettlementInstruction8 value) {
this.stgSttlmInstrDtls = value;
return this;
}
/**
* Gets the value of the dlvrgSttlmPties property.
*
* @return
* possible object is
* {@link SettlementParties20 }
*
*/
public SettlementParties20 getDlvrgSttlmPties() {
return dlvrgSttlmPties;
}
/**
* Sets the value of the dlvrgSttlmPties property.
*
* @param value
* allowed object is
* {@link SettlementParties20 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02Subset setDlvrgSttlmPties(SettlementParties20 value) {
this.dlvrgSttlmPties = value;
return this;
}
/**
* Gets the value of the rcvgSttlmPties property.
*
* @return
* possible object is
* {@link SettlementParties20 }
*
*/
public SettlementParties20 getRcvgSttlmPties() {
return rcvgSttlmPties;
}
/**
* Sets the value of the rcvgSttlmPties property.
*
* @param value
* allowed object is
* {@link SettlementParties20 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02Subset setRcvgSttlmPties(SettlementParties20 value) {
this.rcvgSttlmPties = value;
return this;
}
/**
* Gets the value of the cshPties property.
*
* @return
* possible object is
* {@link CashParties16 }
*
*/
public CashParties16 getCshPties() {
return cshPties;
}
/**
* Sets the value of the cshPties property.
*
* @param value
* allowed object is
* {@link CashParties16 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02Subset setCshPties(CashParties16 value) {
this.cshPties = value;
return this;
}
/**
* Gets the value of the sttldAmt property.
*
* @return
* possible object is
* {@link AmountAndDirection16 }
*
*/
public AmountAndDirection16 getSttldAmt() {
return sttldAmt;
}
/**
* Sets the value of the sttldAmt property.
*
* @param value
* allowed object is
* {@link AmountAndDirection16 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02Subset setSttldAmt(AmountAndDirection16 value) {
this.sttldAmt = value;
return this;
}
/**
* Gets the value of the othrAmts property.
*
* @return
* possible object is
* {@link OtherAmounts10 }
*
*/
public OtherAmounts10 getOthrAmts() {
return othrAmts;
}
/**
* Sets the value of the othrAmts property.
*
* @param value
* allowed object is
* {@link OtherAmounts10 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02Subset setOthrAmts(OtherAmounts10 value) {
this.othrAmts = value;
return this;
}
/**
* Gets the value of the othrBizPties property.
*
* @return
* possible object is
* {@link OtherParties17 }
*
*/
public OtherParties17 getOthrBizPties() {
return othrBizPties;
}
/**
* Sets the value of the othrBizPties property.
*
* @param value
* allowed object is
* {@link OtherParties17 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02Subset setOthrBizPties(OtherParties17 value) {
this.othrBizPties = value;
return this;
}
/**
* Gets the value of the addtlPhysOrRegnDtls property.
*
* @return
* possible object is
* {@link RegistrationParameters2 }
*
*/
public RegistrationParameters2 getAddtlPhysOrRegnDtls() {
return addtlPhysOrRegnDtls;
}
/**
* Sets the value of the addtlPhysOrRegnDtls property.
*
* @param value
* allowed object is
* {@link RegistrationParameters2 }
*
*/
public SecuritiesSettlementTransactionReversalAdviceV02Subset setAddtlPhysOrRegnDtls(RegistrationParameters2 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 SecuritiesSettlementTransactionReversalAdviceV02Subset addSplmtryData(SupplementaryData1 splmtryData) {
getSplmtryData().add(splmtryData);
return this;
}
}