com.prowidesoftware.swift.model.mx.dic.FIToFIPaymentStatusReportV08 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
* The FIToFIPaymentStatusReport message is sent by an instructed agent to the previous party in the payment chain. It is used to inform this party about the positive or negative status of an instruction (either single or file). It is also used to report on a pending instruction.
* Usage
* The FIToFIPaymentStatusReport message is exchanged between agents to provide status information about instructions previously sent. Its usage will always be governed by a bilateral agreement between the agents.
* The FIToFIPaymentStatusReport message can be used to provide information about the status (e.g. rejection, acceptance) of a credit transfer instruction, a direct debit instruction, as well as other intra-agent instructions (for example FIToFIPaymentCancellationRequest).
* The FIToFIPaymentStatusReport message refers to the original instruction(s) by means of references only or by means of references and a set of elements from the original instruction.
* The FIToFIPaymentStatusReport message can be used in domestic and cross-border scenarios.
* The FIToFIPaymentStatusReport may also be sent to the receiver of the payment in a real time payment scenario, as both sides of the transactions must be informed of the status of the transaction (e.g. either the beneficiary is credited, or the transaction is rejected).
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "FIToFIPaymentStatusReportV08", propOrder = {
"grpHdr",
"orgnlGrpInfAndSts",
"txInfAndSts",
"splmtryData"
})
public class FIToFIPaymentStatusReportV08 {
@XmlElement(name = "GrpHdr", required = true)
protected GroupHeader53 grpHdr;
@XmlElement(name = "OrgnlGrpInfAndSts")
protected List orgnlGrpInfAndSts;
@XmlElement(name = "TxInfAndSts")
protected List txInfAndSts;
@XmlElement(name = "SplmtryData")
protected List splmtryData;
/**
* Gets the value of the grpHdr property.
*
* @return
* possible object is
* {@link GroupHeader53 }
*
*/
public GroupHeader53 getGrpHdr() {
return grpHdr;
}
/**
* Sets the value of the grpHdr property.
*
* @param value
* allowed object is
* {@link GroupHeader53 }
*
*/
public FIToFIPaymentStatusReportV08 setGrpHdr(GroupHeader53 value) {
this.grpHdr = value;
return this;
}
/**
* Gets the value of the orgnlGrpInfAndSts 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 orgnlGrpInfAndSts property.
*
*
* For example, to add a new item, do as follows:
*
* getOrgnlGrpInfAndSts().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link OriginalGroupHeader7 }
*
*
* @return
* The value of the orgnlGrpInfAndSts property.
*/
public List getOrgnlGrpInfAndSts() {
if (orgnlGrpInfAndSts == null) {
orgnlGrpInfAndSts = new ArrayList<>();
}
return this.orgnlGrpInfAndSts;
}
/**
* Gets the value of the txInfAndSts 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 txInfAndSts property.
*
*
* For example, to add a new item, do as follows:
*
* getTxInfAndSts().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link PaymentTransaction80 }
*
*
* @return
* The value of the txInfAndSts property.
*/
public List getTxInfAndSts() {
if (txInfAndSts == null) {
txInfAndSts = new ArrayList<>();
}
return this.txInfAndSts;
}
/**
* 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 orgnlGrpInfAndSts list.
* @see #getOrgnlGrpInfAndSts()
*
*/
public FIToFIPaymentStatusReportV08 addOrgnlGrpInfAndSts(OriginalGroupHeader7 orgnlGrpInfAndSts) {
getOrgnlGrpInfAndSts().add(orgnlGrpInfAndSts);
return this;
}
/**
* Adds a new item to the txInfAndSts list.
* @see #getTxInfAndSts()
*
*/
public FIToFIPaymentStatusReportV08 addTxInfAndSts(PaymentTransaction80 txInfAndSts) {
getTxInfAndSts().add(txInfAndSts);
return this;
}
/**
* Adds a new item to the splmtryData list.
* @see #getSplmtryData()
*
*/
public FIToFIPaymentStatusReportV08 addSplmtryData(SupplementaryData1 splmtryData) {
getSplmtryData().add(splmtryData);
return this;
}
}