public abstract class AbstractReportProcessTask extends Object implements ReportProcessTask
Modifier | Constructor and Description |
---|---|
protected |
AbstractReportProcessTask() |
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.
|
protected ReportProgressListener[] |
getReportProgressListeners()
Returns all progress listeners that are registered on this ProcessTask implementation.
|
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 bodyContentLocation)
Defines the content location (and implicitly the repository) for the generated report document.
|
void |
setBodyNameGenerator(NameGenerator bodyNameGenerator)
Defines the body name generator, that generates name sequences in case the target name is already taken.
|
protected void |
setError(Throwable error)
Updates the error cause.
|
void |
setReport(MasterReport report)
Defines the report that will be executed in this task.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getReportMimeType
public ContentLocation getBodyContentLocation()
getBodyContentLocation
in interface ReportProcessTask
public void setBodyContentLocation(ContentLocation bodyContentLocation)
setBodyContentLocation
in interface ReportProcessTask
bodyContentLocation
- the content location for the report document.public NameGenerator getBodyNameGenerator()
getBodyNameGenerator
in interface ReportProcessTask
public void setBodyNameGenerator(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.protected ReportProgressListener[] getReportProgressListeners()
public Throwable getError()
getError
in interface ReportProcessTask
null
if there was no error.protected void setError(Throwable error)
error
- the error.public boolean isTaskAborted()
isTaskAborted
in interface ReportProcessTask
public boolean isTaskSuccessful()
isTaskSuccessful
in interface ReportProcessTask
public boolean isValid()
isValid
in interface ReportProcessTask
Copyright © 2017 Hitachi Vantara. All rights reserved.