IUpdateManager.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 org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;

/**
 * The Interface IUpdateManager. Its implementation handle the data update
 * process and syncronisation with the repository.
 * @author Christoph Plutte
 */
public interface IUpdateManager
{

	/**
	 * Update all data.
	 * @param monitor the monitor
	 * @return the i status
	 * @throws Exception the exception
	 */
	IStatus updateAllData(String userID, String password, IProgressMonitor monitor) throws Exception;

	/**
	 * Update users.
	 * @param monitor the monitor
	 * @return the i status
	 * @throws Exception the exception
	 */
	IStatus updateUsers(String userID, String password, IProgressMonitor monitor) throws Exception;

	/**
	 * Gets Id of user from Repository.
	 * @param userName name of user who requestets.
	 * @param projectID id of project.
	 * @return String of id or Exception if not existent.
	 */
	String getUserId(String userName, int projectID) throws Exception;

	void loadInitialUsers(String _userID, String _userPassword, IProgressMonitor monitor) throws Exception;

}