com.opengamma.strata.product.etd.EtdTrade Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of strata-product Show documentation

Domain objects describing trades and products in financial markets

There is a newer version: 2.12.48

/*
 * Copyright (C) 2020 - present by OpenGamma Inc. and the OpenGamma group of companies
 *
 * Please see distribution for license.
 */
package com.opengamma.strata.product.etd;

import com.opengamma.strata.basics.currency.Currency;
import com.opengamma.strata.product.SecurityId;
import com.opengamma.strata.product.SecurityQuantityTrade;

/**
 * A trade in an exchange traded derivative (ETD).
 * 
 * This represents a trade based on quantity and price for an {@link EtdSecurity}.
 */
public interface EtdTrade extends SecurityQuantityTrade {

  /**
   * Gets the currency of the trade.
   * 

   * This is the currency of the underlying security.
   *
   * @return the trading currency
   */
  public default Currency getCurrency() {
    return getSecurity().getCurrency();
  }

  /**
   * Gets the type of the contract that was traded.
   * 

   * This is the type of the underlying security - future or option.
   *
   * @return the type, future or option
   */
  public default EtdType getType() {
    return getSecurity().getType();
  }

  /**
   * Gets the security identifier of the trade.
   * 
   * This identifier uniquely identifies the security within the system.
   *
   * @return the security identifier
   */
  @Override
  public default SecurityId getSecurityId() {
    return getSecurity().getSecurityId();
  }

  /**
   * Gets the underlying ETD security.
   *
   * @return the ETD security
   */
  public abstract EtdSecurity getSecurity();
}