com.opengamma.strata.product

Interface PortfolioItem

All Superinterfaces:

CalculationTarget

All Known Subinterfaces:

EtdPosition, EtdTrade, FxOptionTrade, FxTrade, Position, ProductTrade, ResolvableSecurityPosition, ResolvableSecurityTrade, ResolvableTrade<T>, SecuritizedProductPortfolioItem<P>, SecuritizedProductPosition<P>, SecuritizedProductTrade<P>, SecurityQuantityTrade, Trade

All Known Implementing Classes:

BillPosition, BillTrade, BondFutureOptionPosition, BondFutureOptionTrade, BondFuturePosition, BondFutureTrade, BulletPaymentTrade, CapitalIndexedBondPosition, CapitalIndexedBondTrade, CdsCalibrationTrade, CdsIndexCalibrationTrade, CdsIndexTrade, CdsTrade, CmsTrade, DsfPosition, DsfTrade, EtdFuturePosition, EtdFutureTrade, EtdOptionPosition, EtdOptionTrade, FixedCouponBondPosition, FixedCouponBondTrade, FraTrade, FxNdfTrade, FxSingleBarrierOptionTrade, FxSingleTrade, FxSwapTrade, FxVanillaOptionTrade, GenericSecurityPosition, GenericSecurityTrade, IborCapFloorTrade, IborFixingDepositTrade, IborFutureOptionPosition, IborFutureOptionTrade, IborFuturePosition, IborFutureTrade, OvernightFutureOptionPosition, OvernightFutureOptionTrade, OvernightFuturePosition, OvernightFutureTrade, SecurityPosition, SecurityTrade, SwaptionTrade, SwapTrade, TermDepositTrade

public interface PortfolioItem
extends CalculationTarget

An item in a portfolio.

This represents a single item in a portfolio. Typically a portfolio will consist of trades and positions.

Implementations of this interface must be immutable beans.

Method Summary

Modifier and Type	Method and Description
default Optional<StandardId>	getId() Gets the primary identifier for the portfolio item, optional.
PortfolioItemInfo	getInfo() Gets the additional information about the portfolio item.
PortfolioItemSummary	summarize() Summarizes the portfolio item.
default PortfolioItem	withInfo(PortfolioItemInfo info) Returns an instance with the specified info.

Method Detail

getInfo

PortfolioItemInfo getInfo()

Gets the additional information about the portfolio item.

Returns:

the additional information

getId

default Optional<StandardId> getId()

Gets the primary identifier for the portfolio item, optional.

The identifier is used to identify the portfolio item. It will typically be an identifier in an external data system.

A portfolio item may have multiple active identifiers. Any identifier may be chosen here. Certain uses of the identifier, such as storage in a database, require that the identifier does not change over time, and this should be considered best practice.

Returns:

the identifier, optional

withInfo

default PortfolioItem withInfo(PortfolioItemInfo info)

Returns an instance with the specified info.

Parameters:

info - the new info

Returns:

the instance with the specified info

summarize

PortfolioItemSummary summarize()

Summarizes the portfolio item.

This provides a summary, including a human readable description.

Returns:

the summary of the item