Table listing participants who have points expiring within the next 90 days, one row per participant with a set of expiry columns repeated for each reward they hold a balance in. Registered with the query engine as a Table so it can be looked up by id and read from reports and exports. Rows are built by running the points balance calculator for each participant and reward, with expiry tracking switched on, and summing the points it reports as expired within the 90 day window. The optional rewardId extra parameter restricts the result to a single reward.
Implements: Table
Properties
| Property | Returns | Description |
|---|---|---|
| description | String | Human readable description of what this table returns, shown to a report author when choosing a table. |
| headers | List<String> | Column header labels for this table: participant identity columns followed by the expiring points, expiry date range and reward columns. |
| 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 |
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 what this table returns, shown to a report author when choosing a table.
getHeaders()
Returns: List<String>
Column header labels for this table: participant identity columns followed by the expiring points, expiry date range and reward columns.
getRows(int start, Integer maxRows, Consumer<String> status)
Returns: RowsResult
Reads a page of rows with no reward filter applied. Delegates to the four argument overload with extraParams set to null.
| 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 |
status | callback invoked with progress messages while the rows are being read |
getRows(int start, Integer maxRows, Consumer<String> status, Map<String,Object> extraParams)
Returns: RowsResult
Finds participants in the current tenant organisation with points due to expire in the 90 days following today, and builds one row per participant with expiry totals and date ranges for each reward they hold a balance in. If extraParams contains a rewardId entry the result is restricted to that reward.
| 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 |
status | callback invoked with progress messages while the rows are being read; not used by this implementation |
extraParams | optional filter parameters; a rewardId entry restricts the result to that reward |