Package de.hybris.platform.promotions.jalo

Class ProductBOGOFPromotion

java.lang.Object

de.hybris.platform.util.BridgeAbstraction

de.hybris.platform.jalo.Item

de.hybris.platform.jalo.ExtensibleItem

de.hybris.platform.jalo.c2l.LocalizableItem

de.hybris.platform.jalo.GenericItem

de.hybris.platform.promotions.jalo.GeneratedAbstractPromotion

de.hybris.platform.promotions.jalo.AbstractPromotion

de.hybris.platform.promotions.jalo.GeneratedProductPromotion

de.hybris.platform.promotions.jalo.ProductPromotion

de.hybris.platform.promotions.jalo.GeneratedProductBOGOFPromotion

de.hybris.platform.promotions.jalo.ProductBOGOFPromotion

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

Direct Known Subclasses:

GeneratedAcceleratorProductBOGOFPromotion

public class ProductBOGOFPromotion
extends GeneratedProductBOGOFPromotion

Buy x get y free promotion. Buy a certain number of items, get specified number of lowest valued items for free. For example: Buy 1 get 1 free (also known as Buy 2 for the price of 1), Buy 3 for the price of 2 or any combination of paid for and free products. The items must all be from the range of qualifying products.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.jalo.GenericItem

GenericItem.GenericItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LocalizableItem.LocalizableItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.ExtensibleItem

ExtensibleItem.ExtensibleItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.Item

Item.AttributeFilter, Item.AttributeMode, Item.CachedGetter, Item.CachedSetter, Item.ItemAttributeMap, Item.ItemConstraint, Item.ItemImpl, Item.JaloCachedComputationException

Field Summary

Fields inherited from class de.hybris.platform.promotions.jalo.GeneratedProductBOGOFPromotion

DEFAULT_INITIAL_ATTRIBUTES, FREECOUNT, MESSAGECOULDHAVEFIRED, MESSAGEFIRED, QUALIFYINGCOUNT

Fields inherited from class de.hybris.platform.promotions.jalo.GeneratedProductPromotion

CATEGORIES, CATEGORYPROMOTIONRELATION_MARKMODIFIED, CATEGORYPROMOTIONRELATION_SRC_ORDERED, CATEGORYPROMOTIONRELATION_TGT_ORDERED, PRODUCTBANNER, PRODUCTPROMOTIONRELATION_MARKMODIFIED, PRODUCTPROMOTIONRELATION_SRC_ORDERED, PRODUCTPROMOTIONRELATION_TGT_ORDERED, PRODUCTS

Fields inherited from class de.hybris.platform.promotions.jalo.GeneratedAbstractPromotion

CODE, DESCRIPTION, DETAILSURL, ENABLED, ENDDATE, IMMUTABLEKEY, IMMUTABLEKEYHASH, PRIORITY, PROMOTIONGROUP, PROMOTIONGROUPHANDLER, PROMOTIONTYPE, RESTRICTIONS, STARTDATE, TITLE

Fields inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LANGUAGE_FALLBACK_ENABLED

Fields inherited from class de.hybris.platform.jalo.Item

_CREATION_TIME_INTERNAL, _MODIFIED_TIME_INTERNAL, accessorLog, CREATION_TIME, DISABLE_ATTRIBUTE_CHECK, DISABLE_ITEMCHECK_BEFORE_REMOVABLE, EVEN, FEATURE_ACCESSMAP_QUALIFIER, HJMPTS, INITIAL_CREATION_FLAG, isJaloOnly, MODIFIED_TIME, NEGATIVE, NOT_FOUND, OWNER, PK, POSITIVE, SAVE_FROM_SERVICE_LAYER, staticTransientObjects, TYPE

Fields inherited from class de.hybris.platform.util.BridgeAbstraction

impl, tenant

Constructor Summary

Constructors

Constructor	Description
ProductBOGOFPromotion()

Method Summary

