com.opengamma.strata.product.index

Class OvernightFutureOptionTrade

java.lang.Object

com.opengamma.strata.product.index.OvernightFutureOptionTrade

All Implemented Interfaces:

CalculationTarget, Resolvable<ResolvedOvernightFutureOptionTrade>, PortfolioItem, ProductTrade, ResolvableTrade<ResolvedOvernightFutureOptionTrade>, SecuritizedProductPortfolioItem<OvernightFutureOption>, SecuritizedProductTrade<OvernightFutureOption>, SecurityQuantity, SecurityQuantityTrade, Trade, Serializable, org.joda.beans.Bean, org.joda.beans.ImmutableBean

public final class OvernightFutureOptionTrade
extends Object
implements SecuritizedProductTrade<OvernightFutureOption>, ResolvableTrade<ResolvedOvernightFutureOptionTrade>, org.joda.beans.ImmutableBean, Serializable

A trade representing an option on a futures contract based on an Overnight index.

A trade in an underlying OvernightFutureOption. The option is American, exercised at any point up to the exercise time. Both daily margin and upfront premium styles are handled.

Strata uses decimal prices for overnight future options in the trade model, pricers and market data. The decimal price is based on the decimal rate equivalent to the percentage. For example, an option price of 0.2 is related to a futures price of 99.32 that implies an interest rate of 0.68%. Strata represents the price of the future as 0.9932 and thus represents the price of the option as 0.002.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OvernightFutureOptionTrade.Builder The bean-builder for OvernightFutureOptionTrade.
static class	OvernightFutureOptionTrade.Meta The meta-bean for OvernightFutureOptionTrade.

Method Summary

Modifier and Type	Method and Description
static OvernightFutureOptionTrade.Builder	builder() Returns a builder used to create an instance of the bean.
boolean	equals(Object obj)
TradeInfo	getInfo() Gets the additional trade information, defaulted to an empty instance.
double	getPrice() Gets the price that was traded, in decimal form.
OvernightFutureOption	getProduct() Gets the option that was traded.
double	getQuantity() Gets the quantity that was traded.
int	hashCode()
static OvernightFutureOptionTrade.Meta	meta() The meta-bean for OvernightFutureOptionTrade.
OvernightFutureOptionTrade.Meta	metaBean()
ResolvedOvernightFutureOptionTrade	resolve(ReferenceData refData) Resolves this trade using the specified reference data.
PortfolioItemSummary	summarize() Summarizes the portfolio item.
OvernightFutureOptionTrade.Builder	toBuilder() Returns a builder that allows this bean to be mutated.
String	toString()
OvernightFutureOptionTrade	withInfo(PortfolioItemInfo info) Returns an instance with the specified info.
OvernightFutureOptionTrade	withPrice(double price) Returns an instance with the specified price.
OvernightFutureOptionTrade	withQuantity(double quantity) Returns an instance with the specified quantity.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.opengamma.strata.product.PortfolioItem

getId

Methods inherited from interface com.opengamma.strata.product.SecuritizedProductPortfolioItem

getCurrency, getSecurityId

Methods inherited from interface org.joda.beans.Bean

property, propertyNames

Method Detail

withInfo

public OvernightFutureOptionTrade withInfo(PortfolioItemInfo info)

Description copied from interface: SecuritizedProductTrade

Returns an instance with the specified info.

Specified by:

withInfo in interface PortfolioItem

Specified by:

withInfo in interface ProductTrade

Specified by:

withInfo in interface ResolvableTrade<ResolvedOvernightFutureOptionTrade>

Specified by:

withInfo in interface SecuritizedProductTrade<OvernightFutureOption>

Specified by:

withInfo in interface SecurityQuantityTrade

Specified by:

withInfo in interface Trade

Parameters:

info - the new info

Returns:

the instance with the specified info

withQuantity

public OvernightFutureOptionTrade withQuantity(double quantity)

