core/org.eclipse.ptp.core/src/org/eclipse/ptp/core/elementcontrols/IPQueueControl.java

/*******************************************************************************
 * Copyright (c) 2006 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.elementcontrols;

import java.util.Collection;

import org.eclipse.ptp.core.attributes.IAttribute;
import org.eclipse.ptp.core.elements.IPQueue;

public interface IPQueueControl extends IPElementControl, IPQueue {
	/**
	 * Add attributes to a collection of jobs.
	 * 
	 * @param jobs collection of IJobControls
	 * @param attrs array of attributes to add to each job
	 */
	public void addJobAttributes(Collection<IPJobControl> jobs, IAttribute<?,?,?>[] attrs);

	/**
	 * Add the collection of jobs to the queue.
	 * 
	 * @param jobs collection of IJobControls
	 */
	public void addJobs(Collection<IPJobControl> jobs);

	/**
	 * Lookup a job from a job ID
	 * 
	 * @param job_id
	 * @return job associated with the job ID
	 */
	public IPJobControl getJobControl(String job_id);
	
	/**
	 * Get all the jobs in this queue.
	 * 
	 * @return array of jobs
	 */
	public Collection<IPJobControl> getJobControls();
	
	/**
	 * Remove job from the queue
	 * 
	 * @param jobs to remove
	 */
	public void removeJobs(Collection<IPJobControl> jobs);
}