com.ibm.commerce.promotion.facade.datatypes

Interface PromotionRedemptionLimitType

public interface PromotionRedemptionLimitType

A representation of the model object 'Redemption Limit Type'. Type definition of a promotion redemption limit.

The following features are supported:

• Per Order Limit
• Per Shopper Limit
• Total Limit

See Also:

PromotionPackage.getPromotionRedemptionLimitType()

Method Summary

Modifier and Type	Method and Description
int	getPerOrderLimit() Returns the value of the 'Per Order Limit' attribute.
int	getPerShopperLimit() Returns the value of the 'Per Shopper Limit' attribute.
int	getTotalLimit() Returns the value of the 'Total Limit' attribute.
boolean	isSetPerOrderLimit() Returns whether the value of the 'Per Order Limit' attribute is set.
boolean	isSetPerShopperLimit() Returns whether the value of the 'Per Shopper Limit' attribute is set.
boolean	isSetTotalLimit() Returns whether the value of the 'Total Limit' attribute is set.
void	setPerOrderLimit(int value) Sets the value of the 'Per Order Limit' attribute.
void	setPerShopperLimit(int value) Sets the value of the 'Per Shopper Limit' attribute.
void	setTotalLimit(int value) Sets the value of the 'Total Limit' attribute.
void	unsetPerOrderLimit() Unsets the value of the 'Per Order Limit' attribute.
void	unsetPerShopperLimit() Unsets the value of the 'Per Shopper Limit' attribute.
void	unsetTotalLimit() Unsets the value of the 'Total Limit' attribute.

Method Detail

getPerOrderLimit

int getPerOrderLimit()

Returns the value of the 'Per Order Limit' attribute. Number of promotion patterns can be redeemed in a single order. Value -1 indicates no redemption limit.

Returns:

the value of the 'Per Order Limit' attribute.

See Also:

isSetPerOrderLimit(), unsetPerOrderLimit(), setPerOrderLimit(int), PromotionPackage.getPromotionRedemptionLimitType_PerOrderLimit()

setPerOrderLimit

void setPerOrderLimit(int value)

Sets the value of the 'Per Order Limit' attribute.

Parameters:

value - the new value of the 'Per Order Limit' attribute.

See Also:

isSetPerOrderLimit(), unsetPerOrderLimit(), getPerOrderLimit()

unsetPerOrderLimit

void unsetPerOrderLimit()

Unsets the value of the 'Per Order Limit' attribute.

See Also:

isSetPerOrderLimit(), getPerOrderLimit(), setPerOrderLimit(int)

isSetPerOrderLimit

boolean isSetPerOrderLimit()

Returns whether the value of the 'Per Order Limit' attribute is set.

Returns:

whether the value of the 'Per Order Limit' attribute is set.

See Also:

unsetPerOrderLimit(), getPerOrderLimit(), setPerOrderLimit(int)

getPerShopperLimit

int getPerShopperLimit()

Returns the value of the 'Per Shopper Limit' attribute. Number of promotion patterns can be redeemed by a single shopper. Value -1 indicates no redemption limit.

Returns:

the value of the 'Per Shopper Limit' attribute.

See Also:

isSetPerShopperLimit(), unsetPerShopperLimit(), setPerShopperLimit(int), PromotionPackage.getPromotionRedemptionLimitType_PerShopperLimit()

setPerShopperLimit

void setPerShopperLimit(int value)

Sets the value of the 'Per Shopper Limit' attribute.

Parameters:

value - the new value of the 'Per Shopper Limit' attribute.

See Also:

isSetPerShopperLimit(), unsetPerShopperLimit(), getPerShopperLimit()

unsetPerShopperLimit

void unsetPerShopperLimit()

Unsets the value of the 'Per Shopper Limit' attribute.

See Also:

isSetPerShopperLimit(), getPerShopperLimit(), setPerShopperLimit(int)

isSetPerShopperLimit

boolean isSetPerShopperLimit()

Returns whether the value of the 'Per Shopper Limit' attribute is set.

Returns:

whether the value of the 'Per Shopper Limit' attribute is set.

See Also:

unsetPerShopperLimit(), getPerShopperLimit(), setPerShopperLimit(int)

getTotalLimit

int getTotalLimit()

Returns the value of the 'Total Limit' attribute. Number of promotion patterns can be redeemed for the store. Value -1 indicates no redemption limit.

Returns:

the value of the 'Total Limit' attribute.

See Also:

isSetTotalLimit(), unsetTotalLimit(), setTotalLimit(int), PromotionPackage.getPromotionRedemptionLimitType_TotalLimit()

setTotalLimit

void setTotalLimit(int value)

Sets the value of the 'Total Limit' attribute.

Parameters:

value - the new value of the 'Total Limit' attribute.

See Also:

isSetTotalLimit(), unsetTotalLimit(), getTotalLimit()

unsetTotalLimit

void unsetTotalLimit()

Unsets the value of the 'Total Limit' attribute.

See Also:

isSetTotalLimit(), getTotalLimit(), setTotalLimit(int)

isSetTotalLimit

boolean isSetTotalLimit()

Returns whether the value of the 'Total Limit' attribute is set.

Returns:

whether the value of the 'Total Limit' attribute is set.

See Also:

unsetTotalLimit(), getTotalLimit(), setTotalLimit(int)