Description copied from interface: SecuritizedProductTrade

Returns an instance with the specified quantity.

Specified by:

withQuantity in interface SecuritizedProductPortfolioItem<OvernightFutureOption>

Specified by:

withQuantity in interface SecuritizedProductTrade<OvernightFutureOption>

Specified by:

withQuantity in interface SecurityQuantityTrade

Parameters:

quantity - the new quantity

Returns:

the instance with the specified quantity

withPrice

public OvernightFutureOptionTrade withPrice(double price)

Description copied from interface: SecuritizedProductTrade

Returns an instance with the specified price.

Specified by:

withPrice in interface SecuritizedProductTrade<OvernightFutureOption>

Specified by:

withPrice in interface SecurityQuantityTrade

Parameters:

price - the new price

Returns:

the instance with the specified price

summarize

public PortfolioItemSummary summarize()

Description copied from interface: PortfolioItem

Summarizes the portfolio item.

This provides a summary, including a human readable description.

Specified by:

summarize in interface PortfolioItem

Specified by:

summarize in interface Trade

Returns:

the summary of the item

resolve

public ResolvedOvernightFutureOptionTrade resolve(ReferenceData refData)

Description copied from interface: ResolvableTrade

Resolves this trade using the specified reference data.

This converts this trade to the equivalent resolved form. All ReferenceDataId identifiers in this instance will be resolved. The resulting ResolvedTrade is optimized for pricing.

Resolved objects may be bound to data that changes over time, such as holiday calendars. If the data changes, such as the addition of a new holiday, the resolved form will not be updated. Care must be taken when placing the resolved form in a cache or persistence layer.

Specified by:

resolve in interface Resolvable<ResolvedOvernightFutureOptionTrade>

Specified by:

resolve in interface ResolvableTrade<ResolvedOvernightFutureOptionTrade>

Parameters:

refData - the reference data to use when resolving

Returns:

the resolved trade

meta

public static OvernightFutureOptionTrade.Meta meta()

The meta-bean for OvernightFutureOptionTrade.

Returns:

the meta-bean, not null

builder

public static OvernightFutureOptionTrade.Builder builder()

Returns a builder used to create an instance of the bean.

Returns:

the builder, not null

metaBean

public OvernightFutureOptionTrade.Meta metaBean()

Specified by:

metaBean in interface org.joda.beans.Bean

getInfo

public TradeInfo getInfo()

Gets the additional trade information, defaulted to an empty instance.

This allows additional information to be attached to the trade. The trade date is required when calling resolve(ReferenceData).

Specified by:

getInfo in interface PortfolioItem

Specified by:

getInfo in interface Trade

Returns:

the value of the property, not null

getProduct

public OvernightFutureOption getProduct()

Gets the option that was traded.

The product captures the contracted financial details of the trade.

Specified by:

getProduct in interface ProductTrade

Specified by:

getProduct in interface SecuritizedProductPortfolioItem<OvernightFutureOption>

Returns:

the value of the property, not null

getQuantity

public double getQuantity()

Gets the quantity that was traded.

This is the number of contracts that were traded. This will be positive if buying and negative if selling.

Specified by:

getQuantity in interface SecurityQuantity

Returns:

the value of the property

getPrice

public double getPrice()

Gets the price that was traded, in decimal form.

This is the price agreed when the trade occurred.

Strata uses decimal prices for overnight future options in the trade model, pricers and market data. The decimal price is based on the decimal rate equivalent to the percentage. For example, an option price of 0.2 is related to a futures price of 99.32 that implies an interest rate of 0.68%. Strata represents the price of the future as 0.9932 and thus represents the price of the option as 0.002.

Specified by:

getPrice in interface SecurityQuantityTrade

Returns:

the value of the property

toBuilder

public OvernightFutureOptionTrade.Builder toBuilder()

Returns a builder that allows this bean to be mutated.

Returns:

the mutable builder, not null

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object