To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Fluent builder for searching a tenant's points transactions, ie its Points and PointsDebit records. Created via PointsManager.newPointsTransactionsSearch(), configured with filter methods such as participant(), reward() and from()/to(), then executed with search() to get the matching transactions and total count. Supports pagination and arbitrary sort fields via its searchProperties.
Group: Builders
Properties
| Property | Returns | Description |
|---|---|---|
| from | Date | The earliest issue date this builder's search is currently restricted to. |
| maxPoints | Long | The maximum points value this builder's search is currently restricted to. |
| minPoints | Long | The minimum points value this builder's search is currently restricted to. |
| r | Reward | The reward, ie points bucket, this builder's search is currently restricted to. |
| reasonCode | String | The debit reason code this builder's search is currently restricted to. |
| recordType | String | The record type this builder's search is currently restricted to. |
| searchProperties | SearchProperties | The paging and sort order currently applied to this builder's search. |
| searchQ | String | The free text search query currently set on this builder, matched against the participant's name, org id or the transaction's reason. |
| tagId | String | The points tag id this builder's search is currently restricted to. |
| to | Date | The latest issue date this builder's search is currently restricted to. |
Methods
search() · idRange(boolean v) · includeRows(boolean v) · participant(BaseEntity v) · searchQ(String v) · reward(Reward v) · reasonCode(String v) · tagId(String v) · from(Date v) · to(Date v) · minPoints(Long v) · maxPoints(Long v) · recordType(String v) · searchProperties(SearchProperties v) · getSearchQ() · setSearchQ(String searchQ) · getR() · setR(Reward r) · getReasonCode() · setReasonCode(String reasonCode) · getTagId() · setTagId(String tagId) · getFrom() · setFrom(Date from) · getTo() · setTo(Date to) · getMinPoints() · setMinPoints(Long minPoints) · getMaxPoints() · setMaxPoints(Long maxPoints) · getRecordType() · setRecordType(String recordType) · getSearchProperties() · setSearchProperties(SearchProperties searchProperties)
search()
Returns: ListAndCount
Executes this search against the tenant's points transactions using the filters and paging configured on this builder.
idRange(boolean v)
Returns: PointsTransactionsSearchBuilder
Sets whether the search results should include the minimum and maximum matching record ids as attributes of the result, instead of just the aggregated data.
| Parameter | Description |
|---|---|
v | true to include the min/max matching ids |
includeRows(boolean v)
Returns: PointsTransactionsSearchBuilder
Sets whether the search results should include the individual matching rows, or just the aggregated data.
| Parameter | Description |
|---|---|
v | true to include the individual matching rows, false to return only aggregated data |
participant(BaseEntity v)
Returns: PointsTransactionsSearchBuilder
Restricts the search to transactions for the given participant.
| Parameter | Description |
|---|---|
v | the participant to restrict the search to |
searchQ(String v)
Returns: PointsTransactionsSearchBuilder
Restricts the search to transactions matching the given free text query, against the participant's name, org id or the transaction's reason.
| Parameter | Description |
|---|---|
v | the free text search query, may be blank |
reward(Reward v)
Returns: PointsTransactionsSearchBuilder
Restricts the search to transactions against the given reward, ie points bucket.
| Parameter | Description |
|---|---|
v | the reward to restrict the search to |
reasonCode(String v)
Returns: PointsTransactionsSearchBuilder
Restricts the search to debits with the given reason code. Use "NONE" to match debits with no reason code. Cannot be combined with tagId.
| Parameter | Description |
|---|---|
v | the reason code to restrict debit results to, may be blank |
tagId(String v)
Returns: PointsTransactionsSearchBuilder
Restricts the search to credits with the given points tag id. Use "NONE" to match credits with no tag. Cannot be combined with reasonCode.
| Parameter | Description |
|---|---|
v | the points tag id to restrict credit results to, may be blank |
from(Date v)
Returns: PointsTransactionsSearchBuilder
Restricts the search to transactions issued on or after the given date.
| Parameter | Description |
|---|---|
v | the earliest issue date to include, may be null |
to(Date v)
Returns: PointsTransactionsSearchBuilder
Restricts the search to transactions issued on or before the given date.
| Parameter | Description |
|---|---|
v | the latest issue date to include, may be null |
minPoints(Long v)
Returns: PointsTransactionsSearchBuilder
Restricts the search to transactions with at least the given number of points.
| Parameter | Description |
|---|---|
v | the minimum points value to include, may be null |
maxPoints(Long v)
Returns: PointsTransactionsSearchBuilder
Restricts the search to transactions with at most the given number of points.
| Parameter | Description |
|---|---|
v | the maximum points value to include, may be null |
recordType(String v)
Returns: PointsTransactionsSearchBuilder
Restricts the search to a single kind of record: "C" for credits only, or "D" for debits only.
| Parameter | Description |
|---|---|
v | "C" for credits only, "D" for debits only, or blank to include both |
searchProperties(SearchProperties v)
Returns: PointsTransactionsSearchBuilder
Sets the paging and sort order to apply to the search results.
| Parameter | Description |
|---|---|
v | the paging and sort properties to apply |
getSearchQ()
Returns: String
The free text search query currently set on this builder, matched against the participant's name, org id or the transaction's reason.
setSearchQ(String searchQ)
Returns: void
Sets the free text search query for this builder.
| Parameter | Description |
|---|---|
searchQ | the free text search query |
getR()
Returns: Reward
The reward, ie points bucket, this builder's search is currently restricted to.
setR(Reward r)
Returns: void
Sets the reward this builder's search is restricted to.
| Parameter | Description |
|---|---|
r | the reward to restrict the search to |
getReasonCode()
Returns: String
The debit reason code this builder's search is currently restricted to.
setReasonCode(String reasonCode)
Returns: void
Sets the debit reason code this builder's search is restricted to.
| Parameter | Description |
|---|---|
reasonCode | the reason code to restrict debit results to |
getTagId()
Returns: String
The points tag id this builder's search is currently restricted to.
setTagId(String tagId)
Returns: void
Sets the points tag id this builder's search is restricted to.
| Parameter | Description |
|---|---|
tagId | the points tag id to restrict credit results to |
getFrom()
Returns: Date
The earliest issue date this builder's search is currently restricted to.
setFrom(Date from)
Returns: void
Sets the earliest issue date this builder's search is restricted to.
| Parameter | Description |
|---|---|
from | the earliest issue date to include |
getTo()
Returns: Date
The latest issue date this builder's search is currently restricted to.
setTo(Date to)
Returns: void
Sets the latest issue date this builder's search is restricted to.
| Parameter | Description |
|---|---|
to | the latest issue date to include |
getMinPoints()
Returns: Long
The minimum points value this builder's search is currently restricted to.
setMinPoints(Long minPoints)
Returns: void
Sets the minimum points value this builder's search is restricted to.
| Parameter | Description |
|---|---|
minPoints | the minimum points value to include |
getMaxPoints()
Returns: Long
The maximum points value this builder's search is currently restricted to.
setMaxPoints(Long maxPoints)
Returns: void
Sets the maximum points value this builder's search is restricted to.
| Parameter | Description |
|---|---|
maxPoints | the maximum points value to include |
getRecordType()
Returns: String
The record type this builder's search is currently restricted to.
setRecordType(String recordType)
Returns: void
Sets the record type this builder's search is restricted to.
| Parameter | Description |
|---|---|
recordType | "C" for credits only, "D" for debits only, or blank for both |
getSearchProperties()
Returns: SearchProperties
The paging and sort order currently applied to this builder's search.
setSearchProperties(SearchProperties searchProperties)
Returns: void
Sets the paging and sort order to apply to this builder's search.
| Parameter | Description |
|---|---|
searchProperties | the paging and sort properties to apply |
© 2025 Kademi Ltd