Table listing points expiring within the next 90 days, one row per participant and reward combination rather than one row per participant. Registered with the query engine as a Table so it can be looked up by id and read from reports and exports. This is the successor to ExpiringPointsTable: where that table repeats expiry columns per reward on a single row, this table gives each participant and reward combination its own row, and widens the expiry window to start 7 days in the past. The optional rewardId extra parameter restricts the result to a single reward.

Implements: Table


Properties

PropertyReturnsDescription
descriptionStringHuman readable description of what this table returns, shown to a report author when choosing a table.
headersList<String>Column header labels for this table: participant identity columns followed by the expiring points, expiry date range and reward columns.
tableIdStringFixed 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.

ParameterDescription
startthe zero based index of the first row to return
maxRowsthe 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.

ParameterDescription
startthe zero based index of the first row to return
maxRowsthe maximum number of rows to return, or null for no limit
statuscallback 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 participant and reward combinations in the current tenant organisation with points due to expire between 7 days ago and 90 days from today, and builds one row per combination with the expiring total and date range for that reward. If extraParams contains a rewardId entry the result is restricted to that reward.

ParameterDescription
startthe zero based index of the first row to return
maxRowsthe maximum number of rows to return, or null for no limit
statuscallback invoked with progress messages while the rows are being read; not used by this implementation
extraParamsoptional filter parameters; a rewardId entry restricts the result to that reward
To get full access to the Kademi Hub existing customers can login here, or new customers can register here.