com.liferay.content.targeting.api.model

Class BaseReport

java.lang.Object

com.liferay.content.targeting.api.model.BaseReport

All Implemented Interfaces:

Report

Direct Known Subclasses:

BaseFreemarkerReport, BaseJSPReport

public abstract class BaseReport
extends java.lang.Object
implements Report

Constructor Summary

Constructors

Constructor and Description
BaseReport()

Method Summary

Modifier and Type	Method and Description
void	activate() Does processing when the report is installed.
void	deActivate() Does processing when the report is uninstalled.
java.lang.String	getDescription(java.util.Locale locale) Returns the report's localized description.
java.lang.String	getIcon() Returns the Font Awesome CSS class for the report icon.
java.lang.String	getName(java.util.Locale locale) Returns the report's localized name.
java.lang.String	getReportKey() Returns the key that identifies the report.
boolean	isInstantiable() Returns true if the report can be used more than once with different values for a campaign.
boolean	isVisible(long classPK) Returns true if the report is visible for a specific element.
java.lang.String	processEditReport(javax.portlet.PortletRequest portletRequest, javax.portlet.PortletResponse portletResponse, ReportInstance reportInstance) Returns the result of evaluating the report's form fields in the context of the request and response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.liferay.content.targeting.api.model.Report

getEditHTML, getHTML, getReportType, updateReport

Constructor Detail

BaseReport

public BaseReport()

Method Detail

activate

public void activate()

Description copied from interface: Report

Does processing when the report is installed.

Specified by:

activate in interface Report

deActivate

public void deActivate()

Description copied from interface: Report

Does processing when the report is uninstalled.

Specified by:

deActivate in interface Report

getDescription

public java.lang.String getDescription(java.util.Locale locale)

Description copied from interface: Report

Returns the report's localized description.

Specified by:

getDescription in interface Report

Parameters:

locale - the language locale

Returns:

the report's localized description

getIcon

public java.lang.String getIcon()

Description copied from interface: Report

Returns the Font Awesome CSS class for the report icon.

Specified by:

getIcon in interface Report

Returns:

the Font Awesome CSS class for the report icon

See Also:

Font Awesome documentation

getName

public java.lang.String getName(java.util.Locale locale)

Description copied from interface: Report

Returns the report's localized name.

Specified by:

getName in interface Report

Parameters:

locale - the language locale

Returns:

the report's localized name

getReportKey

public java.lang.String getReportKey()

Description copied from interface: Report

Returns the key that identifies the report.

Specified by:

getReportKey in interface Report

Returns:

the key that identifies the report

isInstantiable

public boolean isInstantiable()

Description copied from interface: Report

Returns true if the report can be used more than once with different values for a campaign.

Specified by:

isInstantiable in interface Report

Returns:

true if the report can be used more than once; false otherwise

isVisible

public boolean isVisible(long classPK)

Description copied from interface: Report

Returns true if the report is visible for a specific element.

Specified by:

isVisible in interface Report

Parameters:

classPK - the ID of the element for which the report type visibility is checked

Returns:

true if the report is visible for the given element; false otherwise

processEditReport

public java.lang.String processEditReport(javax.portlet.PortletRequest portletRequest,
                                          javax.portlet.PortletResponse portletResponse,
                                          ReportInstance reportInstance)
                                   throws java.lang.Exception

Description copied from interface: Report

Returns the result of evaluating the report's form fields in the context of the request and response.

Specified by:

processEditReport in interface Report

Parameters:

portletRequest - the request from which to get the request parameters

portletResponse - the response to receive the render parameters

reportInstance - the report instance with stored configuration

Returns:

the result of evaluating the report's form fields in the context of the request and response

Throws:

java.lang.Exception - if an exception occurred