|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ReportProcessTask
A report task is a generic way to create documents of a certain type from a report object. A task encapsulates all implementation details necessary to perform a generic export. All reports are expected to be written to a repository implementation, which can be a filesystem or any other document storage facility.
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. |
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(org.pentaho.reporting.libraries.repository.ContentLocation body)
Defines the content location (and implicitly the repository) for the generated report document. |
void |
setBodyNameGenerator(org.pentaho.reporting.libraries.repository.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. |
Methods inherited from interface java.lang.Runnable |
---|
run |
Method Detail |
---|
void setBodyContentLocation(org.pentaho.reporting.libraries.repository.ContentLocation body)
body
- the content location for the report document.org.pentaho.reporting.libraries.repository.ContentLocation getBodyContentLocation()
void setBodyNameGenerator(org.pentaho.reporting.libraries.repository.NameGenerator nameGenerator)
nameGenerator
- the name generator.org.pentaho.reporting.libraries.repository.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()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |