com.prowidesoftware.swift.model.mx.dic.CrossOrder Maven / Gradle / Ivy
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 executing party, eg, a broker, wishing to take the other side of an order and cross with the instructing party, eg, an investment manager, sends a CrossOrder message to a point of execution such as an exchange.
* Usage
* The CrossOrder contains two order sides, ie, an order to buy and an order to sell. For many markets the Order message does not provide enough information about the counterparties of a trade to meet regulatory and post-trade requirements. When additional information regarding the counterparty to cross the trade is required, the CrossOrder message is to be used.
* Four types of cross trades have been identified:
* - Cross order that is executed completely or not at all. Both sides are treated in the same manner. This is equivalent to a Fill or Kill, where the cross order meets the crossing criteria within the market and is executed or rejected.
* - Cross order that is executed partially and the rest is cancelled. One side is fully executed, the other side is partially executed with the remainder being cancelled. This is equivalent to an Immediate or Cancel on the other side. The Prioritisation Indicator is used to indicate which side should fully execute in this scenario.
* - Cross order that is partially executed with the unfilled portions remaining active. One side of the cross order is fully executed as indicated in the Prioritisation Indicator, but the unfilled portion remains active.
* - Cross order that is executed with existing orders with the same price. In the case other orders exist with the same price, the quantity of the cross order is executed against the existing orders and quotes, the remainder of the cross is executed against the other side of the cross. The two sides potentially have different quantities. The Prioritisation Indicator is used to indicate which side of the cross order will be executed against the existing market.
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "CrossOrder", propOrder = {
"id",
"refs",
"ordrDtls",
"ordrQtyDtls",
"ordrParamsDtls",
"finInstrmDtls",
"finInstrmAttrbts",
"stiptns",
"undrlygFinInstrm",
"undrlygFinInstrmAttrbts",
"undrlygStiptns",
"legGrpDtls",
"sprdAndBchmkCrvDtls",
"yldDtls",
"exctnInstrsDtls",
"strtgyParamsDtls",
"tradgSsnDtls",
"trggrgInstrsDtls",
"dscrtnInstrsDtls",
"dispInstrDtls",
"tradgPties",
"cshPties",
"rcvgPties",
"dlvrgPties",
"othrBizPties",
"amtsDtls"
})
public class CrossOrder {
@XmlElement(name = "Id", required = true)
protected DocumentIdentification11 id;
@XmlElement(name = "Refs", required = true)
protected Reference11 refs;
@XmlElement(name = "OrdrDtls", required = true)
protected CrossOrder1 ordrDtls;
@XmlElement(name = "OrdrQtyDtls")
protected OrderQuantity3 ordrQtyDtls;
@XmlElement(name = "OrdrParamsDtls")
protected OrderParameters1 ordrParamsDtls;
@XmlElement(name = "FinInstrmDtls", required = true)
protected SecurityIdentification7 finInstrmDtls;
@XmlElement(name = "FinInstrmAttrbts")
protected FinancialInstrumentAttributes1 finInstrmAttrbts;
@XmlElement(name = "Stiptns")
protected FinancialInstrumentStipulations stiptns;
@XmlElement(name = "UndrlygFinInstrm")
protected List undrlygFinInstrm;
@XmlElement(name = "UndrlygFinInstrmAttrbts")
protected List undrlygFinInstrmAttrbts;
@XmlElement(name = "UndrlygStiptns")
protected List undrlygStiptns;
@XmlElement(name = "LegGrpDtls")
protected List legGrpDtls;
@XmlElement(name = "SprdAndBchmkCrvDtls")
protected BenchmarkCurve1 sprdAndBchmkCrvDtls;
@XmlElement(name = "YldDtls")
protected YieldCalculation1 yldDtls;
@XmlElement(name = "ExctnInstrsDtls")
protected List exctnInstrsDtls;
@XmlElement(name = "StrtgyParamsDtls")
protected List strtgyParamsDtls;
@XmlElement(name = "TradgSsnDtls")
protected TradingSession1 tradgSsnDtls;
@XmlElement(name = "TrggrgInstrsDtls", required = true)
protected TriggeringInstructions trggrgInstrsDtls;
@XmlElement(name = "DscrtnInstrsDtls")
protected DiscretionInstructions1 dscrtnInstrsDtls;
@XmlElement(name = "DispInstrDtls", required = true)
protected DisplayInstruction1 dispInstrDtls;
@XmlElement(name = "TradgPties")
protected List tradgPties;
@XmlElement(name = "CshPties")
protected CashParties1 cshPties;
@XmlElement(name = "RcvgPties")
protected SettlementParties3 rcvgPties;
@XmlElement(name = "DlvrgPties")
protected SettlementParties3 dlvrgPties;
@XmlElement(name = "OthrBizPties")
protected OtherParties1 othrBizPties;
@XmlElement(name = "AmtsDtls")
protected List amtsDtls;
/**
* Gets the value of the id property.
*
* @return
* possible object is
* {@link DocumentIdentification11 }
*
*/
public DocumentIdentification11 getId() {
return id;
}
/**
* Sets the value of the id property.
*
* @param value
* allowed object is
* {@link DocumentIdentification11 }
*
*/
public CrossOrder setId(DocumentIdentification11 value) {
this.id = value;
return this;
}
/**
* Gets the value of the refs property.
*
* @return
* possible object is
* {@link Reference11 }
*
*/
public Reference11 getRefs() {
return refs;
}
/**
* Sets the value of the refs property.
*
* @param value
* allowed object is
* {@link Reference11 }
*
*/
public CrossOrder setRefs(Reference11 value) {
this.refs = value;
return this;
}
/**
* Gets the value of the ordrDtls property.
*
* @return
* possible object is
* {@link CrossOrder1 }
*
*/
public CrossOrder1 getOrdrDtls() {
return ordrDtls;
}
/**
* Sets the value of the ordrDtls property.
*
* @param value
* allowed object is
* {@link CrossOrder1 }
*
*/
public CrossOrder setOrdrDtls(CrossOrder1 value) {
this.ordrDtls = value;
return this;
}
/**
* Gets the value of the ordrQtyDtls property.
*
* @return
* possible object is
* {@link OrderQuantity3 }
*
*/
public OrderQuantity3 getOrdrQtyDtls() {
return ordrQtyDtls;
}
/**
* Sets the value of the ordrQtyDtls property.
*
* @param value
* allowed object is
* {@link OrderQuantity3 }
*
*/
public CrossOrder setOrdrQtyDtls(OrderQuantity3 value) {
this.ordrQtyDtls = value;
return this;
}
/**
* Gets the value of the ordrParamsDtls property.
*
* @return
* possible object is
* {@link OrderParameters1 }
*
*/
public OrderParameters1 getOrdrParamsDtls() {
return ordrParamsDtls;
}
/**
* Sets the value of the ordrParamsDtls property.
*
* @param value
* allowed object is
* {@link OrderParameters1 }
*
*/
public CrossOrder setOrdrParamsDtls(OrderParameters1 value) {
this.ordrParamsDtls = value;
return this;
}
/**
* Gets the value of the finInstrmDtls property.
*
* @return
* possible object is
* {@link SecurityIdentification7 }
*
*/
public SecurityIdentification7 getFinInstrmDtls() {
return finInstrmDtls;
}
/**
* Sets the value of the finInstrmDtls property.
*
* @param value
* allowed object is
* {@link SecurityIdentification7 }
*
*/
public CrossOrder setFinInstrmDtls(SecurityIdentification7 value) {
this.finInstrmDtls = value;
return this;
}
/**
* Gets the value of the finInstrmAttrbts property.
*
* @return
* possible object is
* {@link FinancialInstrumentAttributes1 }
*
*/
public FinancialInstrumentAttributes1 getFinInstrmAttrbts() {
return finInstrmAttrbts;
}
/**
* Sets the value of the finInstrmAttrbts property.
*
* @param value
* allowed object is
* {@link FinancialInstrumentAttributes1 }
*
*/
public CrossOrder setFinInstrmAttrbts(FinancialInstrumentAttributes1 value) {
this.finInstrmAttrbts = value;
return this;
}
/**
* Gets the value of the stiptns property.
*
* @return
* possible object is
* {@link FinancialInstrumentStipulations }
*
*/
public FinancialInstrumentStipulations getStiptns() {
return stiptns;
}
/**
* Sets the value of the stiptns property.
*
* @param value
* allowed object is
* {@link FinancialInstrumentStipulations }
*
*/
public CrossOrder setStiptns(FinancialInstrumentStipulations value) {
this.stiptns = value;
return this;
}
/**
* Gets the value of the undrlygFinInstrm 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 undrlygFinInstrm property.
*
*
* For example, to add a new item, do as follows:
*
* getUndrlygFinInstrm().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link SecurityIdentification7 }
*
*
* @return
* The value of the undrlygFinInstrm property.
*/
public List getUndrlygFinInstrm() {
if (undrlygFinInstrm == null) {
undrlygFinInstrm = new ArrayList<>();
}
return this.undrlygFinInstrm;
}
/**
* Gets the value of the undrlygFinInstrmAttrbts 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 undrlygFinInstrmAttrbts property.
*
*
* For example, to add a new item, do as follows:
*
* getUndrlygFinInstrmAttrbts().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link FinancialInstrumentAttributes1 }
*
*
* @return
* The value of the undrlygFinInstrmAttrbts property.
*/
public List getUndrlygFinInstrmAttrbts() {
if (undrlygFinInstrmAttrbts == null) {
undrlygFinInstrmAttrbts = new ArrayList<>();
}
return this.undrlygFinInstrmAttrbts;
}
/**
* Gets the value of the undrlygStiptns 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 undrlygStiptns property.
*
*
* For example, to add a new item, do as follows:
*
* getUndrlygStiptns().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link FinancialInstrumentStipulations }
*
*
* @return
* The value of the undrlygStiptns property.
*/
public List getUndrlygStiptns() {
if (undrlygStiptns == null) {
undrlygStiptns = new ArrayList<>();
}
return this.undrlygStiptns;
}
/**
* Gets the value of the legGrpDtls 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 legGrpDtls property.
*
*
* For example, to add a new item, do as follows:
*
* getLegGrpDtls().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link InstrumentLeg2 }
*
*
* @return
* The value of the legGrpDtls property.
*/
public List getLegGrpDtls() {
if (legGrpDtls == null) {
legGrpDtls = new ArrayList<>();
}
return this.legGrpDtls;
}
/**
* Gets the value of the sprdAndBchmkCrvDtls property.
*
* @return
* possible object is
* {@link BenchmarkCurve1 }
*
*/
public BenchmarkCurve1 getSprdAndBchmkCrvDtls() {
return sprdAndBchmkCrvDtls;
}
/**
* Sets the value of the sprdAndBchmkCrvDtls property.
*
* @param value
* allowed object is
* {@link BenchmarkCurve1 }
*
*/
public CrossOrder setSprdAndBchmkCrvDtls(BenchmarkCurve1 value) {
this.sprdAndBchmkCrvDtls = value;
return this;
}
/**
* Gets the value of the yldDtls property.
*
* @return
* possible object is
* {@link YieldCalculation1 }
*
*/
public YieldCalculation1 getYldDtls() {
return yldDtls;
}
/**
* Sets the value of the yldDtls property.
*
* @param value
* allowed object is
* {@link YieldCalculation1 }
*
*/
public CrossOrder setYldDtls(YieldCalculation1 value) {
this.yldDtls = value;
return this;
}
/**
* Gets the value of the exctnInstrsDtls 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 exctnInstrsDtls property.
*
*
* For example, to add a new item, do as follows:
*
* getExctnInstrsDtls().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link SecuritiesExecutionInstructions1 }
*
*
* @return
* The value of the exctnInstrsDtls property.
*/
public List getExctnInstrsDtls() {
if (exctnInstrsDtls == null) {
exctnInstrsDtls = new ArrayList<>();
}
return this.exctnInstrsDtls;
}
/**
* Gets the value of the strtgyParamsDtls 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 strtgyParamsDtls property.
*
*
* For example, to add a new item, do as follows:
*
* getStrtgyParamsDtls().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link StrategyParameters1 }
*
*
* @return
* The value of the strtgyParamsDtls property.
*/
public List getStrtgyParamsDtls() {
if (strtgyParamsDtls == null) {
strtgyParamsDtls = new ArrayList<>();
}
return this.strtgyParamsDtls;
}
/**
* Gets the value of the tradgSsnDtls property.
*
* @return
* possible object is
* {@link TradingSession1 }
*
*/
public TradingSession1 getTradgSsnDtls() {
return tradgSsnDtls;
}
/**
* Sets the value of the tradgSsnDtls property.
*
* @param value
* allowed object is
* {@link TradingSession1 }
*
*/
public CrossOrder setTradgSsnDtls(TradingSession1 value) {
this.tradgSsnDtls = value;
return this;
}
/**
* Gets the value of the trggrgInstrsDtls property.
*
* @return
* possible object is
* {@link TriggeringInstructions }
*
*/
public TriggeringInstructions getTrggrgInstrsDtls() {
return trggrgInstrsDtls;
}
/**
* Sets the value of the trggrgInstrsDtls property.
*
* @param value
* allowed object is
* {@link TriggeringInstructions }
*
*/
public CrossOrder setTrggrgInstrsDtls(TriggeringInstructions value) {
this.trggrgInstrsDtls = value;
return this;
}
/**
* Gets the value of the dscrtnInstrsDtls property.
*
* @return
* possible object is
* {@link DiscretionInstructions1 }
*
*/
public DiscretionInstructions1 getDscrtnInstrsDtls() {
return dscrtnInstrsDtls;
}
/**
* Sets the value of the dscrtnInstrsDtls property.
*
* @param value
* allowed object is
* {@link DiscretionInstructions1 }
*
*/
public CrossOrder setDscrtnInstrsDtls(DiscretionInstructions1 value) {
this.dscrtnInstrsDtls = value;
return this;
}
/**
* Gets the value of the dispInstrDtls property.
*
* @return
* possible object is
* {@link DisplayInstruction1 }
*
*/
public DisplayInstruction1 getDispInstrDtls() {
return dispInstrDtls;
}
/**
* Sets the value of the dispInstrDtls property.
*
* @param value
* allowed object is
* {@link DisplayInstruction1 }
*
*/
public CrossOrder setDispInstrDtls(DisplayInstruction1 value) {
this.dispInstrDtls = value;
return this;
}
/**
* Gets the value of the tradgPties 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 tradgPties property.
*
*
* For example, to add a new item, do as follows:
*
* getTradgPties().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link Intermediary14 }
*
*
* @return
* The value of the tradgPties property.
*/
public List getTradgPties() {
if (tradgPties == null) {
tradgPties = new ArrayList<>();
}
return this.tradgPties;
}
/**
* Gets the value of the cshPties property.
*
* @return
* possible object is
* {@link CashParties1 }
*
*/
public CashParties1 getCshPties() {
return cshPties;
}
/**
* Sets the value of the cshPties property.
*
* @param value
* allowed object is
* {@link CashParties1 }
*
*/
public CrossOrder setCshPties(CashParties1 value) {
this.cshPties = value;
return this;
}
/**
* Gets the value of the rcvgPties property.
*
* @return
* possible object is
* {@link SettlementParties3 }
*
*/
public SettlementParties3 getRcvgPties() {
return rcvgPties;
}
/**
* Sets the value of the rcvgPties property.
*
* @param value
* allowed object is
* {@link SettlementParties3 }
*
*/
public CrossOrder setRcvgPties(SettlementParties3 value) {
this.rcvgPties = value;
return this;
}
/**
* Gets the value of the dlvrgPties property.
*
* @return
* possible object is
* {@link SettlementParties3 }
*
*/
public SettlementParties3 getDlvrgPties() {
return dlvrgPties;
}
/**
* Sets the value of the dlvrgPties property.
*
* @param value
* allowed object is
* {@link SettlementParties3 }
*
*/
public CrossOrder setDlvrgPties(SettlementParties3 value) {
this.dlvrgPties = value;
return this;
}
/**
* Gets the value of the othrBizPties property.
*
* @return
* possible object is
* {@link OtherParties1 }
*
*/
public OtherParties1 getOthrBizPties() {
return othrBizPties;
}
/**
* Sets the value of the othrBizPties property.
*
* @param value
* allowed object is
* {@link OtherParties1 }
*
*/
public CrossOrder setOthrBizPties(OtherParties1 value) {
this.othrBizPties = value;
return this;
}
/**
* Gets the value of the amtsDtls 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 amtsDtls property.
*
*
* For example, to add a new item, do as follows:
*
* getAmtsDtls().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link OtherAmounts1 }
*
*
* @return
* The value of the amtsDtls property.
*/
public List getAmtsDtls() {
if (amtsDtls == null) {
amtsDtls = new ArrayList<>();
}
return this.amtsDtls;
}
@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 undrlygFinInstrm list.
* @see #getUndrlygFinInstrm()
*
*/
public CrossOrder addUndrlygFinInstrm(SecurityIdentification7 undrlygFinInstrm) {
getUndrlygFinInstrm().add(undrlygFinInstrm);
return this;
}
/**
* Adds a new item to the undrlygFinInstrmAttrbts list.
* @see #getUndrlygFinInstrmAttrbts()
*
*/
public CrossOrder addUndrlygFinInstrmAttrbts(FinancialInstrumentAttributes1 undrlygFinInstrmAttrbts) {
getUndrlygFinInstrmAttrbts().add(undrlygFinInstrmAttrbts);
return this;
}
/**
* Adds a new item to the undrlygStiptns list.
* @see #getUndrlygStiptns()
*
*/
public CrossOrder addUndrlygStiptns(FinancialInstrumentStipulations undrlygStiptns) {
getUndrlygStiptns().add(undrlygStiptns);
return this;
}
/**
* Adds a new item to the legGrpDtls list.
* @see #getLegGrpDtls()
*
*/
public CrossOrder addLegGrpDtls(InstrumentLeg2 legGrpDtls) {
getLegGrpDtls().add(legGrpDtls);
return this;
}
/**
* Adds a new item to the exctnInstrsDtls list.
* @see #getExctnInstrsDtls()
*
*/
public CrossOrder addExctnInstrsDtls(SecuritiesExecutionInstructions1 exctnInstrsDtls) {
getExctnInstrsDtls().add(exctnInstrsDtls);
return this;
}
/**
* Adds a new item to the strtgyParamsDtls list.
* @see #getStrtgyParamsDtls()
*
*/
public CrossOrder addStrtgyParamsDtls(StrategyParameters1 strtgyParamsDtls) {
getStrtgyParamsDtls().add(strtgyParamsDtls);
return this;
}
/**
* Adds a new item to the tradgPties list.
* @see #getTradgPties()
*
*/
public CrossOrder addTradgPties(Intermediary14 tradgPties) {
getTradgPties().add(tradgPties);
return this;
}
/**
* Adds a new item to the amtsDtls list.
* @see #getAmtsDtls()
*
*/
public CrossOrder addAmtsDtls(OtherAmounts1 amtsDtls) {
getAmtsDtls().add(amtsDtls);
return this;
}
}