Modifier and Type	Method	Description
protected void	buildDataUniqueKey(SessionContext ctx, java.lang.StringBuilder builder)	Build a unique data driven key.
java.util.List<PromotionResult>	evaluate(SessionContext ctx, PromotionEvaluationContext promoContext)	Evaluate whether a promotion can fire or not.
java.lang.String	getResultDescription(SessionContext ctx, PromotionResult promotionResult, java.util.Locale locale)	Get a localized user presentable description for the result of this promotion.

Methods inherited from class de.hybris.platform.promotions.jalo.GeneratedProductBOGOFPromotion

getAllMessageCouldHaveFired, getAllMessageCouldHaveFired, getAllMessageFired, getAllMessageFired, getDefaultAttributeModes, getFreeCount, getFreeCount, getFreeCountAsPrimitive, getFreeCountAsPrimitive, getMessageCouldHaveFired, getMessageCouldHaveFired, getMessageFired, getMessageFired, getQualifyingCount, getQualifyingCount, getQualifyingCountAsPrimitive, getQualifyingCountAsPrimitive, setAllMessageCouldHaveFired, setAllMessageCouldHaveFired, setAllMessageFired, setAllMessageFired, setFreeCount, setFreeCount, setFreeCount, setFreeCount, setMessageCouldHaveFired, setMessageCouldHaveFired, setMessageFired, setMessageFired, setQualifyingCount, setQualifyingCount, setQualifyingCount, setQualifyingCount

Methods inherited from class de.hybris.platform.promotions.jalo.ProductPromotion

findAllProducts, findEligibleProductsInBasket

Methods inherited from class de.hybris.platform.promotions.jalo.GeneratedProductPromotion

addToCategories, addToCategories, addToProducts, addToProducts, getCategories, getCategories, getCategoriesCount, getCategoriesCount, getProductBanner, getProductBanner, getProducts, getProducts, getProductsCount, getProductsCount, isMarkModifiedDisabled, removeFromCategories, removeFromCategories, removeFromProducts, removeFromProducts, setCategories, setCategories, setProductBanner, setProductBanner, setProducts, setProducts

Methods inherited from class de.hybris.platform.promotions.jalo.AbstractPromotion

buildDataUniqueKeyForCategories, buildDataUniqueKeyForPriceRows, buildDataUniqueKeyForProducts, buildMD5Hash, buildPromotionResultDataUnigueKey, createImmutableDeepClone, createItem, deepCloneAttributes, deepClonePriceRows, deletePromotionPriceRows, findImmutablePromotionByUniqueKey, findOrCreateImmutableClone, formatMessage, getAllPromotionType, getDataUniqueKey, getPriceForOrder, getPromotionResultDataUnigueKey, getPromotionType, getRestrictions, remove, setPromotionGroup, setRestrictions, toString

Methods inherited from class de.hybris.platform.promotions.jalo.GeneratedAbstractPromotion

getAllPromotionType, getCode, getCode, getDescription, getDescription, getDetailsURL, getDetailsURL, getEndDate, getEndDate, getImmutableKey, getImmutableKey, getImmutableKeyHash, getImmutableKeyHash, getPriority, getPriority, getPriorityAsPrimitive, getPriorityAsPrimitive, getPromotionGroup, getPromotionGroup, getPromotionType, getRestrictions, getStartDate, getStartDate, getTitle, getTitle, isEnabled, isEnabled, isEnabledAsPrimitive, isEnabledAsPrimitive, setCode, setCode, setDescription, setDescription, setDetailsURL, setDetailsURL, setEnabled, setEnabled, setEnabled, setEnabled, setEndDate, setEndDate, setImmutableKey, setImmutableKey, setImmutableKeyHash, setImmutableKeyHash, setPriority, setPriority, setPriority, setPriority, setPromotionGroup, setRestrictions, setStartDate, setStartDate, setTitle, setTitle

Methods inherited from class de.hybris.platform.jalo.GenericItem

getImplementation, getInitialProperties, getNonInitialAttributes, getRelatedItems, setRelatedItems

