tradedetailshomelocal.java

Oracle的J2EE Sample

/*
 * @author  : Pushkala
 * @version : 1.0
 *
 * Development Environment : Oracle9i JDeveloper
 *
 * Name of the File : TradeDetailsHomeLocal.java
 *
 * Creation / Modification History
 *    Pushkala        29-Apr-2002        Created
 *
 */
package oracle.otnsamples.ibfbs.trademanagement.ejb;

import javax.ejb.CreateException;
import javax.ejb.FinderException;

import java.util.Date;
import java.util.Collection;

/**
 * This interface is the Local home interface of the TRADEDETAILS entity EJB.
 * Using this local home interface, clients can create objects implementing
 * this local interfaces. The Session Facade Bean namely
 * 'TradeManagementSessionFacadeBean' invokes the create() method of this home
 * interface to get TradeDetailsBean Local EJB Object.
 * Note : It is  recommdended that Local EJB Objects are invoked by the
 * Session Bean or Entity Bean executing in the same EJB container. Here in
 * this application, TradeManagementSessionFacadeBean invokes the methods on
 * the Local Objects.
 *
 * @version 1.0
 * @since   1.0
 */
public interface TradeDetailsHomeLocal extends javax.ejb.EJBLocalHome {

  /**
   * Method to create TradeDetailsBean Local EJB Object.
   *
   * @param tradeId       Trade Id
   * @param accountNumber AccountNumber associated with the TradeDetails
   * @param action        Action associated with the TradeDetails
   * @param quantity      Stock Quantity associated with the TradeDetails
   * @param tradeDate     Trade Date associated with the TradeDetails
   * @param price         Stock Price associated with the TradeDetails
   * @param symbol        Stock Symbol associated with the TradeDetails
   * @param orderType     Order Type associated with the TradeDetails
   * @param status        Status associated with the TradeDetails
   * @param exchangeId    Exchange Id associated with the TradeDetails
   * @return Local EJB Object implementing TradeDetailsLocal interface
   * @exception CreateException
   * @since 1.0
   */
  public TradeDetailsLocal create(Integer tradeId, Integer accountNumber,
                                  String action, Integer quantity,
                                  Date tradeDate, float price, String symbol,
                                  String orderType, String status,
                                  Integer exchangeId)
      throws CreateException;

  /**
   * Method to Find a particular TradeDetailsBean Local EJB Object
   * by providing its primary key.
   *
   * @param primaryKey Primary Key Field.
   * @return Local EJB Object implementing TradeDetailsLocal interface.
   * @exception FinderException
   * @since 1.0
   */
  public TradeDetailsLocal findByPrimaryKey(Integer primaryKey)
      throws FinderException;

  /**
   * Method to Find all TradeDetails between the input dates.
   * This method invokes the ejbHomeTradeDetails() method in 
   * TradeDetailsBean.java. The container by default adds 'ejbHome' at the 
   * start of the method and so we do not have to use it here in naming 
   * the method. But, we need to specify 'ejbHome' in the implementation 
   * of this method.
   *
   * @param  toDate  Start datetime for checking tradedate
   * @param  sysDate End datetime for checking tradedate
   * @return Collection of TradeDetails objects
   * @exception FinderException
   * @since 1.0
   */
  public Collection TradeDetails(Date toDate, Date sysDate)
      throws FinderException;

}