Fans out a RewardGrantedEvent to a single profile associated with the awarded entity, for funnel processing. FunnelManager creates one of these per profile returned for the reward and awarded-to entity, since a RewardGrantedEvent may relate to an organisation with several associated profiles. Its getters delegate to the source RewardGrantedEvent for the reward and grant details, and it restricts goal matching to the funnel goals relevant to points and promotion activity.
Group: Journeys
Implements: FunnelEvent
Properties
| Property | Returns | Description |
|---|---|---|
| availableBalance | Double | The awarded entity's current available balance for the reward, delegated from the source event. |
| leadProfile | Profile | The profile this fanned-out funnel event applies to. |
| pointsBalance | Double | The awarded entity's current points balance for the reward, delegated from the source event. |
| relatedLead | Lead | The lead associated with this event. This event is not created from an existing lead, so there is none. |
| reward | Reward | The reward the points were granted against, delegated from the source event. |
| rewardDate | Date | The date the grant occurred, delegated from the source event. |
| rewardEndDate | Date | The end date of the reward, delegated from the source event. |
| rewardEntryStatus | RewardEntryStatus | The status of the reward entry associated with the grant, delegated from the source event. |
| rewardName | String | The name of the reward the points were granted against, delegated from the source event. |
| rewardStartDate | Date | The start date of the reward, delegated from the source event. |
| rewardTemplate | String | The template code of the reward, delegated from the source event. |
| sourceEvent | RewardGrantedEvent | The originating RewardGrantedEvent that this funnel event was fanned out from. |
| triggeredGoals | List<Class<? extends Goal>> | The funnel goal classes that this event can satisfy: points transaction added, points value reached, and promotion entry. |
| updatedObject | Object | The object that should be re-indexed as a result of the grant, delegated from the source event. |
Methods
getLeadProfile() · getRelatedLead() · getSourceEvent() · getRewardDate() · getRewardName() · getRewardEntryStatus() · getRewardTemplate() · getRewardStartDate() · getRewardEndDate() · getPointsBalance() · getAvailableBalance() · getUpdatedObject() · getReward() · getTriggeredGoals()
getLeadProfile()
Returns: Profile
The profile this fanned-out funnel event applies to.
getRelatedLead()
Returns: Lead
The lead associated with this event. This event is not created from an existing lead, so there is none.
getSourceEvent()
Returns: RewardGrantedEvent
The originating RewardGrantedEvent that this funnel event was fanned out from.
getRewardDate()
Returns: Date
The date the grant occurred, delegated from the source event.
getRewardName()
Returns: String
The name of the reward the points were granted against, delegated from the source event.
getRewardEntryStatus()
Returns: RewardEntryStatus
The status of the reward entry associated with the grant, delegated from the source event.
getRewardTemplate()
Returns: String
The template code of the reward, delegated from the source event.
getRewardStartDate()
Returns: Date
The start date of the reward, delegated from the source event.
getRewardEndDate()
Returns: Date
The end date of the reward, delegated from the source event.
getPointsBalance()
Returns: Double
The awarded entity's current points balance for the reward, delegated from the source event.
getAvailableBalance()
Returns: Double
The awarded entity's current available balance for the reward, delegated from the source event.
getUpdatedObject()
Returns: Object
The object that should be re-indexed as a result of the grant, delegated from the source event.
getReward()
Returns: Reward
The reward the points were granted against, delegated from the source event.
getTriggeredGoals()
Returns: List<Class<? extends Goal>>
The funnel goal classes that this event can satisfy: points transaction added, points value reached, and promotion entry.