localuserhome.java

老外的在线考试

/*
 * UserEJB - CyberDemia's User management library implemented using EJBs.
 * Copyright (C) 2003 CyberDemia Research and Services
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 * 
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA  02111-1307, USA.
 *
 * See the COPYING file located in the top-level-directory of
 * the archive of this library for complete text of license.
 */
package com.cyberdemia.user;
import javax.ejb.*;
import java.util.Collection;

/**
 * LocalUserHome is the home interface for LocalUser.
 *  
 * @author Alexander Yap
 * @see LocalUser
 */
public interface LocalUserHome extends EJBLocalHome
{
	/**
	 * Creates a new UserBean instance and returns a LocalUser interface to it.
	 * @param password User's password.
	 * @param email User's email, must be unique among users.
	 * @param title User's title.
	 * @param firstName User's first name.
	 * @param lastName User's last name.
	 * @param groups User's group, to determine security roles for the user.
	 * @return A LocalUser local interface to the new UserBean instance.
	 * @throws CreateException if there is a problem creating this user.
	 */
	public LocalUser create( String password, String email, String title,
		String firstName, String lastName, String groups ) throws CreateException;

	/**
	 * Finds a LocalUser by its unique ID (primary key).
	 * @param uid Unique ID
	 * @return A LocalUser instance.
	 * @throws FinderException if user not found.
	 */
	public LocalUser findByPrimaryKey(String uid) throws FinderException;

	/**
	 * Finds a LocalUser by its email address.
	 * @param email User's email
	 * @return Collection containing a single LocalUser instance if found, otherwise an empty Collection.
	 * @throws FinderException
	 */
	public Collection findByEmail(String email) throws FinderException;

	/**
	 * Finds LocalUsers by searching for a substring within the email address.
	 * @param emailSubStr Email address substring to search for.
	 * @return Collection containing matching LocalUser instances, or empty Collection if not found.
	 * @throws FinderException
	 */
	public Collection findByEmailSubString(String emailSubStr) throws FinderException;

	/**
	 * Finds LocalUsers by searching for a substring within the last name.
	 * @param lastNameSubStr Last name substring to search for.
	 * @return Collection containing matching LocalUser instances, or empty Collection if not found.
	 * @throws FinderException
	 */
	public Collection findByLastNameSubString(String lastNameSubStr) throws FinderException;

	/**
	 * Gets all users in the database.
	 * @return Collection containing all LocalUser instances.
	 * @throws FinderException
	 */
	public Collection findAll() throws FinderException;
}