com.prowidesoftware.swift.model.mx.dic.SecuritiesMessageCancellationAdvice002V06 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 SecuritiesMessageCancellationAdvice to an account owner to inform of the cancellation of a securities message previously sent by an account servicer.
* 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 previously sent message may be:
* - a securities settlement transaction confirmation
* - a report (transactions, pending transactions, allegements, accounting and custody securities balance)
* - a allegement notification (when sent by mistake or because the counterparty cancelled its instruction)
* - a portfolio transfer notification
* - an intra-position movement confirmation
* - a transaction generation notification
*
* The previously sent message cannot be a status advice message (any). If a status advice should not have been sent, a new status advice with the correct status should be sent, not a cancellation advice.
* 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 = "SecuritiesMessageCancellationAdvice002V06", propOrder = {
"ref",
"acctOwnr",
"sfkpgAcct",
"splmtryData"
})
public class SecuritiesMessageCancellationAdvice002V06 {
@XmlElement(name = "Ref", required = true)
protected References71Choice ref;
@XmlElement(name = "AcctOwnr")
protected PartyIdentification156 acctOwnr;
@XmlElement(name = "SfkpgAcct", required = true)
protected SecuritiesAccount30 sfkpgAcct;
@XmlElement(name = "SplmtryData")
protected List splmtryData;
/**
* Gets the value of the ref property.
*
* @return
* possible object is
* {@link References71Choice }
*
*/
public References71Choice getRef() {
return ref;
}
/**
* Sets the value of the ref property.
*
* @param value
* allowed object is
* {@link References71Choice }
*
*/
public SecuritiesMessageCancellationAdvice002V06 setRef(References71Choice value) {
this.ref = value;
return this;
}
/**
* Gets the value of the acctOwnr property.
*
* @return
* possible object is
* {@link PartyIdentification156 }
*
*/
public PartyIdentification156 getAcctOwnr() {
return acctOwnr;
}
/**
* Sets the value of the acctOwnr property.
*
* @param value
* allowed object is
* {@link PartyIdentification156 }
*
*/
public SecuritiesMessageCancellationAdvice002V06 setAcctOwnr(PartyIdentification156 value) {
this.acctOwnr = value;
return this;
}
/**
* Gets the value of the sfkpgAcct property.
*
* @return
* possible object is
* {@link SecuritiesAccount30 }
*
*/
public SecuritiesAccount30 getSfkpgAcct() {
return sfkpgAcct;
}
/**
* Sets the value of the sfkpgAcct property.
*
* @param value
* allowed object is
* {@link SecuritiesAccount30 }
*
*/
public SecuritiesMessageCancellationAdvice002V06 setSfkpgAcct(SecuritiesAccount30 value) {
this.sfkpgAcct = 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 SecuritiesMessageCancellationAdvice002V06 addSplmtryData(SupplementaryData1 splmtryData) {
getSplmtryData().add(splmtryData);
return this;
}
}