Package com.opengamma.strata.product

Interface SecuritizedProductPortfolioItem<P extends SecuritizedProduct>

Type Parameters:

P - the type of securitized product

All Superinterfaces:

CalculationTarget, PortfolioItem, SecurityQuantity

All Known Subinterfaces:

SecuritizedProductPosition<P>, SecuritizedProductTrade<P>

All Known Implementing Classes:

BillPosition, BillTrade, BondFutureOptionPosition, BondFutureOptionTrade, BondFuturePosition, BondFutureTrade, CapitalIndexedBondPosition, CapitalIndexedBondTrade, DsfPosition, DsfTrade, EtdFuturePosition, EtdOptionPosition, FixedCouponBondPosition, FixedCouponBondTrade, GenericSecurityPosition, GenericSecurityTrade, IborFutureOptionPosition, IborFutureOptionTrade, IborFuturePosition, IborFutureTrade, OvernightFuturePosition, OvernightFutureTrade

public interface SecuritizedProductPortfolioItem<P extends SecuritizedProduct>
extends PortfolioItem, SecurityQuantity

A trade that is directly based on a securitized product.

This defines a trade or position in a securitized product. A securitized product contains the structure of a financial instrument that is traded as a Security. See SecuritizedProduct to understand the difference between a security and a securitized product.

When trading securities, the standard trade type is SecurityTrade and the standard position type is SecurityPosition. That trade type relies on securities being looked up in ReferenceData. One use for trade types that implement SecuritizedProductTrade is to price and hold trades without needing to populate reference data, because the securitized product representation completely models the trade.

Implementations of this interface must be immutable beans.

Method Summary

Modifier and Type	Method	Description
default Currency	getCurrency()	Gets the currency of the position.
P	getProduct()	Gets the product of the security that was traded.
default SecurityId	getSecurityId()	Gets the security identifier.
SecuritizedProductPortfolioItem<P>	withQuantity(double quantity)	Returns an instance with the specified quantity.

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

getId, getInfo, summarize, withInfo

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

getQuantity

Method Detail

getProduct

P getProduct()

Gets the product of the security that was traded.

Returns:

the product

getCurrency

default Currency getCurrency()

Gets the currency of the position.

This is typically the same as the currency of the product.

Returns:

the trading currency

getSecurityId

default SecurityId getSecurityId()

Description copied from interface: SecurityQuantity

Gets the security identifier.

This identifier uniquely identifies the security within the system.

Specified by:

getSecurityId in interface SecurityQuantity

Returns:

the security identifier

withQuantity

SecuritizedProductPortfolioItem<P> withQuantity(double quantity)

Returns an instance with the specified quantity.

Parameters:

quantity - the new quantity

Returns:

the instance with the specified quantity