Projects a participant's likely final value and level for a recognition period from their actual value so far and the proportion of the period that has elapsed, so a UI can show progress on track towards a level before the period ends.


Properties

PropertyReturnsDescription
endDateDateThe end date of the period this projection is for.
periodElapsedPercentdoubleThe proportion of the period elapsed as of the projection's reference date, as a percentage.
periodElapsedProportiondoubleThe proportion of the period elapsed as of the projection's reference date, as a fraction between 0 and 1 (or beyond 1 if the reference date is after the period ends).
projectedValueBigDecimalThe participant's actual value projected out to the end of the period, extrapolated linearly from their actual value so far and the proportion of the period elapsed. Null if there is no actual value, or if the reference date is at or before the period's start (nothing has elapsed yet to project from).
startDateDateThe start date of the period this projection is for.

Methods

getStartDate() · getEndDate() · getPeriodElapsedProportion() · getPeriodElapsedPercent() · getProjectedValue() · levelAmount(RecognitionLevel level) · projectedPercentOfLevel(RecognitionLevel level) · percentOfLevel(RecognitionLevel level) · onTrack(RecognitionLevel level) · onTrack(BigDecimal levelValue)

getStartDate()

Returns: Date

The start date of the period this projection is for.

getEndDate()

Returns: Date

The end date of the period this projection is for.

getPeriodElapsedProportion()

Returns: double

The proportion of the period elapsed as of the projection's reference date, as a fraction between 0 and 1 (or beyond 1 if the reference date is after the period ends).

getPeriodElapsedPercent()

Returns: double

The proportion of the period elapsed as of the projection's reference date, as a percentage.

getProjectedValue()

Returns: BigDecimal

The participant's actual value projected out to the end of the period, extrapolated linearly from their actual value so far and the proportion of the period elapsed. Null if there is no actual value, or if the reference date is at or before the period's start (nothing has elapsed yet to project from).

levelAmount(RecognitionLevel level)

Returns: BigDecimal

The participant-specific amount at which the given level is reached, within this projection's period.

ParameterDescription
levelthe level to find the amount for

projectedPercentOfLevel(RecognitionLevel level)

Returns: Double

The projected end-of-period value as a percentage of the given level's participant-specific amount.

ParameterDescription
levelthe level to calculate the percentage against

percentOfLevel(RecognitionLevel level)

Returns: Double

The participant's actual value so far as a percentage of the given level's participant-specific amount.

ParameterDescription
levelthe level to calculate the percentage against

onTrack(RecognitionLevel level)

Returns: Boolean

Whether the participant is on track to reach the given level by the end of the period, based on their projected value.

ParameterDescription
levelthe level to check

onTrack(BigDecimal levelValue)

Returns: Boolean

Whether the participant is on track to reach the given amount by the end of the period, based on their projected value.

ParameterDescription
levelValuethe amount to check against
To get full access to the Kademi Hub existing customers can login here, or new customers can register here.