ProductNavigationControlMenuEntry.java

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.product.navigation.control.menu;

import com.liferay.portal.kernel.exception.PortalException;

import java.io.IOException;

import java.util.Locale;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * Provides an interface that defines entries to be used by a
 * <code>product-navigation:control-menu</code> tag instance to render a new
 * Control Menu entry. Control Menu entries are included within Control Menu
 * categories defined by {@link ProductNavigationControlMenuCategory}
 * implementations.
 *
 * <p>
 * Implementations must be registered in the OSGi Registry. The order of Control
 * Menu entries inside a category is determined by the
 * <code>product.navigation.control.menu.entry.order</code> property value. The
 * Control Menu category used to display that entry is determined by the
 * <code>product.navigation.control.menu.category.key</code> property value.
 * </p>
 *
 * @author Julio Camarero
 */
public interface ProductNavigationControlMenuEntry {

	/**
	 * Returns the data to be injected as the <code>data</code> attribute of the
	 * <code>liferay-ui:icon</code> tag instance for the Control Menu entry.
	 *
	 * @param  request the request that renders the Control Menu entry
	 * @return the <code>data</code> attribute of the
	 *         <code>liferay-ui:icon</code> tag instance for the Control Menu
	 *         entry
	 */
	public Map<String, Object> getData(HttpServletRequest request);

	/**
	 * Returns the icon name to be injected as the <code>icon</code> attribute
	 * of the <code>liferay-ui:icon</code> tag instance for the Control Menu
	 * entry.
	 *
	 * @param  request the request that renders the Control Menu entry
	 * @return the <code>icon</code> attribute of the
	 *         <code>liferay-ui:icon</code> tag instance for the Control Menu
	 *         entry
	 */
	public String getIcon(HttpServletRequest request);

	/**
	 * Returns the icon CSS class to be injected as the
	 * <code>iconCssClass</code> attribute of the <code>liferay-ui:icon</code>
	 * tag instance for the Control Menu entry.
	 *
	 * @param  request the request that renders the Control Menu entry
	 * @return the <code>iconCssClass</code> attribute of the
	 *         <code>liferay-ui:icon</code> tag instance for the Control Menu
	 *         entry
	 */
	public String getIconCssClass(HttpServletRequest request);

	/**
	 * Returns the Control Menu entry's key. This key must be unique in the
	 * scope of the Control Menu entry selector.
	 *
	 * @return the Control Menu entry's key
	 */
	public String getKey();

	/**
	 * Returns the label that is displayed in the user interface when the
	 * Control Menu entry is included in the tag instance.
	 *
	 * @param  locale the label's retrieved locale
	 * @return the Control Menu entry's label
	 */
	public String getLabel(Locale locale);

	/**
	 * Returns the link CSS class to be injected as the
	 * <code>linkCssClass</code> attribute of the <code>liferay-ui:icon</code>
	 * tag instance for the Control Menu entry.
	 *
	 * @param  request the request that renders the Control Menu entry
	 * @return the <code>linkCssClass</code> attribute of the
	 *         <code>liferay-ui:icon</code> tag instance for the Control Menu
	 *         entry
	 */
	public String getLinkCssClass(HttpServletRequest request);

	/**
	 * Returns the markup view string to be injected as the
	 * <code>markupView</code> attribute of the <code>liferay-ui:icon</code> tag
	 * instance for the Control Menu entry.
	 *
	 * @param  request the request that renders the Control Menu entry
	 * @return the <code>markupView</code> attribute of the
	 *         <code>liferay-ui:icon</code> tag instance for the Control Menu
	 *         entry
	 */
	public String getMarkupView(HttpServletRequest request);

	/**
	 * Returns the URL to be injected as the <code>url</code> attribute of the
	 * <code>liferay-ui:icon</code> tag instance for the Control Menu entry.
	 *
	 * @param  request the request that renders the Control Menu entry
	 * @return the <code>url</code> attribute of the
	 *         <code>liferay-ui:icon</code> tag instance for the Control Menu
	 *         entry
	 */
	public String getURL(HttpServletRequest request);

	/**
	 * Returns <code>true</code> if the Control Menu entry body's HTML should be
	 * rendered.
	 *
	 * @param  request the request that renders the Control Menu entry
	 * @param  response the response that renders the Control Menu entry
	 * @return <code>true</code> if the Control Menu entry body's HTML should be
	 *         rendered; <code>false</code> otherwise
	 * @throws IOException if an IO exception occurred
	 */
	public boolean includeBody(
			HttpServletRequest request, HttpServletResponse response)
		throws IOException;

	/**
	 * Returns <code>true</code> if the Control Menu entry icon's HTML should be
	 * rendered.
	 *
	 * @param  request the request that renders the Control Menu entry
	 * @param  response the response that renders the Control Menu entry
	 * @return <code>true</code> if the Control Menu entry icon's HTML should be
	 *         rendered; <code>false</code> otherwise
	 * @throws IOException if an IO exception occurred
	 */
	public boolean includeIcon(
			HttpServletRequest request, HttpServletResponse response)
		throws IOException;

	/**
	 * Returns <code>true</code> if the Control Menu entry should be displayed
	 * in the request's context.
	 *
	 * @param  request the request that renders the Control Menu entry
	 * @return <code>true</code> if the Control Menu entry should be displayed
	 *         in the request's context; <code>false</code> otherwise
	 * @throws PortalException if a portal exception occurred
	 */
	public boolean isShow(HttpServletRequest request) throws PortalException;

	/**
	 * Returns <code>true</code> if the Control Menu entry should be opened in a
	 * dialog window.
	 *
	 * @return <code>true</code> if the Control Menu entry should be opened in a
	 *         dialog window; <code>false</code> if it should open in the
	 *         current window
	 */
	public boolean isUseDialog();

}