To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Deprecated aggregate view of a single participant's own progress in a reward: their points history and reward entries, and how those compare to their team and to everyone else connected to the reward. Each property runs its own separate database query, which makes this class expensive to use at scale.
Properties
| Property | Returns | Description |
|---|---|---|
| allMemberPoints | List<TeamMemberPoints> | A leaderboard of all participants connected to this reward, not just those in this user's own organisation, within the since and to date bounds and limited to the max size passed to the constructor. |
| extendedProfiles | boolean | Whether leaderboard entries expose extended profile fields such as first name and surname. |
| hasPoints | boolean | Whether this reward has a points system configured. |
| mostPoints | Double | The greatest points total earned by any one member of this user's team for this reward. Populated as a side effect of building the team leaderboard. |
| myEntries | List<MyRewardEntry> | The non-points reward entries (such as gift vouchers or prize draw entries) awarded to this user for this reward. |
| myPercent | double | This user's points total as a percentage of the greatest points total earned by anyone in their organisation for this reward, as returned by getMostPoints. |
| myPointDebits | List<MyPointsDebitInfo> | The individual points debits for this user in this reward, within the since and to date bounds. |
| myPoints | List<MyPointsInfo> | The individual points awards for this user in this reward, within the since and to date bounds. |
| myPointsTotal | double | The total of all points earned by this user in this reward, within the since and to date bounds. |
| myRank | RankAndPoints | The rank and points of the currently logged in user in the reward-wide leaderboard. |
| myTeam | Organisation | Find which of this user's memberships is for a group with access to this reward, then use the org associated with that |
| pointsByReason | Map<String,Double> | Totals this user's points awards by reason, using getMyPoints as the source data. |
| requiredGroups | List<Group> | Groups a team member must belong to in every one to be included in the results of getTeamMemberPoints and getAllMemberPoints, as added by addRequiredGroup. |
| reward | Reward | The reward this info is scoped to. |
| since | Date | The date this info starts counting points from. |
| summedPointsByProfile | List<EntityAndPoints> | The points earned by each member of this user's team for this reward, summed per participant, within the since and to date bounds. |
| teamMemberPoints | List<TeamMemberPoints> | A leaderboard of the top points earners in this user's team (the organisation returned by their group membership relevant to this reward), within the since and to date bounds and limited to the max team size passed to the constructor. |
| teamName | String | The display name of this user's team organisation for this reward. |
| teamPointsRaw | List<Points> | The unaggregated individual Points records earned by this user's team for this reward, within the since and to date bounds. |
| to | Date | The date this info stops counting points at. |
| totalTeamPoints | Double | The combined points total earned by every member of this user's team, summing the team leaderboard. |
Methods
getMyEntries() · getSince() · getTo() · getReward() · getRequiredGroups() · getMyPointsTotal() · myPointsTotal(String tagname) · getMyPoints() · getMyPointDebits() · getPointsByReason() · getMyPercent() · getTeamMemberPoints() · getAllMemberPoints() · allMemberPoints(String tagname) · rank(ProfileBean p) · rank(OrgData orgData) · getMyRank() · rankInTeam(ProfileBean p) · rankInTeam(OrgData org) · getSummedPointsByProfile() · getTeamPointsRaw() · getMostPoints() · getTotalTeamPoints() · getTeamName() · isHasPoints() · addRequiredGroup(String groupName) · isExtendedProfiles() · setExtendedProfiles(boolean extendedProfiles)
getMyEntries()
Returns: List<MyRewardEntry>
The non-points reward entries (such as gift vouchers or prize draw entries) awarded to this user for this reward.
getSince()
Returns: Date
The date this info starts counting points from.
getTo()
Returns: Date
The date this info stops counting points at.
getReward()
Returns: Reward
The reward this info is scoped to.
getRequiredGroups()
Returns: List<Group>
Groups a team member must belong to in every one to be included in the results of getTeamMemberPoints and getAllMemberPoints, as added by addRequiredGroup.
getMyPointsTotal()
Returns: double
The total of all points earned by this user in this reward, within the since and to date bounds.
myPointsTotal(String tagname)
Returns: int
The total points earned by this user across the current tenant organisation, optionally restricted to points tagged with the given tag name.
| Parameter | Description |
|---|---|
tagname | the name of the points tag to restrict the total to, or null for no restriction |
getMyPoints()
Returns: List<MyPointsInfo>
The individual points awards for this user in this reward, within the since and to date bounds.
getMyPointDebits()
Returns: List<MyPointsDebitInfo>
The individual points debits for this user in this reward, within the since and to date bounds.
getPointsByReason()
Returns: Map<String,Double>
Totals this user's points awards by reason, using getMyPoints as the source data.
getMyPercent()
Returns: double
This user's points total as a percentage of the greatest points total earned by anyone in their organisation for this reward, as returned by getMostPoints.
getTeamMemberPoints()
Returns: List<TeamMemberPoints>
A leaderboard of the top points earners in this user's team (the organisation returned by their group membership relevant to this reward), within the since and to date bounds and limited to the max team size passed to the constructor.
getAllMemberPoints()
Returns: List<TeamMemberPoints>
A leaderboard of all participants connected to this reward, not just those in this user's own organisation, within the since and to date bounds and limited to the max size passed to the constructor.
allMemberPoints(String tagname)
Returns: List<TeamMemberPoints>
A leaderboard of all participants connected to this reward, restricted to points tagged with the given tag name. The special value "none", not case sensitive, restricts the leaderboard to points with no tag at all.
| Parameter | Description |
|---|---|
tagname | the name of the points tag to restrict the leaderboard to, "none" for untagged points, or null for the given tag name to be looked up and found missing |
rank(ProfileBean p)
Returns: RankAndPoints
The rank and points of the given profile in the reward-wide leaderboard (as returned by getAllMemberPoints with no tag filter).
| Parameter | Description |
|---|---|
p | the profile to find the rank of |
rank(OrgData orgData)
Returns: RankAndPoints
The rank and points of the given organisation in the reward-wide leaderboard (as returned by getAllMemberPoints with no tag filter).
| Parameter | Description |
|---|---|
orgData | the organisation to find the rank of |
getMyRank()
Returns: RankAndPoints
The rank and points of the currently logged in user in the reward-wide leaderboard.
rankInTeam(ProfileBean p)
Returns: RankAndPoints
The rank and points of the given profile in their own team's leaderboard (as returned by getTeamMemberPoints).
| Parameter | Description |
|---|---|
p | the profile to find the rank of |
rankInTeam(OrgData org)
Returns: RankAndPoints
The rank and points of the given organisation in this user's team leaderboard (as returned by getTeamMemberPoints).
| Parameter | Description |
|---|---|
org | the organisation to find the rank of |
getSummedPointsByProfile()
Returns: List<EntityAndPoints>
The points earned by each member of this user's team for this reward, summed per participant, within the since and to date bounds.
getTeamPointsRaw()
Returns: List<Points>
The unaggregated individual Points records earned by this user's team for this reward, within the since and to date bounds.
getMostPoints()
Returns: Double
The greatest points total earned by any one member of this user's team for this reward. Populated as a side effect of building the team leaderboard.
getTotalTeamPoints()
Returns: Double
The combined points total earned by every member of this user's team, summing the team leaderboard.
getTeamName()
Returns: String
The display name of this user's team organisation for this reward.
isHasPoints()
Returns: boolean
Whether this reward has a points system configured.
addRequiredGroup(String groupName)
Returns: void
Adds a group that team members must belong to in order to be included in the results of getTeamMemberPoints and getAllMemberPoints. Can be called multiple times to require membership of several groups.
| Parameter | Description |
|---|---|
groupName | the name of the group, resolved within the reward's organisation |
isExtendedProfiles()
Returns: boolean
Whether leaderboard entries expose extended profile fields such as first name and surname.
setExtendedProfiles(boolean extendedProfiles)
Returns: void
Sets whether leaderboard entries should expose extended profile fields such as first name and surname, instead of just the basic profile fields.
| Parameter | Description |
|---|---|
extendedProfiles | true to include extended profile fields, false for basic fields only |
© 2025 Kademi Ltd