Reporting Table which lists the postal addresses stored against users and organisations in the current account. Registered as one of UserApp's built-in tables so it can be selected as a data source when building a report or export, alongside the address entities themselves.
Implements: Table
Properties
| Property | Returns | Description |
|---|---|---|
| description | String | Human readable description of this table, shown to a report author when choosing a table. |
| headers | List<String> | Column header labels for this table, matching the cell order produced by getRows. |
| tableId | String | Fixed id this table is registered and looked up under. |
Inherited from Table
Methods
getRows(int start, Integer maxRows)
Returns: RowsResult
Reads a page of rows starting at the given row, discarding any progress status. Delegates to the three argument overload with a status callback that does nothing.
| Parameter | Description |
|---|---|
start | the zero based index of the first row to return |
maxRows | the maximum number of rows to return, or null for no limit |
getRows(int start, Integer maxRows, Consumer<String> status, Map<String,Object> extraParams)
Returns: RowsResult
Reads a page of rows, optionally taking extra parameters that a specific table implementation can use to filter its results. The default implementation ignores extraParams and reads from row zero rather than the given start; implementations that use extraParams override this method directly.
| Parameter | Description |
|---|---|
start | the zero based index of the first row to return; not used by the default implementation |
maxRows | the maximum number of rows to return, or null for no limit |
status | callback invoked with progress messages while the rows are being read |
extraParams | implementation specific filter parameters; not used by the default implementation |
supportsPagination()
Returns: boolean
Whether this table supports paged reads via the start and maxRows parameters of getRows. A table that returns false always returns its full result set regardless of the paging parameters supplied.
Methods
getTableId()
Returns: String
Fixed id this table is registered and looked up under.
getDescription()
Returns: String
Human readable description of this table, shown to a report author when choosing a table.
getHeaders()
Returns: List<String>
Column header labels for this table, matching the cell order produced by getRows.
getRows(int start, Integer maxRows, Consumer<String> status)
Returns: RowsResult
Reads a page of address rows for the current admin organisation from the database. Each row covers one EntityAddress, with the owning profile or organisation's name and every field of the linked Address. When maxRows is null all addresses for the organisation are returned; otherwise the rows are read starting at the given offset using the standard search paging.
| Parameter | Description |
|---|---|
start | the zero based index of the first row to return, ignored when maxRows is null |
maxRows | the maximum number of rows to return, or null to return every address for the organisation |
status | callback invoked with progress messages while the rows are being read; not used by this implementation |