com.atlassian.jira.plugin.report.impl
Class AbstractReport

java.lang.Object
  extended by com.atlassian.jira.plugin.report.impl.AbstractReport
All Implemented Interfaces:
Report
Direct Known Subclasses:
AbstractChartReport, DeveloperWorkloadReport, ReferenceReport, SingleLevelGroupByReport, TimeTrackingReport, VersionWorkloadReport

@PublicSpi
public abstract class AbstractReport
extends Object
implements Report


Field Summary
protected  ReportModuleDescriptor descriptor
           
 
Constructor Summary
AbstractReport()
           
 
Method Summary
 String generateReportExcel(ProjectActionSupport action, Map params)
          By default, will throw an UnsuppportedOperationException as reports don't support Excel by default.
protected  ReportModuleDescriptor getDescriptor()
           
 IssueConstant getIssueConstant(org.ofbiz.core.entity.GenericValue issueConstantGV)
           
 void init(ReportModuleDescriptor descriptor)
          Initialise this report, given the report's module descriptor.
 boolean isExcelViewSupported()
          By default, reports do not have an Excel view.
 boolean showReport()
          Whether or not to show this report in the interface.
 void validate(ProjectActionSupport action, Map params)
          Validate the parameters passed to this report from the UI.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.atlassian.jira.plugin.report.Report
generateReportHtml
 

Field Detail

descriptor

protected ReportModuleDescriptor descriptor
Constructor Detail

AbstractReport

public AbstractReport()
Method Detail

init

public void init(ReportModuleDescriptor descriptor)
Description copied from interface: Report
Initialise this report, given the report's module descriptor.

This method is run immediately after the report is constructed.

Specified by:
init in interface Report

validate

public void validate(ProjectActionSupport action,
                     Map params)
Description copied from interface: Report
Validate the parameters passed to this report from the UI.

Any errors should be added to the action errors.

Specified by:
validate in interface Report

isExcelViewSupported

public boolean isExcelViewSupported()
By default, reports do not have an Excel view.

Specified by:
isExcelViewSupported in interface Report

generateReportExcel

public String generateReportExcel(ProjectActionSupport action,
                                  Map params)
                           throws Exception
By default, will throw an UnsuppportedOperationException as reports don't support Excel by default.

Specified by:
generateReportExcel in interface Report
Throws:
Exception

showReport

public boolean showReport()
Whether or not to show this report in the interface. The default is "true".

Specified by:
showReport in interface Report

getDescriptor

protected ReportModuleDescriptor getDescriptor()

getIssueConstant

public IssueConstant getIssueConstant(org.ofbiz.core.entity.GenericValue issueConstantGV)


Copyright © 2002-2012 Atlassian. All Rights Reserved.