To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
A single ranked entry in a leaderboard, attributing an amount to a participant. The rank is zero indexed, and zero is the highest or lowest result as appropriate for the method which produced the ranking. The participant is either an organisation, as OrgData, or a profile, as ExtProfileBean, depending on the series' sales type - exactly one of getOrg or getProfile is non-null.
Properties
| Property | Returns | Description |
|---|---|---|
| amount | BigDecimal | The value this ranking is ordered by, ie the sum or value used to place the participant in the leaderboard. |
| baseline | BigDecimal | The baseline amount subtracted from the raw amount to produce this ranking's amount, when this ranking was built with a raw amount and baseline. Not populated by highestResults or lowestResults. |
| fields | Map<String,String> | The series' extra field values captured for the underlying record, keyed by field name. |
| org | OrgData | The organisation this ranking is attributed to, when the series' sales type attributes records to organisations rather than profiles. |
| participant | Object | The participant this ranking is attributed to: the organisation if getOrg is set, otherwise the profile. |
| profile | ExtProfileBean | The profile this ranking is attributed to, when the series' sales type attributes records to individual profiles rather than organisations. |
| rank | int | This entry's zero-indexed position within the leaderboard. Zero is the best result, as determined by whichever of highestResults or lowestResults produced this ranking. |
| rawAmount | BigDecimal | The unadjusted amount for this ranking, before any baseline is subtracted, when this ranking was built with a raw amount and baseline. Not populated by highestResults or lowestResults. |
Methods
getOrg()
Returns: OrgData
The organisation this ranking is attributed to, when the series' sales type attributes records to organisations rather than profiles.
getProfile()
Returns: ExtProfileBean
The profile this ranking is attributed to, when the series' sales type attributes records to individual profiles rather than organisations.
getRank()
Returns: int
This entry's zero-indexed position within the leaderboard. Zero is the best result, as determined by whichever of highestResults or lowestResults produced this ranking.
getParticipant()
Returns: Object
The participant this ranking is attributed to: the organisation if getOrg is set, otherwise the profile.
getAmount()
Returns: BigDecimal
The value this ranking is ordered by, ie the sum or value used to place the participant in the leaderboard.
getFields()
Returns: Map<String,String>
The series' extra field values captured for the underlying record, keyed by field name.
getRawAmount()
Returns: BigDecimal
The unadjusted amount for this ranking, before any baseline is subtracted, when this ranking was built with a raw amount and baseline. Not populated by highestResults or lowestResults.
getBaseline()
Returns: BigDecimal
The baseline amount subtracted from the raw amount to produce this ranking's amount, when this ranking was built with a raw amount and baseline. Not populated by highestResults or lowestResults.
© 2025 Kademi Ltd