interface Report : Serializable, Configurable
A file based report to be created.
Tasks that produce reports expose instances of this type for configuration via the Reporting interface.
class OutputType
The type of output the report produces |
static val NAMER: Namer<Report> |
abstract fun getDestination(): File
The location on the filesystem of the report when it is generated. Depending on the Subtypes may implement setters for the destination. |
|
abstract fun getDisplayName(): String
A more descriptive name of this report. Used when the report is referenced for end users. |
|
abstract fun getName(): String
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
|
|
abstract fun getOutputType(): OutputType
The type of output that the report generates. |
|
abstract fun isEnabled(): Boolean
Whether or not this report should be generated by whatever generates it. If |
|
abstract fun setEnabled(enabled: Boolean): Unit
Whether or not this report should be generated by whatever generates it. |
interface ConfigurableReport : Report
A file based report to be created with a configurable destination. |