Configures one action to run when a profile completes a learning module: either issuing a certificate with a number of CPD points, or granting a reward such as a gift voucher or draw entry. The type property selects which kind of action this is - "certificate" or "reward" - and itemId is the ID of the certificate or reward to give. A list of these actions is stored as an XML file alongside a module, read and written with parse and write, and is applied by LearningManager.processModuleCompleteAction each time a profile completes that module. If groupId is set the action is only applied to profiles who are a member of that group.

Properties

Methods

getItemId()

Returns: Long

ID of the certificate or reward this action gives, interpreted according to the value of type. Never null for a fully configured action.

getGroupId()

Returns: Long

ID of the group a profile must belong to for this action to be applied. Null or zero means the action applies to every profile that completes the module.

getNumber()

Returns: Double

Numeric amount this action applies: the number of CPD points to award for a certificate action, or the number of rewards to give for a reward action. May be null if no amount was configured.

getType()

Returns: String

Kind of action this is: "certificate" to issue a certificate, or "reward" to grant a reward.

getTag()

Returns: String

Name of the points tag to record against a reward action, used to categorise the points awarded with the reward. Not used for certificate actions.