IUserManager.java

/**
 * This file is part of Archiv-Editor.
 * 
 * The software Archiv-Editor serves as a client user interface for working with
 * the Person Data Repository. See: pdr.bbaw.de
 * 
 * The software Archiv-Editor was developed at the Berlin-Brandenburg Academy
 * of Sciences and Humanities, Jägerstr. 22/23, D-10117 Berlin.
 * www.bbaw.de
 * 
 * Copyright (C) 2010-2013  Berlin-Brandenburg Academy
 * of Sciences and Humanities
 * 
 * The software Archiv-Editor was developed by @author: Christoph Plutte.
 * 
 * Archiv-Editor is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * Archiv-Editor 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 Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with Archiv-Editor.  
 * If not, see <http://www.gnu.org/licenses/lgpl-3.0.html>.
 */
package org.bbaw.pdr.ae.control.interfaces;

import java.util.HashMap;
import java.util.Vector;

import org.bbaw.pdr.ae.model.User;

/**
 * The Interface IUserManager. Its implementation find, check, hold and create
 * new users.
 * @author Christoph Plutte
 */
public interface IUserManager
{

	/**
	 * Gets the map of saved users.
	 * @return the map of saved users
	 * @throws Exception
	 */
	HashMap<String, User> getMapOfSavedUsers() throws Exception;

	/**
	 * Gets the user by id.
	 * @param id the id
	 * @return the user by id
	 * @throws Exception the exception
	 */
	User getUserById(String id) throws Exception;

	/**
	 * Gets the users by user name.
	 * @param userName the user name
	 * @return the users by user name
	 * @throws Exception the exception
	 */
	User getUsersByUserName(String userName) throws Exception;

	/**
	 * Save user.
	 * @param user the user
	 * @throws Exception the exception
	 */
	void saveUser(User user) throws Exception;

	/**
	 * Sets the users.
	 * @param users the new users
	 */
	void setUsers(Vector<User> users);

	/**
	 * Verify or create users.
	 * @return true, if successful
	 */
	boolean verifyOrCreateUsers();

	void clearLastUsers();
}