Determines which promotions (Reward objects used for checkout/cart offers) a purchaser or cart currently qualifies for, and resolves a promotion's stored configuration - entry codes, discount and gift settings, quiz and upload options - from the reward.properties file held against the reward. Consumed by cart pricing, checkout rules and points rule evaluation to check promotion eligibility and to read a promotion's details as a PromotionBean before applying its discount or gift behaviour.

---

Methods

promotions() · promotions(Boolean open, Date now) · availablePromotions(Date now, BaseEntity customer) · availablePromotions(Date now, BaseEntity customer, Boolean open) · isElligbleParticipant(BaseEntity participant, Reward promotion) · matchesParticipantSelector(Reward promo, BaseEntity entity) · matchesParticipantSelector(List<KSelectorItem> sels, Organisation entity) · participantSelectors(Reward promo) · isMatchingPromoCode(String code, Reward promotion) · getPromoEntryCodes(Reward reward) · promotionDetails(Reward reward) · loadRewardProps(Reward reward) · loadRewardProps(DirectoryNode rewardNode) · getTerms(Reward reward) · qualifiesForCheckoutPromotion(PromotionBean promoDetails, Cart cart) · countItemsForCheckoutPromotion(PromotionBean promoDetails, Cart cart) · calcFreeGiftQuantity(PromotionBean promoDetails, Cart cart)

promotions()

Returns: List<Reward>

All promotions defined for the current organisation, regardless of whether they are open or finished.

promotions(Boolean open, Date now)

Returns: PromotionsList

Finds the promotions defined for the current organisation, optionally filtered by whether they are finished as at the given date.

availablePromotions(Date now, BaseEntity customer)

Returns: PromotionsList

Finds the currently open promotions the given customer is eligible to participate in. Equivalent to calling the 3-argument overload with open set to true.

availablePromotions(Date now, BaseEntity customer, Boolean open)

Returns: PromotionsList

Finds the promotions defined for the current organisation that match the given date and eligibility criteria. When customer is null, only promotions with no organisation criteria and open group/org membership are returned; otherwise a promotion is included only if the customer is an eligible participant, as determined by isElligbleParticipant.

isElligbleParticipant(BaseEntity participant, Reward promotion)

Returns: boolean

Determines whether a profile or organisation is eligible to participate in a promotion. A profile is eligible if the promotion's group criteria include the profile and, when the promotion has organisation criteria, one of the profile's primary organisations matches the promotion's organisation type and participant selectors. An organisation is eligible if the promotion's organisation criteria include it directly.

matchesParticipantSelector(Reward promo, BaseEntity entity)

Returns: boolean

Checks whether an organisation matches a promotion's configured participant selectors. Always returns false for a profile entity, since participant selectors apply only to organisations.

matchesParticipantSelector(List<KSelectorItem> sels, Organisation entity)

Returns: boolean

Checks whether an organisation falls within one of a set of organisation selectors. An empty selector list matches everything.

participantSelectors(Reward promo)

Returns: List<KSelectorItem>

Parses a promotion's raw participant selector configuration into structured selector items.

isMatchingPromoCode(String code, Reward promotion)

Returns: boolean

Checks whether the given code matches one of the promotion's configured entry codes.

getPromoEntryCodes(Reward reward)

Returns: String

Reads the raw, delimiter-separated entry codes configured for a promotion, if a code is required to activate it.

promotionDetails(Reward reward)

Returns: PromotionBean

Loads a promotion's configured details, read from the reward.properties file stored against the reward.

loadRewardProps(Reward reward)

Returns: Properties

Loads the raw reward.properties file for a promotion, creating its rewards directory if it does not already exist.

loadRewardProps(DirectoryNode rewardNode)

Returns: Properties

Loads the reward.properties file from a reward's directory node.

getTerms(Reward reward)

Returns: String

Reads the terms and conditions HTML file stored against a promotion.

qualifiesForCheckoutPromotion(PromotionBean promoDetails, Cart cart)

Returns: boolean

Checks whether a cart contains enough qualifying items for a checkout promotion to apply.

countItemsForCheckoutPromotion(PromotionBean promoDetails, Cart cart)

Returns: BigDecimal

Counts the quantity of items in a cart that qualify for a checkout promotion. If the promotion has no qualifying categories configured, the cart's total item quantity is returned; otherwise only items in one of the qualifying categories are counted.

calcFreeGiftQuantity(PromotionBean promoDetails, Cart cart)

Returns: BigDecimal

Calculates the quantity of a free gift a cart has earned under a checkout promotion, based on the quantity of qualifying items in the cart, capped at the promotion's configured maximum gift quantity.