com.opengamma.strata.product

Class SecurityTrade

java.lang.Object

com.opengamma.strata.product.SecurityTrade

All Implemented Interfaces:

CalculationTarget, ResolvableCalculationTarget, PortfolioItem, ResolvableSecurityTrade, SecurityQuantity, SecurityQuantityTrade, Trade, Serializable, org.joda.beans.Bean, org.joda.beans.ImmutableBean

public final class SecurityTrade
extends Object
implements ResolvableSecurityTrade, org.joda.beans.ImmutableBean, Serializable

A trade representing the purchase or sale of a security, where the security is referenced by identifier.

This trade represents a trade in a security, defined by a quantity and price. The security is referenced using SecurityId. The identifier may be looked up in ReferenceData.

The reference may be to any kind of security, including equities, bonds and exchange traded derivatives (ETD).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static SecurityTrade.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 agreed when the trade occurred.
double	getQuantity() Gets the quantity that was traded.
SecurityId	getSecurityId() Gets the identifier of the security that was traded.
int	hashCode()
static SecurityTrade.Meta	meta() The meta-bean for SecurityTrade.
SecurityTrade.Meta	metaBean()
static SecurityTrade	of(TradeInfo tradeInfo, SecurityId securityId, double quantity, double price) Obtains an instance from trade information, identifier, quantity and price.
PortfolioItemSummary	summarize() Summarizes the portfolio item.
SecurityTrade.Builder	toBuilder() Returns a builder that allows this bean to be mutated.
String	toString()
SecurityTrade	withInfo(PortfolioItemInfo info) Returns an instance with the specified info.
SecurityTrade	withPrice(double price) Returns an instance with the specified price.
SecurityTrade	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.ResolvableSecurityTrade

resolveTarget

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

getId

Methods inherited from interface org.joda.beans.Bean

property, propertyNames

Method Detail

of

public static SecurityTrade of(TradeInfo tradeInfo,
                               SecurityId securityId,
                               double quantity,
                               double price)

Obtains an instance from trade information, identifier, quantity and price.

Parameters:

tradeInfo - the trade information

securityId - the identifier of the underlying security

quantity - the quantity that was traded

price - the price that was traded

Returns:

the trade

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

withInfo

public SecurityTrade withInfo(PortfolioItemInfo info)

Description copied from interface: ResolvableSecurityTrade

Returns an instance with the specified info.

Specified by:

withInfo in interface PortfolioItem

Specified by:

withInfo in interface ResolvableSecurityTrade

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 SecurityTrade withQuantity(double quantity)

Description copied from interface: ResolvableSecurityTrade

Returns an instance with the specified quantity.

Specified by:

withQuantity in interface ResolvableSecurityTrade

Specified by:

withQuantity in interface SecurityQuantityTrade

Parameters:

quantity - the new quantity

Returns:

the instance with the specified quantity

withPrice

public SecurityTrade withPrice(double price)

Description copied from interface: ResolvableSecurityTrade

Returns an instance with the specified price.

Specified by:

withPrice in interface ResolvableSecurityTrade

Specified by:

withPrice in interface SecurityQuantityTrade

Parameters:

price - the new price

Returns:

the instance with the specified price

meta

public static SecurityTrade.Meta meta()

The meta-bean for SecurityTrade.

Returns:

the meta-bean, not null

builder

public static SecurityTrade.Builder builder()

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

Returns:

the builder, not null

metaBean

public SecurityTrade.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.

Specified by:

getInfo in interface PortfolioItem

Specified by:

getInfo in interface Trade

Returns:

the value of the property, not null

getSecurityId

public SecurityId getSecurityId()

Gets the identifier of the security that was traded.

This identifier uniquely identifies the security within the system.

Specified by:

getSecurityId in interface SecurityQuantity

Returns:

the value of the property, not null

getQuantity

public double getQuantity()

Gets the quantity that was 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 agreed when the trade occurred.

This is the price agreed when the trade occurred.

Specified by:

getPrice in interface SecurityQuantityTrade

Returns:

the value of the property

toBuilder

public SecurityTrade.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