A file based report to be created.
Tasks that produce reports expose instances of this type for configuration via the Reporting interface.
Modifiers | Name | Description |
---|---|---|
enum |
Report.OutputType |
The type of output the report produces |
Modifiers | Name | Description |
---|---|---|
Namer<Report> |
NAMER |
Type | Name and description |
---|---|
File |
getDestination() The location on the filesystem of the report when it is generated. |
String |
getDisplayName() A more descriptive name of this report. |
String |
getName() The symbolic name of this report. |
Report.OutputType |
getOutputType() A file based report to be created. |
boolean |
isEnabled() Whether or not this report should be generated by whatever generates it. |
void |
setEnabled(boolean enabled) Whether or not this report should be generated by whatever generates it. |
The location on the filesystem of the report when it is generated.
Depending on the output type of the report, this may point to a file or a directory.
Subtypes may implement setters for the destination.
A more descriptive name of this report. Used when the report is referenced for end users.
The symbolic name of this report.
The name of the report usually indicates the format (e.g. XML, HTML etc.) but can be anything.
When part of a ReportContainer, reports are accessed via their name. That is, given a report container variable
named reports
containing a report who's getName()
returns "html"
, the report could be accessed
via:
reports.html
A file based report to be created.
Tasks that produce reports expose instances of this type for configuration via the Reporting interface.
Whether or not this report should be generated by whatever generates it.
If true
, the generator of this report will generate it at the appropriate time.
If false
, the generator of this report will not generate this report.
Whether or not this report should be generated by whatever generates it.
enabled
- Whether or not this report should be generated by whatever generates it.