|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.pentaho.reporting.engine.classic.core.AbstractReportProcessTask
public abstract class AbstractReportProcessTask
A base class for common report process task implementations.
Method Summary | |
---|---|
void |
addReportProgressListener(ReportProgressListener listener)
Adds a report progress listener that is able to monitor the export progress. |
org.pentaho.reporting.libraries.repository.ContentLocation |
getBodyContentLocation()
Returns the content location for the generated document. |
org.pentaho.reporting.libraries.repository.NameGenerator |
getBodyNameGenerator()
Returns the name generator for the report document. |
Throwable |
getError()
Returns any error that has caused the report export to fail. |
MasterReport |
getReport()
Returns the report that will be executed in this task. |
boolean |
isTaskAborted()
Checks whether the task was aborted. |
boolean |
isTaskSuccessful()
Checks whether the export was successful. |
boolean |
isValid()
Returns if the task is configured in a way that the export can be safely started. |
void |
removeReportProgressListener(ReportProgressListener listener)
Removes the given report progress listener from the list of listeners. |
void |
setBodyContentLocation(org.pentaho.reporting.libraries.repository.ContentLocation bodyContentLocation)
Defines the content location (and implicitly the repository) for the generated report document. |
void |
setBodyNameGenerator(org.pentaho.reporting.libraries.repository.NameGenerator bodyNameGenerator)
Defines the body name generator, that generates name sequences in case the target name is already taken. |
void |
setReport(MasterReport report)
Defines the report that will be executed in this task. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.pentaho.reporting.engine.classic.core.ReportProcessTask |
---|
getReportMimeType |
Methods inherited from interface java.lang.Runnable |
---|
run |
Method Detail |
---|
public org.pentaho.reporting.libraries.repository.ContentLocation getBodyContentLocation()
getBodyContentLocation
in interface ReportProcessTask
public void setBodyContentLocation(org.pentaho.reporting.libraries.repository.ContentLocation bodyContentLocation)
setBodyContentLocation
in interface ReportProcessTask
bodyContentLocation
- the content location for the report document.public org.pentaho.reporting.libraries.repository.NameGenerator getBodyNameGenerator()
getBodyNameGenerator
in interface ReportProcessTask
public void setBodyNameGenerator(org.pentaho.reporting.libraries.repository.NameGenerator bodyNameGenerator)
setBodyNameGenerator
in interface ReportProcessTask
bodyNameGenerator
- the name generator.public MasterReport getReport()
getReport
in interface ReportProcessTask
public void setReport(MasterReport report)
setReport
in interface ReportProcessTask
report
- the report.public void addReportProgressListener(ReportProgressListener listener)
addReportProgressListener
in interface ReportProcessTask
listener
- the listener.public void removeReportProgressListener(ReportProgressListener listener)
removeReportProgressListener
in interface ReportProcessTask
listener
- the listener.public Throwable getError()
getError
in interface ReportProcessTask
null
if there was no error.public boolean isTaskAborted()
isTaskAborted
in interface ReportProcessTask
public boolean isTaskSuccessful()
isTaskSuccessful
in interface ReportProcessTask
public boolean isValid()
isValid
in interface ReportProcessTask
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |