Package org.broadleafcommerce.core.offer.domain

Interface AdvancedOffer

All Superinterfaces:

Serializable

public interface AdvancedOffer
extends Serializable

Add advanced offer support to an Offer

Author:

Priyesh Patel

Method Summary

Modifier and Type	Method	Description
List<PromotionMessage>	getActivePromotionMessagesByType(PromotionMessageType promotionMessageType)	Returns the active PromotionMessages for this offer by PromotionMessageType
List<PromotionMessage>	getActivePromotionMessagesByTypeAndPlacement(PromotionMessageType promotionMessageType, PromotionMessagePlacementType placementType)	Returns the active PromotionMessages for this offer by PromotionMessageType and PromotionMessagePlacementType
Boolean	getHasPromotionMessage()	Returns whether or not this offer has a PromotionMessage
OfferProrationType	getOfferProrationType()	Returns the OfferProrationType of this offer
List<OfferTier>	getOfferTiers()	List of Tiers an offer supports.
OfferTimeZoneType	getOfferTimeZoneType()	Returns the OfferTimeZoneType
List<AdvancedOfferPromotionMessageXref>	getPromotionMessageXrefs()	Returns the AdvancedOfferPromotionMessageXrefs of this offer
boolean	hasPromotionMessageOfType(PromotionMessageType type)	Returns whether or not this offer has a PromotionMessage of a particular type
boolean	isTieredOffer()	Returns true if this is a tiered offer meaning that the amount depends on the quantity being purchased.
void	setHasPromotionMessage(Boolean hasPromotionMessage)	Sets whether or not this offer has a PromotionMessage
void	setOfferProrationType(OfferProrationType offerProrationType)	Sets the OfferProrationType for this offer
void	setOfferTiers(List<OfferTier> offerTiers)	Sets the list of Tiers.
void	setOfferTimeZoneType(OfferTimeZoneType offerTimeZoneType)	Sets the OfferTimeZoneType
void	setPromotionMessageXrefs(List<AdvancedOfferPromotionMessageXref> promotionMessageXrefs)	Sets the AdvancedOfferPromotionMessageXrefs for this offer
void	setTieredOffer(boolean isTieredOffer)	Sets whether or not this is a tiered offer.

Method Details

getOfferTiers

List<OfferTier> getOfferTiers()

List of Tiers an offer supports. Implemented in external module.

Returns:

setOfferTiers

void setOfferTiers(List<OfferTier> offerTiers)

Sets the list of Tiers.

Parameters:

offerTiers -

isTieredOffer

boolean isTieredOffer()

Returns true if this is a tiered offer meaning that the amount depends on the quantity being purchased.

Returns:

setTieredOffer

void setTieredOffer(boolean isTieredOffer)

Sets whether or not this is a tiered offer.

Parameters:

isTieredOffer -

getOfferTimeZoneType

OfferTimeZoneType getOfferTimeZoneType()

Returns the OfferTimeZoneType

Returns:

setOfferTimeZoneType

void setOfferTimeZoneType(OfferTimeZoneType offerTimeZoneType)

Sets the OfferTimeZoneType

Parameters:

offerTimeZoneType -

getOfferProrationType

OfferProrationType getOfferProrationType()

Returns the OfferProrationType of this offer

Returns:

setOfferProrationType

void setOfferProrationType(OfferProrationType offerProrationType)

Sets the OfferProrationType for this offer

Parameters:

offerProrationType -

getHasPromotionMessage

Boolean getHasPromotionMessage()

Returns whether or not this offer has a PromotionMessage

Returns:

setHasPromotionMessage

void setHasPromotionMessage(Boolean hasPromotionMessage)

Sets whether or not this offer has a PromotionMessage

Parameters:

hasPromotionMessage -

hasPromotionMessageOfType

boolean hasPromotionMessageOfType(PromotionMessageType type)

Returns whether or not this offer has a PromotionMessage of a particular type

Returns:

getPromotionMessageXrefs

List<AdvancedOfferPromotionMessageXref> getPromotionMessageXrefs()

Returns the AdvancedOfferPromotionMessageXrefs of this offer

Returns:

setPromotionMessageXrefs

void setPromotionMessageXrefs(List<AdvancedOfferPromotionMessageXref> promotionMessageXrefs)

Sets the AdvancedOfferPromotionMessageXrefs for this offer

Parameters:

promotionMessageXrefs -

getActivePromotionMessagesByType

List<PromotionMessage> getActivePromotionMessagesByType(PromotionMessageType promotionMessageType)

Returns the active PromotionMessages for this offer by PromotionMessageType

Returns:

filtered PromotionMessages

getActivePromotionMessagesByTypeAndPlacement

List<PromotionMessage> getActivePromotionMessagesByTypeAndPlacement(PromotionMessageType promotionMessageType,
 PromotionMessagePlacementType placementType)

Returns the active PromotionMessages for this offer by PromotionMessageType and PromotionMessagePlacementType

Returns:

filtered PromotionMessages