Table listing every promotion entry recorded for the current organisation, one row per entry showing the entrant's identifying details. Registered with the query engine as a Table so it can be looked up by id and read from reports and exports. Rows are read a page at a time from RewardEntry, scoped to the current organisation.

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: the entrant's first name, surname, email and phone number.
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

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.

ParameterDescription
startthe zero based index of the first row to return; not used by the default implementation
maxRowsthe maximum number of rows to return, or null for no limit
statuscallback invoked with progress messages while the rows are being read
extraParamsimplementation 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 what this table returns, shown to a report author when choosing a table.

getHeaders()

Returns: List<String>

Column header labels for this table: the entrant's first name, surname, email and phone number.

getRows(int start, Integer maxRows, Consumer<String> status)

Returns: RowsResult

Reads a page of reward entries for the current organisation, one row per entry with the entrant's first name, surname, email and phone number.

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
To get full access to the Kademi Hub existing customers can login here, or new customers can register here.