core/org.eclipse.ptp.core/src/org/eclipse/ptp/core/IModelManager.java

/*******************************************************************************
 * Copyright (c) 2005 The Regents of the University of California. 
 * This material was produced under U.S. Government contract W-7405-ENG-36 
 * for Los Alamos National Laboratory, which is operated by the University 
 * of California for the U.S. Department of Energy. The U.S. Government has 
 * rights to use, reproduce, and distribute this software. NEITHER THE 
 * GOVERNMENT NOR THE UNIVERSITY MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR 
 * ASSUMES ANY LIABILITY FOR THE USE OF THIS SOFTWARE. If software is modified 
 * to produce derivative works, such modified software should be clearly marked, 
 * so as not to confuse it with the version available from LANL.
 * 
 * Additionally, this program and the accompanying materials 
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * LA-CC 04-115
 *******************************************************************************/
package org.eclipse.ptp.core;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.ptp.core.elementcontrols.IResourceManagerControl;
import org.eclipse.ptp.core.elements.IPUniverse;
import org.eclipse.ptp.core.elements.IResourceManager;
import org.eclipse.ptp.core.listeners.IModelManagerChildListener;
import org.eclipse.ptp.rmsystem.IResourceManagerFactory;

public interface IModelManager extends IModelPresentation {
	/**
	 * Add a listener for model manager children events.
	 * 
	 * @param listener
	 */
	public void addListener(IModelManagerChildListener listener);
	
	/**
	 * Add a resource manager to the model.
	 * 
	 * @param addedManager
	 */
	public void addResourceManager(IResourceManagerControl addedManager);

	/**
	 * Add resource managers to the model.
	 * 
	 * @param addedManagers
	 */
	public void addResourceManagers(IResourceManagerControl[] addedManagers);
	
	/**
	 * Get the resource manager factories that have been registered via
	 * extensions.
	 * 
	 * @return array of resource manager factories
	 */
	public IResourceManagerFactory[] getResourceManagerFactories();
	
	/**
	 * Find the resource manager factory corresponding to the supplied ID.
	 * 
	 * @param id
	 * @return the requested resource manager factory
	 */
	public IResourceManagerFactory getResourceManagerFactory(String id);

	/**
	 * Find the resource manager with the supplied unique name
	 * 
	 * @param rmUniqueName
	 * @return resource manager
	 */
	public IResourceManager getResourceManagerFromUniqueName(String rmUniqueName);

	/**
	 * Find resource managers that have been started
	 * 
	 * @param universe
	 * @return array of resource managers
	 */
	public IResourceManager[] getStartedResourceManagers(IPUniverse universe);

	/**
	 * Loads saved resource managers.
	 * 
	 * @throws CoreException
	 */
	public void loadResourceManagers() throws CoreException;
	
	/**
	 * Remove listener for model manager child events.
	 * 
	 * @param listener
	 */
	public void removeListener(IModelManagerChildListener listener);
	
	/**
	 * Remove a resource manager from the model.
	 * 
	 * @param removedManager
	 */
	public void removeResourceManager(IResourceManagerControl removedManager);
	
	/**
	 * Remove resource managers from the model.
	 * 
	 * @param removedRMs
	 */
	public void removeResourceManagers(IResourceManagerControl[] removedRMs);
	
	/**
	 * Save the resource manager configurations
	 */
	public void saveResourceManagers();

	/**
	 * Shuts down the model manager. Should only be called at plugin shutdown.
	 * @throws CoreException
	 */
	public void shutdown() throws CoreException;

	/**
	 * Start the model manager. Should only be called once at plugin startup.
	 * 
	 * @throws CoreException
	 */
	public void start() throws CoreException;

	/**
	 * stops all of the resource managers.
	 * 
	 * @throws CoreException
	 */
	public void stopResourceManagers() throws CoreException;
}