com.liferay.content.targeting.api.model

Interface Report

All Known Implementing Classes:

BaseFreemarkerReport, BaseJSPReport, BaseReport

public interface Report

Provides the Report interface, allowing custom report creation and evaluation for the Content Targeting portlet.

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	getEditHTML(ReportInstance reportInstance, java.util.Map<java.lang.String,java.lang.Object> context) Returns the HTML code containing the advanced properties edit form for the report.
java.lang.String	getHTML(ReportInstance reportInstance, java.util.Map<java.lang.String,java.lang.Object> context) Returns the HTML code containing the report presentation based on the context.
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.
java.lang.String	getReportType() Returns the element type for 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.
void	updateReport(ReportInstance reportInstance) Updates the report data.

Method Detail

activate

void activate()

Does processing when the report is installed.

deActivate

void deActivate()

Does processing when the report is uninstalled.

getDescription

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

Returns the report's localized description.

Parameters:

locale - the language locale

Returns:

the report's localized description

getEditHTML

java.lang.String getEditHTML(ReportInstance reportInstance,
                             java.util.Map<java.lang.String,java.lang.Object> context)

Returns the HTML code containing the advanced properties edit form for the report.

Parameters:

reportInstance - the report instance with stored configuration

context - the map defining the form evaluation context

Returns:

the HTML code containing the form fields required to edit the report instance configuration, based on the context

getHTML

java.lang.String getHTML(ReportInstance reportInstance,
                         java.util.Map<java.lang.String,java.lang.Object> context)

Returns the HTML code containing the report presentation based on the context.

Parameters:

reportInstance - the report instance with stored configuration

context - the map defining the form evaluation context

Returns:

the HTML code containing the form fields required to show the report instance, based on the context

getIcon

java.lang.String getIcon()

Returns the Font Awesome CSS class for the report icon.

Returns:

the Font Awesome CSS class for the report icon

See Also:

Font Awesome documentation

getName

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

Returns the report's localized name.

Parameters:

locale - the language locale

Returns:

the report's localized name

getReportKey

java.lang.String getReportKey()

Returns the key that identifies the report.

Returns:

the key that identifies the report

getReportType

java.lang.String getReportType()

Returns the element type for the report. For example, the element type could represent a campaign or user segment.

Returns:

the element type for the report

isInstantiable

boolean isInstantiable()

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

Returns:

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

isVisible

boolean isVisible(long classPK)

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

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

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

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

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

updateReport

void updateReport(ReportInstance reportInstance)

Updates the report data.

Parameters:

reportInstance - the report instance with stored configuration