Methods inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllValuesSessionContext, getLocalizedProperty, getLocalizedProperty, getLocalizedPropertyInternal, getLocalizedPropertyNames, getLocalizedPropertyNames, hasLanguage, isEmptyValue, isFallbackEnabled, removeLocalizedProperty, removeLocalizedProperty, setAllLocalizedProperties, setAllLocalizedProperties, setLocalizedProperty, setLocalizedProperty

Methods inherited from class de.hybris.platform.jalo.ExtensibleItem

createNonClassAccessor, getAllProperties, getAllProperties, getProperty, getProperty, getPropertyNames, getPropertyNames, removeProperty, removeProperty, setAllProperties, setAllProperties, setProperty, setProperty

Methods inherited from class de.hybris.platform.jalo.Item

addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addNegativePermission, addPermission, addPositivePermission, assureExtensionsLoaded, changeTypeAfterCreation, checkConstraint, checkItemPermission, checkMandatoryAttribute, checkMandatoryAttribute, checkPermission, checkPermission, checkRemovable, clearPermission, compareTo, ctx, doAfterRemove, doBeforeRemove, equals, getAccessorFor, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributesInternal, getAllLinkedItems, getAndCheckCacheBoundItem, getAttribute, getAttribute, getCacheBoundItem, getComposedType, getComposedTypePK, getCreationTime, getCurrentlyRemovingCount, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItemsCount, getLinkedItemsCount, getLinkedItemsCount, getModificationTime, getNegativePermissions, getOwner, getPermissionMap, getPermissions, getPersistenceVersion, getPK, getPositivePermissions, getRestrictedPrincipals, getSession, getSyncObject, getTenant, getTransientObject, getTransientObjectMap, hashCode, hasRegisteredClassAccessorFor, internal_registerClassAccessorFor, internal_registerNonClassAccessorFor, invalidateLocalCaches, isAlive, isCacheBound, isCurrentlyRemoving, isCurrentlyRemoving, isEmptyRelationValue, isInCreate, isInstanceOf, isItemCheckBeforeRemoveableDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, notifyManagerAboutItemRemoval, readResolve, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, remove, removeItemCollection, removeItemCollection, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinks, removePartOfItems, removePartOfItems, setAllAttributes, setAllAttributes, setAllAttributesInternal, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAttribute, setAttribute, setAttributeFromString, setAttributeFromString, setCacheBound, setComposedType, setCreationTime, setImplementation, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setModificationTime, setNonInitialAttributes, setOwner, setPermissionsByMap, setTransientObject, setUseTA, useTA, writeReplace

Methods inherited from class de.hybris.platform.util.BridgeAbstraction

setTenant

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ProductBOGOFPromotion

public ProductBOGOFPromotion()

Method Detail

evaluate

public java.util.List<PromotionResult> evaluate(SessionContext ctx,
                                                PromotionEvaluationContext promoContext)

Description copied from class: AbstractPromotion

Evaluate whether a promotion can fire or not.

Specified by:

evaluate in class AbstractPromotion

Parameters:

ctx - The context to run the operation in

promoContext - The evaluation context

Returns:

the list of promotion results that this promotions creates

getResultDescription

public java.lang.String getResultDescription(SessionContext ctx,
                                             PromotionResult promotionResult,
                                             java.util.Locale locale)

Description copied from class: AbstractPromotion

Get a localized user presentable description for the result of this promotion.

Specified by:

getResultDescription in class AbstractPromotion

Parameters:

ctx - The context

promotionResult - The promotion result to be described

locale - The locale to use to generate the message

Returns:

a string description

buildDataUniqueKey

protected void buildDataUniqueKey(SessionContext ctx,
                                  java.lang.StringBuilder builder)

Description copied from class: AbstractPromotion

Build a unique data driven key. Build a unique key that is data driven. This will uniquely identify the rules used in this promotion and will form the immutable key for stored promotions. This method may be overridden in a subclass to customize the identifier.

Overrides:

buildDataUniqueKey in class ProductPromotion

Parameters:

ctx - The hybris context

builder - A StringBuilder used to build up the immutable key