org.marketcetera.trade.pnl.Position Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of trade-api Show documentation
The newest version!
//
// this file is automatically generated
//
package org.marketcetera.trade.pnl;

/* $License$ */

/**
 * Describes position of a given instrument owned by a given user at a given point in time.
 *
 * @author Colin DuPlantis
 * @version $Id$
 * @since $Release$
 */
public interface Position
        extends org.marketcetera.trade.HasInstrument,org.marketcetera.admin.HasUser
{
    /**
     * Get the position value.
     *
     * @return a java.math.BigDecimal value
     */
    java.math.BigDecimal getPosition();
    /**
     * Set the position value.
     *
     * @param inPosition a java.math.BigDecimal value
     */
    void setPosition(java.math.BigDecimal inPosition);
    /**
     * Get the effectiveDate value.
     *
     * @return a java.util.Date value
     */
    java.util.Date getEffectiveDate();
    /**
     * Set the effectiveDate value.
     *
     * @param inEffectiveDate a java.util.Date value
     */
    void setEffectiveDate(java.util.Date inEffectiveDate);
    /**
     * Get the weightedAverageCost value.
     *
     * @return a java.math.BigDecimal value
     */
    java.math.BigDecimal getWeightedAverageCost();
    /**
     * Set the weightedAverageCost value.
     *
     * @param inWeightedAverageCost a java.math.BigDecimal value
     */
    void setWeightedAverageCost(java.math.BigDecimal inWeightedAverageCost);
    /**
     * Get the realizedGain value.
     *
     * @return a java.math.BigDecimal value
     */
    java.math.BigDecimal getRealizedGain();
    /**
     * Set the realizedGain value.
     *
     * @param inRealizedGain a java.math.BigDecimal value
     */
    void setRealizedGain(java.math.BigDecimal inRealizedGain);
    /**
     * Get the unrealizedGain value.
     *
     * @return a java.math.BigDecimal value
     */
    java.math.BigDecimal getUnrealizedGain();
    /**
     * Set the unrealizedGain value.
     *
     * @param inUnrealizedGain a java.math.BigDecimal value
     */
    void setUnrealizedGain(java.math.BigDecimal inUnrealizedGain);
}