MockEquityPresentValueFn.java

/**
 * Copyright (C) 2013 - present by OpenGamma Inc. and the OpenGamma group of companies
 *
 * Please see distribution for license.
 */
package com.opengamma.sesame.example;

import com.opengamma.financial.security.equity.EquitySecurity;
import com.opengamma.sesame.Environment;
import com.opengamma.sesame.OutputNames;
import com.opengamma.sesame.function.Output;
import com.opengamma.util.result.Result;

/**
 * Function capable of providing present value for equities.
 */
public interface MockEquityPresentValueFn {

  /**
   * Calculates present value for equities.
   * 
   * @param security  the equity, not null
   * @return the present value, a failure result if unable to calculate
   */
  @Output(OutputNames.PRESENT_VALUE)
  Result<Double> presentValue(Environment env, EquitySecurity security);

}