core/org.eclipse.ptp.ui/src/org/eclipse/ptp/ui/model/IElementSet.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.ui.model;

/**
 * @author clement chu
 *
 */
public interface IElementSet extends IContainer {
	/** Add to match set
	 * @param setId set ID
	 */
	public void addMatchSet(String setId);
	/** Remove from macth set 
	 * @param setId set ID
	 */
	public void removeMatchSet(String setId);
	/** Get match Sets
	 * @return match sets
	 */
	public String[] getMatchSets();
	/** Does this set contain with other sets
	 * @return true if other sets contains this set
	 */
	public boolean containOtherSets();
	/** Check given set ID already contained
	 * @param set_id Set ID
	 * @return true if given set ID contained in this set
	 */
	public boolean isContainSets(String set_id);
	
	/** Is this set root
	 * @return ture if this set is root
	 */
	public boolean isRootSet();

	/** Get sorted elements
	 * @return sorted elements
	 */
	public IElement[] getSortedElements();
	/** Get elements
	 * @return elements
	 */
	public IElement[] getElements();
	/** Get element
	 * @param id Element ID
	 * @return element
	 */
	public IElement getElement(String id);
	/** Get element
	 * @param index Element index
	 * @return element
	 */
	public IElement getElement(int index);
	/** Get IElementHandler
	 * @return IElementHandler
	 */
	public IElementHandler getElementHandler();
}