Report.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.content.targeting.api.model;

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

/**
 * Provides the Report interface, allowing custom report creation and evaluation
 * for the Content Targeting Portlet.
 *
 * @author Eduardo Garcia
 */
public interface Report {

	/**
	 * Does processing when the report is installed.
	 */
	public void activate();

	/**
	 * Does processing when the report is uninstalled.
	 */
	public void deActivate();

	/**
	 * Returns the report localized description.
	 *
	 * @param  locale the language locale
	 * @return the report localized description
	 */
	public String getDescription(Locale locale);

	/**
	 * Returns the HTML code containing the report presentation based on the
	 * context.
	 *
	 * @param  context the map defining the form evaluation context
	 * @return the HTML code containing the form fields required to edit the
	 *         rule instance configuration, based on the context
	 */
	public String getHTML(Map<String, Object> context);

	/**
	 * Returns the Font Awesome CSS class for the report icon.
	 *
	 * @return the Font Awesome CSS class for the report icon
	 * @see    <a href="http://fortawesome.github.io/Font-Awesome/3.2.1/">Font
	 *         Awesome documentation</a>
	 */
	public String getIcon();

	/**
	 * Returns the report localized name.
	 *
	 * @param  locale the language locale
	 * @return the report localized name
	 */
	public String getName(Locale locale);

	/**
	 * Returns the key that identifies the report.
	 *
	 * @return the key that identifies the report
	 */
	public String getReportKey();

	/**
	 * Returns the type of element the report is aimed for.
	 *
	 * @return the type of element the report is aimed for
	 */
	public String getReportType();

	/**
	 * Returns the result of updating the report.
	 *
	 * @param  classPK the id of the element with the report type to be updated
	 * @return the result of updating the report
	 */
	public String updateReport(long classPK);

}