public interface Report
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(java.util.Map<java.lang.String,java.lang.Object> context)
Deprecated.
As of 2.0.0
|
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.
|
java.lang.String |
updateReport(long classPK)
Deprecated.
As of 2.0.0
|
void |
updateReport(ReportInstance reportInstance)
Updates the report data.
|
void activate()
void deActivate()
java.lang.String getDescription(java.util.Locale locale)
locale
- the language localejava.lang.String getEditHTML(ReportInstance reportInstance, java.util.Map<java.lang.String,java.lang.Object> context)
reportInstance
- the report instance with stored configurationcontext
- the map defining the form evaluation context@Deprecated java.lang.String getHTML(java.util.Map<java.lang.String,java.lang.Object> context)
context
- the map defining the form evaluation contextjava.lang.String getHTML(ReportInstance reportInstance, java.util.Map<java.lang.String,java.lang.Object> context)
reportInstance
- the report instance with stored configurationcontext
- the map defining the form evaluation contextjava.lang.String getIcon()
java.lang.String getName(java.util.Locale locale)
locale
- the language localejava.lang.String getReportKey()
java.lang.String getReportType()
boolean isInstantiable()
true
if the report can be used more than once with
different values for a campaign.true
if the report can be used more than once;
false
otherwiseboolean isVisible(long classPK)
true
if the report is visible for a specific
element.classPK
- the ID of the element for which the report type
visibility is checkedtrue
if the report is visible for the given element;
false
otherwisejava.lang.String processEditReport(javax.portlet.PortletRequest portletRequest, javax.portlet.PortletResponse portletResponse, ReportInstance reportInstance) throws java.lang.Exception
portletRequest
- the request from which to get the request
parametersportletResponse
- the response to receive the render parametersreportInstance
- the report instance with stored configurationjava.lang.Exception
- if an exception occurred@Deprecated java.lang.String updateReport(long classPK)
classPK
- the ID of the element with the report type to be
updatedvoid updateReport(ReportInstance reportInstance)
reportInstance
- the report instance with stored configuration