org.eclipse.help/src/org/eclipse/help/ITopic2.java

/*******************************************************************************
 * Copyright (c) 2010, 2015 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.help;


/**
 * <code>ITopic2</code> extends <code>ITopic</code> by adding methods to support functionality
 * for criteria, topic sorting and custom icons
 *
 * @since 3.5
 */
public interface ITopic2 extends ITopic{

	/**
	 * Return the criteria information of topic.
	 * @return array of CriterionResource
	 */
	public ICriteria[] getCriteria();

	/**
	 * Toc elements can have non standard icons which are declared using a
	 * tocIcon element in the org.eclipse.help.toc extension point
	 * @return NULL if the standard icons are to be used, otherwise the name of
	 * an icon declared in an org.eclipse.help.toc extension
	 */
	public String getIcon();

	/**
	 * Allows child elements to be sorted alphabetically regardless of their actual
	 * order in the list of children.
	 * @return true if the children should be sorted alphabetically
	 */
	public boolean isSorted();
}