To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Defines a single custom report registered by an app, produced either from a query table or from a JS function that writes the export content. Instances are created by ControllerMappingList's report builder methods and appear as a downloadable attachment, such as a CSV, alongside the app's other resources.
Group: Reports
Implements: TemplateReport, Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| attachmentContentType | String | MIME type of the generated attachment, for example text/csv. May be null. |
| attachmentExtension | String | File extension used for the generated attachment, for example csv. May be null. |
| config | Map<String,String> | The configuration values the report was registered with, keyed by name. Never null, may be empty. |
| description | String | Free text description of what the report contains, as supplied when the report was registered. May be null. |
| function | String | Name of the JS function invoked to generate the attachment content, when the report is backed by a named function rather than a query table or a direct function reference. May be null. |
| functionPtr | VarArgFunction | Direct reference to the JS function invoked to generate the attachment content, when the report was registered with an actual function rather than a function name. May be null. |
| queryTableId | String | Identifier of the query table used to source the attachment's rows, when the report is backed by a query table rather than a JS function. May be null. |
| reportId | String | Unique identifier for this report, matching the reportId it was registered with. Used as the lookup key and in the URL of the generated attachment. |
| reportTemplate | String | Name of the template used to render the report's own page, as distinct from the generated attachment. May be null if the report has no page of its own. |
Methods
getReportId() · getDescription() · getReportTemplate() · getConfig() · getFunction() · getFunctionPtr() · getQueryTableId() · getAttachmentContentType() · getAttachmentExtension()
getReportId()
Returns: String
Unique identifier for this report, matching the reportId it was registered with. Used as the lookup key and in the URL of the generated attachment.
getDescription()
Returns: String
Free text description of what the report contains, as supplied when the report was registered. May be null.
getReportTemplate()
Returns: String
Name of the template used to render the report's own page, as distinct from the generated attachment. May be null if the report has no page of its own.
getConfig()
Returns: Map<String,String>
The configuration values the report was registered with, keyed by name. Never null, may be empty.
getFunction()
Returns: String
Name of the JS function invoked to generate the attachment content, when the report is backed by a named function rather than a query table or a direct function reference. May be null.
getFunctionPtr()
Returns: VarArgFunction
Direct reference to the JS function invoked to generate the attachment content, when the report was registered with an actual function rather than a function name. May be null.
getQueryTableId()
Returns: String
Identifier of the query table used to source the attachment's rows, when the report is backed by a query table rather than a JS function. May be null.
getAttachmentContentType()
Returns: String
MIME type of the generated attachment, for example text/csv. May be null.
getAttachmentExtension()
Returns: String
File extension used for the generated attachment, for example csv. May be null.
© 2025 Kademi Ltd