To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Properties
| Name | Returns | Notes | Example |
|---|---|---|---|
| allPointsRuleTypes | List | ||
| pointsBuckets | List | ||
| pointsTags | List | ||
| reasonCodes | Map | ||
| allocationRulePointsTag | PointsTag | ||
| allocationRuleReasonCode | String |
Methods
| Name | Returns | Notes | Example |
|---|---|---|---|
| createPointsBucket ( newName, newTitle, indiv ) | Reward | ||
| pointsRuleParams ( pas ) | Map | ||
| pointsRuleType ( id ) | PointsRuleType | ||
| findExpiring ( pointsBucket, recip, toDate ) | ExpiringPointsList | ||
| findExpiringForAllEntities ( pointsBucket, toDate ) | Map | ||
| findExpiringForAllEntities ( pointsBucket, toDate, clearSession ) | Map | ||
| calcFullPointsHistory ( pointsBucket, participant ) | List | Dynamically generate a full transaction history for the given participant. This ignores persisted points reconciliations, and applies expirations dynamically if expiration debits are missing | |
| findPointsBucket ( name ) | Reward | ||
| findPointsBucket ( id ) | Reward | ||
| availablePointsBuckets ( curUser ) | List | ||
| availablePointsBuckets ( org ) | List | Find all available buckets for org | |
| awardPoints ( recipient, reward, numPoints, reason ) | Points | ||
| awardPoints ( recipient, reward, numPoints, reason, pointsTag ) | Points | ||
| debitPoints ( recipient, reward, numPoints, reason, reasonCode ) | PointsDebit | ||
| newPointsRequest ( participant, points ) | PointsRequest | Create a new instance of PointsRequest to be used with the processPointsRequest method | |
| processPointsRequest ( pr ) | RewardTransactionItem | ||
| findTag ( tagOrReasonCode ) | PointsTag | ||
| pointsBalance ( reward, baseEntity ) | Double | ||
| pointsBalance ( reward, baseEntity, forceRecalc ) | Double | ||
| availableBalance ( entity, reward ) | Double | ||
| findParticipants ( reward, entity ) | List | ||
| findParticipantForEntity ( reward, baseEntity ) | BaseEntity | ||
| transactions ( recip, reward ) | List | ||
| transactions ( recip, reward, since, to ) | List | ||
| sumAllPoints ( baseEntity, rewardName, from, to ) | Double | ||
| sumAllPoints ( baseEntity, rewardName, pointsTag, from, to ) | Double | ||
| sumAllPoints ( profileBean, rewardName, from, to ) | Double | ||
| sumAllPoints ( profileBean, rewardName, pointsTag, from, to ) | Double | ||
| sumAllPoints ( userResource, rewardName, from, to ) | Double | ||
| sumAllPoints ( userResource, rewardName, pointsTag, from, to ) | Double | ||
| sumAllPoints ( orgData, rewardName, from, to ) | Double | ||
| sumAllPoints ( orgData, rewardName, pointsTag, from, to ) | Double | ||
| findPointsDebitLinks ( p ) | List | ||
| findBySearch ( searchQ, r, reasonCode, tagId, from, to, minPoints, maxPoints, searchProperties ) | ListAndCount | ||
| findBySearch ( searchQ, r, reasonCode, tagId, from, to, minPoints, maxPoints, recordType, searchProperties ) | ListAndCount | ||
| pointsStats ( org, reward, start, finish ) | PointsStats | ||
| applicableMemberships ( p, reward ) | List | Return a GroupMembership from the given profile which is applicable for the given reward. Eg a membership which is for a group defined as a participant on the reward. | |
| applicableOrgs ( p, reward ) | List | ||
| myPointsInfo ( reward, max ) | MyRewardInfo | ||
| myPointsInfo ( reward, max, since ) | MyRewardInfo |
|
|
| myPointsInfo ( reward, max, since, org ) | MyRewardInfo | ||
| myPointsInfo ( reward, max, since, to ) | MyRewardInfo |
|
|
| findParticipantsForReward ( p, reward ) | List | ||
| isSameParticipant ( entity, user ) | boolean | Return true if the given user represents the same participant as the given entity This is useful for when checking to see if a user is the same as another user or is connected to another organsiation for the purpose of rewards | |
| lastCredit ( participant, bucket ) | Points | ||
| lastDebit ( participant, bucket ) | PointsDebit |
© 2025 Kademi Ltd