com.konakart.app

Class FetchPromotionOptions

java.lang.Object

com.konakart.app.FetchPromotionOptions

All Implemented Interfaces:

FetchPromotionOptionsIf

public class FetchPromotionOptions
extends java.lang.Object
implements FetchPromotionOptionsIf

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

Constructor Summary

Constructors

Constructor and Description
FetchPromotionOptions() Constructor

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FetchPromotionOptions

public FetchPromotionOptions()

Constructor

Method Detail

isPopulateProducts

public boolean isPopulateProducts()

Description copied from interface: FetchPromotionOptionsIf

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

Specified by:

isPopulateProducts in interface FetchPromotionOptionsIf

Returns:

the populateProducts

setPopulateProducts

public void setPopulateProducts(boolean populateProducts)

Description copied from interface: FetchPromotionOptionsIf

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

Specified by:

setPopulateProducts in interface FetchPromotionOptionsIf

Parameters:

populateProducts - the populateProducts to set

isPopulateManufacturers

public boolean isPopulateManufacturers()

Description copied from interface: FetchPromotionOptionsIf

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

Specified by:

isPopulateManufacturers in interface FetchPromotionOptionsIf

Returns:

the populateManufacturers

setPopulateManufacturers

public void setPopulateManufacturers(boolean populateManufacturers)

Description copied from interface: FetchPromotionOptionsIf

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

Specified by:

setPopulateManufacturers in interface FetchPromotionOptionsIf

Parameters:

populateManufacturers - the populateManufacturers to set

isPopulateCategories

public boolean isPopulateCategories()

Description copied from interface: FetchPromotionOptionsIf

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

Specified by:

isPopulateCategories in interface FetchPromotionOptionsIf

Returns:

the populateCategories

setPopulateCategories

public void setPopulateCategories(boolean populateCategories)

Description copied from interface: FetchPromotionOptionsIf

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

Specified by:

setPopulateCategories in interface FetchPromotionOptionsIf

Parameters:

populateCategories - the populateCategories to set

isOnlyReturnIfActive

public boolean isOnlyReturnIfActive()

Description copied from interface: FetchPromotionOptionsIf

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.

Specified by:

isOnlyReturnIfActive in interface FetchPromotionOptionsIf

Returns:

the onlyReturnIfActive

setOnlyReturnIfActive

public void setOnlyReturnIfActive(boolean onlyReturnIfActive)

Description copied from interface: FetchPromotionOptionsIf

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.

Specified by:

setOnlyReturnIfActive in interface FetchPromotionOptionsIf

Parameters:

onlyReturnIfActive - the onlyReturnIfActive to set

getSessionId

public java.lang.String getSessionId()

Description copied from interface: FetchPromotionOptionsIf

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

Specified by:

getSessionId in interface FetchPromotionOptionsIf

Returns:

the sessionId

setSessionId

public void setSessionId(java.lang.String sessionId)

Description copied from interface: FetchPromotionOptionsIf

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

Specified by:

setSessionId in interface FetchPromotionOptionsIf

Parameters:

sessionId - the sessionId to set

getCustomerId

public int getCustomerId()

Description copied from interface: FetchPromotionOptionsIf

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.

Specified by:

getCustomerId in interface FetchPromotionOptionsIf

Returns:

the customerId

setCustomerId

public void setCustomerId(int customerId)

Description copied from interface: FetchPromotionOptionsIf

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.

Specified by:

setCustomerId in interface FetchPromotionOptionsIf

Parameters:

customerId - the customerId to set

getCouponCodes

public java.lang.String[] getCouponCodes()

Description copied from interface: FetchPromotionOptionsIf

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

Specified by:

getCouponCodes in interface FetchPromotionOptionsIf

Returns:

the couponCodes

setCouponCodes

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

Description copied from interface: FetchPromotionOptionsIf

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

Specified by:

setCouponCodes in interface FetchPromotionOptionsIf

Parameters:

couponCodes - the couponCodes to set