Grants a profile the ability to redeem reward store products and gifts within an organisation. This is the participant-level reward store role, distinct from the points administration roles which manage points balances themselves. It grants WRITE_PROPERTIES so a profile with this role can place redemption orders against their available points balance.
Implements: Role
Properties
| Property | Returns | Description |
|---|---|---|
| category | String | Grouping used to organise this role in the "add role to group" admin UI. |
| description | String | Human readable explanation of what this role allows, shown to administrators when assigning roles. |
| name | String | Display name of this role as shown in group and role management screens. |
Inherited from Role
Methods
canConnectToOrganisation()
Returns: boolean
Convenience method for callers, such as Velocity templates, which just need to know if this role can be assigned within an organisation context, without dealing with the TargetType enum directly.
canConnectToRepository()
Returns: boolean
Convenience method for callers, such as Velocity templates, which just need to know if this role can be assigned within a repository (or website) context, without dealing with the TargetType enum directly.
Methods
getName()
Returns: String
Display name of this role as shown in group and role management screens.
getDescription()
Returns: String
Human readable explanation of what this role allows, shown to administrators when assigning roles.
getCategory()
Returns: String
Grouping used to organise this role in the "add role to group" admin UI.