net.finmath.smartcontract.settlement.Settlement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of finmath-smart-derivative-contract Show documentation
Project to support the implementation a of smart derivative contract.
There is a newer version: 1.0.6
Show newest version
package net.finmath.smartcontract.settlement;

import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlElementWrapper;
import jakarta.xml.bind.annotation.XmlRootElement;
import jakarta.xml.bind.annotation.XmlType;
import jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import net.finmath.smartcontract.model.MarketDataList;

import java.math.BigDecimal;
import java.time.ZonedDateTime;
import java.util.List;

/**
 * Describes the result of a single settlement as reported by the valuation oracle.
 * This data is intended to be archived (e.g. on the DLT).
 * 
 * The margin value is defined as the difference of two valuations: V(T1,M1) - V(T1,M0)
 * Here T1 is this settlements settlement time, M1 ist this settlements market data and M0 is the previous settlement market data.
 * 
 * For convenience the valuation oracle may also provide the value V(T2,M1) - the valuation at the next settlement time.
 *
 * @author Christian Fries
 */
//@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement
@XmlType(propOrder = {"tradeId", "settlementType", "currency", "marginValue",
		"marginLimits", "settlementTime", "settlementNPV", "settlementNPVPrevious",
		"settlementTimeNext", "settlementNPVNext", "marketData", "settlementInfos"})
public class Settlement {

	public enum SettlementType {
		INITIAL,
		REGULAR,
		TERMINAL
	}

	private String tradeId;

	private SettlementType settlementType;

	private String currency;

	private BigDecimal marginValue;

	private List marginLimits;

	/// V(T1,M1)

	private ZonedDateTime settlementTime;

	private BigDecimal settlementNPV;

	/// V(T1,M0)
	private BigDecimal settlementNPVPrevious;

	/// V(T2,M1) - indicative

	private ZonedDateTime settlementTimeNext;

	private BigDecimal settlementNPVNext;

	private MarketDataList marketData;

	/// Custom additional information (e.g. risk figures or szenario values)
	private List settlementInfos;

	/*
	 * Getter and setters
	 */

	public String getTradeId() {
		return tradeId;
	}

	public void setTradeId(String tradeId) {
		this.tradeId = tradeId;
	}

	public SettlementType getSettlementType() {
		return settlementType;
	}

	public void setSettlementType(SettlementType settlementType) {
		this.settlementType = settlementType;
	}

	public String getCurrency() {
		return currency;
	}

	public void setCurrency(String currency) {
		this.currency = currency;
	}

	public BigDecimal getMarginValue() {
		return marginValue;
	}

	public void setMarginValue(BigDecimal marginValue) {
		this.marginValue = marginValue;
	}

	public List getMarginLimits() {
		return marginLimits;
	}

	public void setMarginLimits(List marginLimits) {
		this.marginLimits = marginLimits;
	}

	@XmlJavaTypeAdapter(ZonedDateTimeAdapter.class)
	public ZonedDateTime getSettlementTime() {
		return settlementTime;
	}

	public void setSettlementTime(ZonedDateTime settlementTime) {
		this.settlementTime = settlementTime;
	}

	public BigDecimal getSettlementNPV() {
		return settlementNPV;
	}

	public void setSettlementNPV(BigDecimal settlementNPV) {
		this.settlementNPV = settlementNPV;
	}

	public BigDecimal getSettlementNPVPrevious() {
		return settlementNPVPrevious;
	}

	public void setSettlementNPVPrevious(BigDecimal settlementNPVPrevious) {
		this.settlementNPVPrevious = settlementNPVPrevious;
	}

	@XmlJavaTypeAdapter(ZonedDateTimeAdapter.class)
	public ZonedDateTime getSettlementTimeNext() {
		return settlementTimeNext;
	}

	public void setSettlementTimeNext(ZonedDateTime settlementTimeNext) {
		this.settlementTimeNext = settlementTimeNext;
	}

	public BigDecimal getSettlementNPVNext() {
		return settlementNPVNext;
	}

	public void setSettlementNPVNext(BigDecimal settlementNPVNext) {
		this.settlementNPVNext = settlementNPVNext;
	}
	public MarketDataList getMarketData() {
		return marketData;
	}

	public void setMarketData(MarketDataList marketData) {
		this.marketData = marketData;
	}

	@XmlElementWrapper(name="settlementInfos")
	@XmlElement(name = "settlementInfo")
	public List getSettlementInfos() {
		return settlementInfos;
	}

	public void setSettlementInfos(List settlementInfos) {
		this.settlementInfos = settlementInfos;
	}
}