To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Properties
| Name | Returns | Notes | Example |
|---|---|---|---|
| appIndexers | List | ||
| allRecognitionPointsRuleTypes | List | ||
| topics | List | ||
| periodicTopics | List | ||
| recognitionService | RecognitionService |
Methods
| Name | Returns | Notes | Example |
|---|---|---|---|
| closePeriod ( period ) | void | ||
| findRecognitionPointsRuleType ( id ) | RecognitionPointsRuleType | ||
| calcCurrentValue ( topic, participant ) | BigDecimal | ||
| calcCurrentValueForPeriod ( period, participant ) | BigDecimal | ||
| findPeriodForDate ( topic, now, participant ) | RecognitionPeriod | Attempts to locate a RecognitionPeriod for which the given participant is elligible and covers the specified date Returns null if no suitable period can be found, or if the topic is not configured for periodicity | |
| periodLeaderboard ( period ) | RecognitionPeriodLeaderboard | ||
| findParticipants ( topic ) | Collection | ||
| findParticipantsForPeriod ( period ) | Collection | ||
| scanPeriod ( period ) | void | ||
| scanLevels ( topic, participant ) | void | ||
| scanLevels ( period, participant ) | void | ||
| getLevelStatus ( topic, participant ) | LevelStatus | ||
| scanLevels ( topic ) | void | Scan levels for the current user in this topic | |
| createAward ( recog, participant, awardedDate ) | RecognitionAward | ||
| findLevel ( topic, value ) | RecognitionLevel | Find the level which the given value just exceeds | |
| findLevelAmountForParticipant ( level, participant ) | BigDecimal | ||
| findLevelAmountForParticipant ( period, level, participant ) | BigDecimal | ||
| hasLevel ( topic, value ) | boolean | ||
| findBadgesForNomination ( nominator, topic ) | List | ||
| awardBadge ( badge, awardToEntity ) | RecognitionAward | First checks if the badge has been awarded, and if not awards it | |
| removeAwardBadge ( badge, awardToEntity ) | void | First checks if the badge has been awarded, and if have remove it | |
| getBadge ( id ) | RecognitionBadge | ||
| findPeriod ( id ) | RecognitionPeriod | ||
| findAward ( id ) | RecognitionAward | ||
| deleteRecognition ( recog ) | void | Physically deletes the recogtnition and any associated recognition awards | |
| getNomination ( id ) | RecognitionNomination | ||
| createNomination ( badge, nominee, nominator, reason ) | RecognitionNomination | ||
| createAssetForRecognition ( r, type ) | Asset | ||
| processNomination ( nomination, currentUser, accept ) | void | ||
| findTopic ( topicName ) | RecognitionTopic | ||
| findTopicById ( id ) | RecognitionTopic | ||
| getCurrentLevelAward ( topic, participant ) | RecognitionAward | Returns the highest level the given participant has achieved, ie their current level | |
| forceCurrentLevel ( participant, newLevel, awardedDate ) | RecognitionAward | ||
| findAwardsForEntity ( baseEntity ) | List | ||
| findLevelAwards ( participant, topic ) | List | ||
| findLevelAwardsForPeriod ( participant, period ) | List | ||
| findBadgeAwards ( participant, topic ) | List | ||
| findParticipants ( entity, t ) | List | Find all participants for the given user in the given topic. Note that this means all entities which are related to the given entity | |
| findParticipantsForPeriod ( entity, period ) | List | For the given entity (ie current user) return a list of participants for the give period. If the entity is a profile and this is a profile based promotion, it will be returned If the promotion is org based then will return a list of orgs which the user has access to which is elligible for the promotion | |
| startTopicScan ( topic ) | AsyncJob | ||
| createLevel ( topic, levelName, levelTitle, levelAmount ) | RecognitionLevel | ||
| newLevelBuilder ( topic, levelName ) | RecognitionLevelBuilder | ||
| createRecognitionPeriod ( topic, promotion ) | RecognitionPeriod | ||
| findPeriodResults ( period ) | List | ||
| findPeriodResults ( period, max ) | List | Returns a list of RecognitionPeriodResult for the given period, with a max number of results. Can be used to show leaderboards etc | |
| findPeriodResultForParticipant ( period, participant ) | RecognitionPeriodResult | ||
| findClosedPeriods ( topic, participant ) | RecognitionPeriod | ||
| findPeriodsForParticipant ( topic, participant ) | List | Returns all periods for the given topic which are available to the given participant | |
| findPeriod ( topic, participant, now ) | RecognitionPeriod | Finds a RecognitionPeriod for the given topic and participant which is active for the given date. Note that is is possible to have multiple periods but this would be invalid, there must only be one active period for a given user and topic at a given date | |
| findPeriodProjectedResult ( period, participant, now, actualValue ) | PeriodProjectedResult |
© 2025 Kademi Ltd