localuser.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.*;

/**
* LocalUser is the local interface to a UserBean instance that
* contains the primary data about a user such as email, password and name.
* These primary data may be accessed or set via the UserData data transfer object.
* Additional data or resources may be associated with a User using the
* "resource reference" mechanism.
*
* @author Alexander Yap
* @see LocalResourceReference
* @see UserData
*/
public interface LocalUser extends EJBLocalObject
{
	/**
	 * Gets the unique ID of this user.
	 * @return Unique ID
	 */
	public String getId();

	/**
	* Sets the hashed password encoded in hexadecimal format.
	* @param password The hashed password.
	*/
	public void setHashedPassword(String password);

	/**
	* Gets the hashed password encoded in hexadecimal format.
	* @return The hashed password.
	*/
	public String getHashedPassword();

	/**
	* Gets the data in this user.
	* This is a convenience method that should be more efficient
	* than calling the individual getter methods when all the data need
	* to be updated.
	* @return Data of the user.
	*/
	public UserData getUserData();

	/**
	* Sets the data in this user.
	* This is a convenience method that should be more efficient
	* than calling the individual setter methods when all the data need
	* to be updated.
	* Note that some fields in UserData such as id, createdMillis and lastModifiedMillis are read-only and so are ignored by this method.
	* @param data Data of the user.
	*/
	public void setUserData( UserData data);

	/**
	* Gets resources within the specified category that are
	* associated with this user.
	* @param catKey  Key to identify the category of resource to extract, or null to extract all resources.
	* @return Array of LocalResourceReference objects.
	*/
	public LocalResourceReference[] getResources( String catKey );

	/**
	* Associates a resource with this user.
	* @param res   The LocalResourceReference to add.
	* @return true if resource is added successfully, otherwise false (it already exists).
	*/
	public boolean addResource( LocalResourceReference res );

	/**
	* Removes a resource from this user.
	* @param res   The LocalResourceReference to remove.
	* @return true if resource is removed successfully, otherwise false (not found).
	*/
	public boolean removeResource( LocalResourceReference res );
	
	/**
	 * Removes all resources from this user.
	 */
	public void removeAllResources();

	/**
	 * Gets last modified timestamp in milliseconds.
	 * @return Timestamp in milliseconds when this user was last modified.
	 */
	public long getLastModifiedMillis();
}