useraccounthomelocal.java

Oracle的J2EE Sample

/*
 * @author : Umesh Kulkarni
 * @version 1.0
 *
 * Development Environment : Oracle9i JDeveloper
 *
 * Name of the File : UserAccountHomeLocal.java
 *
 * Creation / Modification History
 *    Umesh           26-Apr-2002        Created
 *
 */
package oracle.otnsamples.ibfbs.usermanagement.ejb;

// Import Required Packages
import javax.ejb.EJBLocalHome;
import javax.ejb.CreateException;
import javax.ejb.FinderException;
import java.util.Collection;

/**
 * This Class is Local Home Interface to UserAccount Bean. Using this local home
 * interface, clients can create objects implementing its local interfaces.
 *
 * The Session Facade Bean namely 'UserManagementSessionFacadeBean' invokes the
 * create() method of this home interface to get UserAccountBean Local EJB
 * Object. Note : It is recommdended that Local EJB Objects are invoked by the
 * Session Bean/Entity Bean executing in the same EJB container. Here in this
 * application, UserManagementSessionFacadeBean invokes the methods on the
 * Local Objects.
 * @version 1.0
 * @since   1.0
 */
public interface UserAccountHomeLocal extends EJBLocalHome {

  /**
   * Method to create UserAccountBean Local EJB Object.
   *
   * @param accountNumber  Account Number of the User Account
   * @param password       Password associated with the User Account
   * @param firstName      First Name associated with the User Account
   * @param lastName       Last Name associated with the User Account
   * @param organization   Organization associated with the User Account
   * @param address        Address associated with the User Account
   * @param city           City associated with the User Account
   * @param country        Country associated with the User Account
   * @param phone          Phone Number associated with the User Account
   * @param accountBalance Account Balance associated with User Account
   * @param email          Email Value associated with the User Account
   * @param userType       User Type associated with the User Account
   * @param linesPerPage   Lines Per Page associated with User Account
   * @param alertMode      Alert Mode associated with the User Account
   * @param mobileEmail    Mobile Email associated with the User Account
   * @return Local EJB Object implementing UserAccountLocal interface
   * @since   1.0
   */
  public UserAccountLocal create(Integer accountNumber, String password,
                                 String firstname, String lastname,
                                 String organization, String address,
                                 String city, String state, String country,
                                 String phone, float accountBalance,
                                 String email, String userType,
                                 Integer linesPerPage, String alertMode,
                                 String mobileEmail)
      throws CreateException;

  /**
   * Method to Find a particulr UserAccountBean Local EJB Object
   * by providing its primary key.
   *
   * @param accountNumber Account Number Primary Key Field
   * @return Local EJB Object implementing UserAccountLocal interface.
   * @since   1.0
   */
  public UserAccountLocal findByPrimaryKey(Integer accountNumber)
      throws FinderException;

  /**
   * Method to find a particular UserAccountBean Local EJB Object by providing
   * the Email. This method demonstrates the use of EJB-QL (Query Language)
   * which is an important feature of EJB2.0. This is implemented by the
   * Container which adds the value of the input parameter in the WHERE clause
   * of the query specified in ejb-jar.xml. Here we want the Container to look
   * into it's persistent store of UserAccount and pass back a collection of
   * UserAccountBean instances that match the query.
   *
   * @param email Email id of the User
   *                (Note : This is not the primary key).
   * @return Collection of UserAccountBean local instances.
   * @since   1.0
   */
  public Collection findByEmail(String email)
      throws FinderException;

  /**
   * Method to find a particular UserAccountBean Local EJB Object by providing
   * the UserType. This method demonstrates the use of EJB-QL (Query Language)
   * which is an important feature of EJB2.0. This is implemented by the
   * Container which adds the value of the input parameter in the WHERE clause
   * of the query specified in ejb-jar.xml. Here we want the Container to look
   * into it's persistent store of UserAccount and pass back a collection of
   * UserAccountBean instances that match the usertype.
   *
   * @param usertype User Type
   *                (Note : This is not the primary key).
   * @return Collection of UserAccountBean local instances matching the usertype.
   * @since   1.0
   */
  public Collection findByUserType(String usertype)
      throws FinderException;

}