An administrator defined CSV report over one source of data, held against an organisation. The source class names the kind of record the report runs over, and the optional field set holds the columns to collect as name and value pairs, where the name is the field to read and the value is the column heading.
Group: Database Entities
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| fieldset | NvSet | Optional set of name and value pairs describing the columns to collect, where each name is a field of the source record and each value is the heading to use for it. Null when the report has not had its columns chosen yet. |
| id | long | Database identifier for this report, assigned when the row is first saved. |
| name | String | The auto-assigned, path-safe identifier for the report. It is derived from the title when the report is created, but is immutable from a user's perspective and is what URLs and lookups use. |
| sourceClass | String | Names the kind of record the report runs over, which decides what fields are available as columns. Null until a source has been chosen. |
| title | String | Free text title of the report as entered by the administrator, used as the display label. Required, and carries no uniqueness guarantee. |
Methods
getId()
Returns: long
Database identifier for this report, assigned when the row is first saved.
getTitle()
Returns: String
Free text title of the report as entered by the administrator, used as the display label. Required, and carries no uniqueness guarantee.
getSourceClass()
Returns: String
Names the kind of record the report runs over, which decides what fields are available as columns. Null until a source has been chosen.
getName()
Returns: String
The auto-assigned, path-safe identifier for the report. It is derived from the title when the report is created, but is immutable from a user's perspective and is what URLs and lookups use.
getFieldset()
Returns: NvSet
Optional set of name and value pairs describing the columns to collect, where each name is a field of the source record and each value is the heading to use for it. Null when the report has not had its columns chosen yet.