com.prowidesoftware.swift.model.mx.dic.SubscriptionOrderCancellationRequestV04 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 SubscriptionOrderCancellationRequest message is sent by an instructing party, for example, an investment manager or its authorised representative, to the executing party, for example, a transfer agent, to request the cancellation of a previously sent SubscriptionOrder.
* Usage
* The SubscriptionOrderCancellationRequest message is used to request the cancellation of one or more individual orders.
* There is no amendment, but a cancellation and re-instruct policy.
* To request the cancellation of one or more individual orders, the order reference of each individual order listed in the original SubscriptionOrder message is specified in the order reference element. The message identification of the SubscriptionOrder message which contains the individual orders to be cancelled may also be quoted in PreviousReference but this is not recommended.
* The deadline and acceptance of a cancellation request is subject to a service level agreement (SLA). This cancellation message is a cancellation request. There is no automatic acceptance of the cancellation.
* The rejection or acceptance of a SubscriptionOrderCancellationRequest is made using an OrderCancellationStatusReport message.
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "SubscriptionOrderCancellationRequestV04", propOrder = {
"msgId",
"poolRef",
"prvsRef",
"mstrRef",
"ordrRefs",
"cpyDtls"
})
public class SubscriptionOrderCancellationRequestV04 {
@XmlElement(name = "MsgId", required = true)
protected MessageIdentification1 msgId;
@XmlElement(name = "PoolRef")
protected AdditionalReference9 poolRef;
@XmlElement(name = "PrvsRef")
protected AdditionalReference8 prvsRef;
@XmlElement(name = "MstrRef")
protected String mstrRef;
@XmlElement(name = "OrdrRefs", required = true)
protected List ordrRefs;
@XmlElement(name = "CpyDtls")
protected CopyInformation4 cpyDtls;
/**
* Gets the value of the msgId property.
*
* @return
* possible object is
* {@link MessageIdentification1 }
*
*/
public MessageIdentification1 getMsgId() {
return msgId;
}
/**
* Sets the value of the msgId property.
*
* @param value
* allowed object is
* {@link MessageIdentification1 }
*
*/
public SubscriptionOrderCancellationRequestV04 setMsgId(MessageIdentification1 value) {
this.msgId = value;
return this;
}
/**
* Gets the value of the poolRef property.
*
* @return
* possible object is
* {@link AdditionalReference9 }
*
*/
public AdditionalReference9 getPoolRef() {
return poolRef;
}
/**
* Sets the value of the poolRef property.
*
* @param value
* allowed object is
* {@link AdditionalReference9 }
*
*/
public SubscriptionOrderCancellationRequestV04 setPoolRef(AdditionalReference9 value) {
this.poolRef = value;
return this;
}
/**
* Gets the value of the prvsRef property.
*
* @return
* possible object is
* {@link AdditionalReference8 }
*
*/
public AdditionalReference8 getPrvsRef() {
return prvsRef;
}
/**
* Sets the value of the prvsRef property.
*
* @param value
* allowed object is
* {@link AdditionalReference8 }
*
*/
public SubscriptionOrderCancellationRequestV04 setPrvsRef(AdditionalReference8 value) {
this.prvsRef = value;
return this;
}
/**
* Gets the value of the mstrRef property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getMstrRef() {
return mstrRef;
}
/**
* Sets the value of the mstrRef property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public SubscriptionOrderCancellationRequestV04 setMstrRef(String value) {
this.mstrRef = value;
return this;
}
/**
* Gets the value of the ordrRefs 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 ordrRefs property.
*
*
* For example, to add a new item, do as follows:
*
* getOrdrRefs().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link InvestmentFundOrder9 }
*
*
* @return
* The value of the ordrRefs property.
*/
public List getOrdrRefs() {
if (ordrRefs == null) {
ordrRefs = new ArrayList<>();
}
return this.ordrRefs;
}
/**
* Gets the value of the cpyDtls property.
*
* @return
* possible object is
* {@link CopyInformation4 }
*
*/
public CopyInformation4 getCpyDtls() {
return cpyDtls;
}
/**
* Sets the value of the cpyDtls property.
*
* @param value
* allowed object is
* {@link CopyInformation4 }
*
*/
public SubscriptionOrderCancellationRequestV04 setCpyDtls(CopyInformation4 value) {
this.cpyDtls = value;
return this;
}
@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 ordrRefs list.
* @see #getOrdrRefs()
*
*/
public SubscriptionOrderCancellationRequestV04 addOrdrRefs(InvestmentFundOrder9 ordrRefs) {
getOrdrRefs().add(ordrRefs);
return this;
}
}