public interface ReportProcessTask extends Runnable
Modifier and Type | Method and Description |
---|---|
void |
addReportProgressListener(ReportProgressListener listener)
Adds a report progress listener that is able to monitor the export progress.
|
ContentLocation |
getBodyContentLocation()
Returns the content location for the generated document.
|
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.
|
String |
getReportMimeType()
Returns the export tasks document mime type.
|
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(ContentLocation body)
Defines the content location (and implicitly the repository) for the generated report document.
|
void |
setBodyNameGenerator(NameGenerator nameGenerator)
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.
|
void setBodyContentLocation(ContentLocation body)
body
- the content location for the report document.ContentLocation getBodyContentLocation()
void setBodyNameGenerator(NameGenerator nameGenerator)
nameGenerator
- the name generator.NameGenerator getBodyNameGenerator()
void setReport(MasterReport report)
report
- the report.MasterReport getReport()
void addReportProgressListener(ReportProgressListener listener)
listener
- the listener.void removeReportProgressListener(ReportProgressListener listener)
listener
- the listener.String getReportMimeType()
Throwable getError()
null
if there was no error.boolean isTaskAborted()
boolean isTaskSuccessful()
boolean isValid()
Copyright © 2002–2017 Pentaho Corporation. All rights reserved.