OvernightFuturePosition (OpenGamma Strata Product)

java.lang.Object
- com.opengamma.strata.product.index.OvernightFuturePosition

All Implemented Interfaces:

CalculationTarget, Resolvable<ResolvedOvernightFutureTrade>, PortfolioItem, Position, SecuritizedProductPortfolioItem<OvernightFuture>, SecuritizedProductPosition<OvernightFuture>, SecurityQuantity, Serializable, org.joda.beans.Bean, org.joda.beans.ImmutableBean
```
public final class OvernightFuturePosition
extends Object
implements SecuritizedProductPosition<OvernightFuture>, Resolvable<ResolvedOvernightFutureTrade>, org.joda.beans.ImmutableBean, Serializable
```
A futures contract based on an Overnight index.
An Overnight rate future is a financial instrument that is based on the future value of an Overnight rate index interest rate. The profit or loss of an Overnight rate future is settled daily.
For example, the widely traded "30-Day Federal Funds futures contract" has a notional of 5 million USD, is based on the US Federal Funds Effective Rate 'USD-FED-FUND', expiring the last business day of each month.
Price
The price of an Overnight rate future is based on the interest rate of the underlying index. It is defined as (100 - percentRate).
Strata uses decimal prices for Overnight rate futures in the trade model, pricers and market data. The decimal price is based on the decimal rate equivalent to the percentage. For example, a price of 99.32 implies an interest rate of 0.68% which is represented in Strata by 0.9932.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`OvernightFuturePosition.Builder` The bean-builder for `OvernightFuturePosition`.
`static class`	`OvernightFuturePosition.Meta` The meta-bean for `OvernightFuturePosition`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static OvernightFuturePosition.Builder`	`builder()` Returns a builder used to create an instance of the bean.
`boolean`	`equals(Object obj)`
`Currency`	`getCurrency()` Gets the currency of the position.
`PositionInfo`	`getInfo()` Gets the additional position information, defaulted to an empty instance.
`double`	`getLongQuantity()` Gets the long quantity of the security.
`OvernightFuture`	`getProduct()` Gets the future that was traded.
`double`	`getQuantity()` Gets the net quantity of the security.
`SecurityId`	`getSecurityId()` Gets the identifier of the underlying security.
`double`	`getShortQuantity()` Gets the short quantity of the security.
`int`	`hashCode()`
`static OvernightFuturePosition.Meta`	`meta()` The meta-bean for `OvernightFuturePosition`.
`OvernightFuturePosition.Meta`	`metaBean()`
`static OvernightFuturePosition`	`ofLongShort(PositionInfo positionInfo, OvernightFuture product, double longQuantity, double shortQuantity)` Obtains an instance from position information, product, long quantity and short quantity.
`static OvernightFuturePosition`	`ofNet(PositionInfo positionInfo, OvernightFuture product, double netQuantity)` Obtains an instance from position information, product and net quantity.
`ResolvedOvernightFutureTrade`	`resolve(ReferenceData refData)`
`PortfolioItemSummary`	`summarize()` Summarizes the portfolio item.
`OvernightFuturePosition.Builder`	`toBuilder()` Returns a builder that allows this bean to be mutated.
`String`	`toString()`
`OvernightFuturePosition`	`withInfo(PortfolioItemInfo info)` Returns an instance with the specified info.
`OvernightFuturePosition`	`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 org.joda.beans.Bean
property, propertyNames

- Method Detail
  - ofNet
```
public static OvernightFuturePosition ofNet(PositionInfo positionInfo,
                                            OvernightFuture product,
                                            double netQuantity)
```
    Obtains an instance from position information, product and net quantity.
    The net quantity is the long quantity minus the short quantity, which may be negative. If the quantity is positive it is treated as a long quantity. Otherwise it is treated as a short quantity.
    
    Parameters:
    
    positionInfo - the position information
    
    product - the underlying product
    
    netQuantity - the net quantity of the underlying security
    
    Returns:
    
    the position
  - ofLongShort
```
public static OvernightFuturePosition ofLongShort(PositionInfo positionInfo,
                                                  OvernightFuture product,
                                                  double longQuantity,
                                                  double shortQuantity)
```
    Obtains an instance from position information, product, long quantity and short quantity.
    The long quantity and short quantity must be zero or positive, not negative. In many cases, only a long quantity or short quantity will be present with the other set to zero. However it is also possible for both to be non-zero, allowing long and short positions to be treated separately.
    
    Parameters:
    
    positionInfo - the position information
    
    product - the underlying product
    
    longQuantity - the long quantity of the underlying security
    
    shortQuantity - the short quantity of the underlying security
    
    Returns:
    
    the position
  - getSecurityId
