IProduct.java

/*******************************************************************************
 * Copyright (c) 2004, 2010 Tasktop Technologies and others.
 * All rights reserved. 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
 *
 * Contributors:
 *     Tasktop Technologies - initial API and implementation
 *******************************************************************************/

package org.eclipse.mylyn.tasks.bugs;

/**
 * Represents a supported product.
 * 
 * @author Steffen Pingel
 * @since 3.4
 * @noextend This interface is not intended to be extended by clients.
 * @noimplement This interface is not intended to be implemented by clients.
 */
public interface IProduct {

	/**
	 * Returns the name of the product.
	 * 
	 * @return null, if a name is not available; the name, otherwise
	 */
	public abstract String getName();

	/**
	 * Returns a description for the product.
	 * 
	 * @return null, if a description is not available; the description, otherwise
	 */
	public abstract String getDescription();

	/**
	 * Returns an id for the product that is unique in respect to other product ids.
	 */
	public abstract String getId();

	/**
	 * Returns a provider that supports the product.
	 */
	public abstract IProvider getProvider();

}