Snapshot of a participant's progress through a RecognitionTopic's levels, as calculated by RecognitionService. Reports the participant's current and next level, their current achieved value, and how far they have progressed between the current level's threshold and the next level's threshold, both as a raw amount and as a percentage.
Properties
| Property | Returns | Description |
|---|---|---|
| currentLevel | RecognitionLevel | The level the participant currently holds an award for, if any. |
| currentVal | BigDecimal | The participant's current achieved value for the topic. |
| levelA | BigDecimal | The threshold value at which the current level starts. |
| levelB | BigDecimal | The threshold value at which the next level starts. |
| levelSize | BigDecimal | The size of the band between the current level's threshold and the next level's threshold. |
| messages | String | A message explaining why percentage could not be calculated, eg when the level amount is zero. |
| nextLevel | RecognitionLevel | The next level the participant is progressing towards. |
| percentage | BigDecimal | The participant's progress through the band from the current level to the next level, as a percentage. |
| progress | BigDecimal | How far the participant has progressed past the current level's threshold, as a raw amount. |
Methods
getCurrentLevel() · getLevelA() · getLevelB() · getLevelSize() · getNextLevel() · getPercentage() · getProgress() · getCurrentVal() · getMessages()
getCurrentLevel()
Returns: RecognitionLevel
The level the participant currently holds an award for, if any.
getLevelA()
Returns: BigDecimal
The threshold value at which the current level starts.
getLevelB()
Returns: BigDecimal
The threshold value at which the next level starts.
getLevelSize()
Returns: BigDecimal
The size of the band between the current level's threshold and the next level's threshold.
getNextLevel()
Returns: RecognitionLevel
The next level the participant is progressing towards.
getPercentage()
Returns: BigDecimal
The participant's progress through the band from the current level to the next level, as a percentage.
getProgress()
Returns: BigDecimal
How far the participant has progressed past the current level's threshold, as a raw amount.
getCurrentVal()
Returns: BigDecimal
The participant's current achieved value for the topic.
getMessages()
Returns: String
A message explaining why percentage could not be calculated, eg when the level amount is zero.