com.konakart.appif

Interface FetchPromotionOptionsIf

All Known Implementing Classes:

FetchPromotionOptions

public interface FetchPromotionOptionsIf

An object used to define options used when reading a promotion from the database

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getCouponCodes() Coupon codes to use.
int	getCustomerId() If the sessionId is set to null then the customerId should contain the id of the temporary user which is a negative number.
java.lang.String	getSessionId() Only used if the customer is logged in.
boolean	isOnlyReturnIfActive() Only return the promotion if it is active.
boolean	isPopulateCategories() If true we populate the includedCategories or excludedCategories arrays of the promotion.
boolean	isPopulateManufacturers() If true we populate the includedManufacturers or excludedManufacturers arrays of the promotion.
boolean	isPopulateProducts() If true we populate the includedProducts or excludedProducts arrays of the promotion.
void	setCouponCodes(java.lang.String[] couponCodes) Coupon codes to use.
void	setCustomerId(int customerId) If the sessionId is set to null then the customerId should contain the id of the temporary user which is a negative number.
void	setOnlyReturnIfActive(boolean onlyReturnIfActive) Only return the promotion if it is active.
void	setPopulateCategories(boolean populateCategories) If true we populate the includedCategories or excludedCategories arrays of the promotion.
void	setPopulateManufacturers(boolean populateManufacturers) If true we populate the includedManufacturers or excludedManufacturers arrays of the promotion.
void	setPopulateProducts(boolean populateProducts) If true we populate the includedProducts or excludedProducts arrays of the promotion.
void	setSessionId(java.lang.String sessionId) Only used if the customer is logged in.

Method Detail

isPopulateProducts

boolean isPopulateProducts()

If true we populate the includedProducts or excludedProducts arrays of the promotion. Defaults to true.

Returns:

the populateProducts

setPopulateProducts

void setPopulateProducts(boolean populateProducts)

If true we populate the includedProducts or excludedProducts arrays of the promotion. Defaults to true.

Parameters:

populateProducts - the populateProducts to set

isPopulateManufacturers

boolean isPopulateManufacturers()

If true we populate the includedManufacturers or excludedManufacturers arrays of the promotion. Defaults to true.

Returns:

the populateManufacturers

setPopulateManufacturers

void setPopulateManufacturers(boolean populateManufacturers)

If true we populate the includedManufacturers or excludedManufacturers arrays of the promotion. Defaults to true.

Parameters:

populateManufacturers - the populateManufacturers to set

isPopulateCategories

boolean isPopulateCategories()

If true we populate the includedCategories or excludedCategories arrays of the promotion. Defaults to true.

Returns:

the populateCategories

setPopulateCategories

void setPopulateCategories(boolean populateCategories)

If true we populate the includedCategories or excludedCategories arrays of the promotion. Defaults to true.

Parameters:

populateCategories - the populateCategories to set

isOnlyReturnIfActive

boolean isOnlyReturnIfActive()

Only return the promotion if it is active. We check that it is set to active, within the configured date range and hasn't reached its max usage limit. Defaults to false.

Returns:

the onlyReturnIfActive

setOnlyReturnIfActive

void setOnlyReturnIfActive(boolean onlyReturnIfActive)

Only return the promotion if it is active. We check that it is set to active, within the configured date range and hasn't reached its max usage limit. Defaults to false.

Parameters:

onlyReturnIfActive - the onlyReturnIfActive to set

getSessionId

java.lang.String getSessionId()

Only used if the customer is logged in. Otherwise set to null.

Returns:

the sessionId

setSessionId

void setSessionId(java.lang.String sessionId)

Only used if the customer is logged in. Otherwise set to null.

Parameters:

sessionId - the sessionId to set

getCustomerId

int getCustomerId()

If the sessionId is set to null then the customerId should contain the id of the temporary user which is a negative number. The temporary user id can be used for evaluating expression rules.

Returns:

the customerId

setCustomerId

void setCustomerId(int customerId)

If the sessionId is set to null then the customerId should contain the id of the temporary user which is a negative number. The temporary user id can be used for evaluating expression rules.

Parameters:

customerId - the customerId to set

getCouponCodes

java.lang.String[] getCouponCodes()

Coupon codes to use. If none of the promotions require coupons, or you don't wish to test that the promotion is active then it should be set to null

Returns:

the couponCodes

setCouponCodes

void setCouponCodes(java.lang.String[] couponCodes)

Coupon codes to use. If none of the promotions require coupons, or you don't wish to test that the promotion is active then it should be set to null

Parameters:

couponCodes - the couponCodes to set