/*
 * @author : Umesh Kulkarni

 * @version 1.0
 *
 * Development Environment : Oracle9i JDeveloper
 *
 * Name of the File : StockRate.java
 *
 * Creation / Modification History

 *    Umesh           26-Apr-2002        Created
 *
*/
package oracle.otnsamples.ibfbs.trademanagement.helper;

// Import Required Packages
import java.util.Date;


/**
 * This Class encapsulates particular Stock Rate Values for a particular Symbol.
 *
 * @version 1.0
 * @since   1.0
 */
public class StockRate {

  /** Stock Symbol */

  String symbol;

  /** Date on which the rates are applicable */
  Date   rateDate;

  /** Maximum rate of the stock */
  float  maxValue;

  /** Minimum rate of the stock */
  float  minValue;


  /**
   * Empty Constructor of this Class
   * @since 1.0
   */
  public StockRate() {}

  /**
   * Constructor with appropriate parameters. This constructor initializes
   * the values of the instance variables with appropriate values.
   * @param symbol   Stock Symbol

   * @param today    Today's Date
   * @param minValue Minimum Value of the Stock
   * @param maxValue Maximum Value of the Stock
   * @since 1.0
   */
  public StockRate(String symbol, Date today, float minValue, float maxValue) {
    this.symbol   = symbol;
    this.rateDate = today;
    this.maxValue = maxValue;
    this.minValue = minValue;
  }


  /**
   * Method to get the Stock Symbol
   *
   * @return Desired Symbol Value
   * @since 1.0
   */
  public String getSymbol() {
    return symbol;
  }

  /**
   * Method to get the Date for which these values are valid
   *

   * @return Desired Date Value
   * @since 1.0
   */
  public Date getRateDate() {
    return rateDate;
  }

  /**
   * Method to get the Maximum Value of the Stock
   *
   * @return Desired Maximum Value
   * @since 1.0
   */
  public float getMaxValue() {

    return maxValue;
  }

  /**
   * Method to get the Minimum Value of the Stock
   *
   * @return Desired Minimum Value
   * @since 1.0
   */
  public float getMinValue() {
    return minValue;
  }

  /**
   * Method to set the value of Stock Symbol

   *
   * @param symbol Desired Stock Symbol Value
   * @since 1.0
   */
  public void setSymbol(String symbol) {
    this.symbol = symbol;
  }

  /**
   * Method to set the Date for which these values are valid
   *
   * @param rateDate Desired Date Value
   * @since 1.0
   */
  public void setRateDate(Date rateDate) {
    this.rateDate = rateDate;

  }

  /**
   * Method to set the Maximum Value of the Stock
   *
   * @input maxValue Desired Maximum Value
   * @since 1.0
   */
  public void setMaxValue(float maxValue) {
    this.maxValue = maxValue;
  }

  /**
   * Method to set the Minimum Value of the Stock
   *
   * @param minValue Desired Minimum Value
   * @since 1.0

   */
  public void setMinValue(float minValue) {
    this.minValue = minValue;
  }
}