One level in a participant's level ladder: a level paired with the next level up, the participant's current value, and the points calculated for reaching this level, so a UI can render the range a participant must cross to advance and how close they are to it.
Properties
| Property | Returns | Description |
|---|---|---|
| aboveLevel | boolean | Whether the participant's current value has reached or passed this level's participant-specific threshold. False if the threshold could not be calculated, for example because no points bucket is configured for the level. |
| aboveNextLevel | boolean | Whether the participant's current value has reached or passed the next level's participant-specific threshold. False if there is no next level, or if its threshold could not be calculated. |
| nextLevel | RecognitionLevel | The next level up from this one, or null if this is the highest level in the topic. |
| nextLevelAmount | BigDecimal | The participant-specific amount at which the next level is reached, or null if there is no next level or it could not be calculated. |
| points | BigDecimal | The points calculated for reaching this level - not necessarily what has actually been awarded, see RecognitionManager#calcActualPointsAwarded for that. |
| pointsNarrative | Narrative | The narrative explaining how this level's points were calculated, useful for diagnosing why a level awards the points it does. |
| progressPerc | Integer | The participant's progress towards the next level, as a whole-number percentage of the distance between this level and the next. Null if there is no next level (or this level has no threshold to measure from), or if the participant has not yet started progressing towards this level. |
| thisLevel | RecognitionLevel | The level this summary item is for. |
| thisLevelAmount | BigDecimal | The participant-specific amount at which this level is reached, or null if it could not be calculated. |
Methods
isAboveLevel() · isAboveNextLevel() · getProgressPerc() · getPoints() · getPointsNarrative() · getThisLevel() · getNextLevel() · getThisLevelAmount() · getNextLevelAmount()
isAboveLevel()
Returns: boolean
Whether the participant's current value has reached or passed this level's participant-specific threshold. False if the threshold could not be calculated, for example because no points bucket is configured for the level.
isAboveNextLevel()
Returns: boolean
Whether the participant's current value has reached or passed the next level's participant-specific threshold. False if there is no next level, or if its threshold could not be calculated.
getProgressPerc()
Returns: Integer
The participant's progress towards the next level, as a whole-number percentage of the distance between this level and the next. Null if there is no next level (or this level has no threshold to measure from), or if the participant has not yet started progressing towards this level.
getPoints()
Returns: BigDecimal
The points calculated for reaching this level - not necessarily what has actually been awarded, see RecognitionManager#calcActualPointsAwarded for that.
getPointsNarrative()
Returns: Narrative
The narrative explaining how this level's points were calculated, useful for diagnosing why a level awards the points it does.
getThisLevel()
Returns: RecognitionLevel
The level this summary item is for.
getNextLevel()
Returns: RecognitionLevel
The next level up from this one, or null if this is the highest level in the topic.
getThisLevelAmount()
Returns: BigDecimal
The participant-specific amount at which this level is reached, or null if it could not be calculated.
getNextLevelAmount()
Returns: BigDecimal
The participant-specific amount at which the next level is reached, or null if there is no next level or it could not be calculated.