com.konakart.appif

Interface PromotionOptionsIf

All Known Implementing Classes:

PromotionOptions

public interface PromotionOptionsIf

The PromotionOptions is passed to the getPromotionsPerProducts() API call to configure the behavior of the call.

Method Summary

Modifier and Type	Method and Description
int	getPromotionRule() Used in getPromotionsPerProducts()
boolean	isCheckForExpiredCoupons() Used in getPromotionsPerCoupon()
boolean	isOnlyReturnActivePromotions() Used in getPromotionsPerCoupon()
boolean	isSubtractValueFromPriceExTax() Used in getPromotionsPerProducts()
boolean	isSubtractValueFromPriceIncTax() Used in getPromotionsPerProducts()
void	setCheckForExpiredCoupons(boolean checkForExpiredCoupons) Used in getPromotionsPerCoupon()
void	setOnlyReturnActivePromotions(boolean onlyReturnActivePromotions) Used in getPromotionsPerCoupon()
void	setPromotionRule(int promotionRule) Used in getPromotionsPerProducts()
void	setSubtractValueFromPriceExTax(boolean subtractValueFromPriceExTax) Used in getPromotionsPerProducts()
void	setSubtractValueFromPriceIncTax(boolean subtractValueFromPriceIncTax) Used in getPromotionsPerProducts()

Method Detail

getPromotionRule

int getPromotionRule()

Used in getPromotionsPerProducts()

Rule to apply for more than one promotion. The rule is only used when one or both of the options to deduct the promotion value from the product price are chosen. Valid values are:

• com.konakart.app.PromotionOptions.PRM_RULE_CHOOSE_LARGEST - The promotion offering the largest discount is chosen. It applies to all promotions that produce a value (i.e. Not for a 3 for 2 promotion or free gift promotion etc.). If there are percentage discount promotions mixed with promotions producing a non percentage discount, then the discount is actually calculated for the percentage cases and the largest one is chosen.
• com.konakart.app.PromotionOptions.PRM_RULE_CHOOSE_SMALLEST - The promotion offering the smallest discount is chosen. It applies to all promotions that produce a value (i.e. Not for a 3 for 2 promotion or free gift promotion etc.). If there are percentage discount promotions mixed with promotions producing a non percentage discount, then the discount is actually calculated for the percentage cases and the smallest one is chosen.
• com.konakart.app.PromotionOptions.PRM_RULE_CUMULATIVE - This only applies to promotions creating non percentage discounts. The discounts of all these promotions are applied to the product.

Returns:

the promotionRule

setPromotionRule

void setPromotionRule(int promotionRule)

Used in getPromotionsPerProducts()

Rule to apply for more than one promotion. The rule is only used when one or both of the options to deduct the promotion value from the product price are chosen. Valid values are:

• com.konakart.app.PromotionOptions.PRM_RULE_CHOOSE_LARGEST - The promotion offering the largest discount is chosen. It applies to all promotions that produce a value (i.e. Not for a 3 for 2 promotion or free gift promotion etc.). If there are percentage discount promotions mixed with promotions producing a non percentage discount, then the discount is actually calculated for the percentage cases and the largest one is chosen.
• com.konakart.app.PromotionOptions.PRM_RULE_CHOOSE_SMALLEST - The promotion offering the smallest discount is chosen. It applies to all promotions that produce a value (i.e. Not for a 3 for 2 promotion or free gift promotion etc.). If there are percentage discount promotions mixed with promotions producing a non percentage discount, then the discount is actually calculated for the percentage cases and the smallest one is chosen.
• com.konakart.app.PromotionOptions.PRM_RULE_CUMULATIVE - This only applies to promotions creating non percentage discounts. The discounts of all these promotions are applied to the product.

Parameters:

promotionRule - the promotionRule to set

isSubtractValueFromPriceExTax

boolean isSubtractValueFromPriceExTax()

Used in getPromotionsPerProducts()

When set the promotion value is subtracted from the priceExTax attribute of the product. If there are multiple promotions then the promotion rule is used to decide how to apply the discount.

Returns:

the subtractValueFromPriceExTax

setSubtractValueFromPriceExTax

void setSubtractValueFromPriceExTax(boolean subtractValueFromPriceExTax)

Used in getPromotionsPerProducts()

When set the promotion value is subtracted from the priceExTax attribute of the product. If there are multiple promotions then the promotion rule is used to decide how to apply the discount.

Parameters:

subtractValueFromPriceExTax - the subtractValueFromPriceExTax to set

isSubtractValueFromPriceIncTax

boolean isSubtractValueFromPriceIncTax()

Used in getPromotionsPerProducts()

When set the promotion value is subtracted from the priceIncTax attribute of the product. If there are multiple promotions then the promotion rule is used to decide how to apply the discount.

Returns:

the subtractValueFromPriceIncTax

setSubtractValueFromPriceIncTax

void setSubtractValueFromPriceIncTax(boolean subtractValueFromPriceIncTax)

Used in getPromotionsPerProducts()

When set the promotion value is subtracted from the priceIncTax attribute of the product. If there are multiple promotions then the promotion rule is used to decide how to apply the discount.

Parameters:

subtractValueFromPriceIncTax - the subtractValueFromPriceIncTax to set

isCheckForExpiredCoupons

boolean isCheckForExpiredCoupons()

Used in getPromotionsPerCoupon()

When set, no promotion objects are returned for the coupons referenced by the couponCode or couponId if they are expired.

Returns:

the checkForExpiredCoupons

setCheckForExpiredCoupons

void setCheckForExpiredCoupons(boolean checkForExpiredCoupons)

Used in getPromotionsPerCoupon()

When set, no promotion objects are returned for the coupons referenced by the couponCode or couponId if they are expired.

Parameters:

checkForExpiredCoupons - the checkForExpiredCoupons to set

isOnlyReturnActivePromotions

boolean isOnlyReturnActivePromotions()

Used in getPromotionsPerCoupon()

When set, only active promotions are returned.

Returns:

the onlyReturnActivePromotions

setOnlyReturnActivePromotions

void setOnlyReturnActivePromotions(boolean onlyReturnActivePromotions)

Used in getPromotionsPerCoupon()

When set, only active promotions are returned.

Parameters:

onlyReturnActivePromotions - the onlyReturnActivePromotions to set