```
public SecurityId getSecurityId()
```
    Description copied from interface: Position
    
    Gets the identifier of the underlying security.
    This identifier uniquely identifies the security within the system.
    
    Specified by:
    
    getSecurityId in interface Position
    
    Specified by:
    
    getSecurityId in interface SecuritizedProductPortfolioItem<OvernightFuture>
    
    Specified by:
    
    getSecurityId in interface SecuritizedProductPosition<OvernightFuture>
    
    Specified by:
    
    getSecurityId in interface SecurityQuantity
    
    Returns:
    
    the security identifier
  - getCurrency
```
public Currency getCurrency()
```
    Description copied from interface: SecuritizedProductPortfolioItem
    
    Gets the currency of the position.
    This is typically the same as the currency of the product.
    
    Specified by:
    
    getCurrency in interface SecuritizedProductPortfolioItem<OvernightFuture>
    
    Returns:
    
    the trading currency
  - getQuantity
```
public double getQuantity()
```
    Description copied from interface: Position
    
    Gets the net quantity of the security.
    This returns the net quantity of the underlying security. The result is positive if the net position is long and negative if the net position is short.
    
    Specified by:
    
    getQuantity in interface Position
    
    Specified by:
    
    getQuantity in interface SecurityQuantity
    
    Returns:
    
    the net quantity of the underlying security
  - withInfo
```
public OvernightFuturePosition withInfo(PortfolioItemInfo info)
```
    Description copied from interface: SecuritizedProductPosition
    
    Returns an instance with the specified info.
    
    Specified by:
    
    withInfo in interface PortfolioItem
    
    Specified by:
    
    withInfo in interface Position
    
    Specified by:
    
    withInfo in interface SecuritizedProductPosition<OvernightFuture>
    
    Parameters:
    
    info - the new info
    
    Returns:
    
    the instance with the specified info
  - withQuantity
```
public OvernightFuturePosition withQuantity(double quantity)
```
    Description copied from interface: SecuritizedProductPosition
    
    Returns an instance with the specified quantity.
    
    Specified by:
    
    withQuantity in interface Position
    
    Specified by:
    
    withQuantity in interface SecuritizedProductPortfolioItem<OvernightFuture>
    
    Specified by:
    
    withQuantity in interface SecuritizedProductPosition<OvernightFuture>
    
    Parameters:
    
    quantity - the new quantity
    
    Returns:
    
    the instance with the specified quantity
  - 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 Position
    
    Returns:
    
    the summary of the item
  - resolve
```
public ResolvedOvernightFutureTrade resolve(ReferenceData refData)
```
    Specified by:
    
    resolve in interface Resolvable<ResolvedOvernightFutureTrade>
  - meta
```
public static OvernightFuturePosition.Meta meta()
```
    The meta-bean for OvernightFuturePosition.
    
    Returns:
    
    the meta-bean, not null
  - builder
```
public static OvernightFuturePosition.Builder builder()
```
    Returns a builder used to create an instance of the bean.
    
    Returns:
    
    the builder, not null
  - metaBean
```
public OvernightFuturePosition.Meta metaBean()
```
    Specified by:
    
    metaBean in interface org.joda.beans.Bean
  - getInfo
```
public PositionInfo getInfo()
```
    Gets the additional position information, defaulted to an empty instance.
    This allows additional information to be attached to the position.
    
    Specified by:
    
    getInfo in interface PortfolioItem
    
    Specified by:
    
    getInfo in interface Position
    
    Returns:
    
    the value of the property, not null
  - getProduct
```
public OvernightFuture getProduct()
```
    Gets the future that was traded.
    The product captures the contracted financial details.
    
    Specified by:
    
    getProduct in interface SecuritizedProductPortfolioItem<OvernightFuture>
    
    Returns:
    
    the value of the property, not null
  - getLongQuantity
```
public double getLongQuantity()
```
    Gets the long quantity of the security.
    This is the quantity of the underlying security that is held. The quantity cannot be negative, as that would imply short selling.
    
    Returns:
    
    the value of the property
  - getShortQuantity
```
public double getShortQuantity()
```
    Gets the short quantity of the security.
    This is the quantity of the underlying security that has been short sold. The quantity cannot be negative, as that would imply the position is long.
    
    Returns:
    
    the value of the property
  - toBuilder
```
public OvernightFuturePosition.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

Copyright 2009-Present by OpenGamma Inc. and individual contributors
Apache v2 licensed
Additional documentation can be found at strata.opengamma.io.

Class OvernightFuturePosition

Price

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.joda.beans.Bean

Method Detail

ofNet

ofLongShort

getSecurityId

getCurrency

getQuantity

withInfo

withQuantity

summarize

resolve

meta

builder

metaBean

getInfo

getProduct

getLongQuantity

getShortQuantity

toBuilder

equals

hashCode

toString