Read-only snapshot of a Reward (a promotion or points bucket), copying its display and scheduling fields into a plain bean for use in templates and other places that should not hold a live Hibernate entity. Built from a Reward via the static toBean factory method; used for example as the reward field of SubmissionBean.
Properties
| Property | Returns | Description |
|---|---|---|
| endDate | Date | The date the reward closes, or null if it has no end date. |
| expiryDate | Date | The date after which the reward can no longer be redeemed, or null if it does not expire. |
| extraFieldNames | List<String> | The names of the extra fields configured on the reward, in their configured order. |
| fulfiledDate | Date | The date the reward was fulfiled, or null if it has not been fulfiled. |
| id | long | The persisted id of the reward. |
| name | String | The unique, path-safe name of the reward, used as its lookup key. |
| startDate | Date | The date the reward opens, or null if it has no start date. |
| status | String | The reward's status, for example active or the value set by PromotionBuilder.promoStatus. |
| subTitle | String | The reward's subtitle, or null if not set. |
| title | String | The display title of the reward. |
| validForDays | Integer | The number of days the reward remains valid for after it is awarded, or null if not set. |
| winners | String | The winners recorded against the reward, or null if not set. |
Methods
getId() · getName() · getTitle() · getStatus() · getStartDate() · getEndDate() · getExpiryDate() · getValidForDays() · getFulfiledDate() · getSubTitle() · getWinners() · getExtraFieldNames()
getId()
Returns: long
The persisted id of the reward.
getName()
Returns: String
The unique, path-safe name of the reward, used as its lookup key.
getTitle()
Returns: String
The display title of the reward.
getStatus()
Returns: String
The reward's status, for example active or the value set by PromotionBuilder.promoStatus.
getStartDate()
Returns: Date
The date the reward opens, or null if it has no start date.
getEndDate()
Returns: Date
The date the reward closes, or null if it has no end date.
getExpiryDate()
Returns: Date
The date after which the reward can no longer be redeemed, or null if it does not expire.
getValidForDays()
Returns: Integer
The number of days the reward remains valid for after it is awarded, or null if not set.
getFulfiledDate()
Returns: Date
The date the reward was fulfiled, or null if it has not been fulfiled.
getSubTitle()
Returns: String
The reward's subtitle, or null if not set.
getWinners()
Returns: String
The winners recorded against the reward, or null if not set.
getExtraFieldNames()
Returns: List<String>
The names of the extra fields configured on the reward, in their configured order.