de.hybris.platform.promotions.jalo

Class PromotionOrderEntryAdjustAction

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.GeneratedAbstractPromotionAction

de.hybris.platform.promotions.jalo.AbstractPromotionAction

de.hybris.platform.promotions.jalo.GeneratedPromotionOrderEntryAdjustAction

de.hybris.platform.promotions.jalo.PromotionOrderEntryAdjustAction

All Implemented Interfaces:

Serializable, Comparable

Direct Known Subclasses:

GeneratedCachedPromotionOrderEntryAdjustAction

public class PromotionOrderEntryAdjustAction
extends GeneratedPromotionOrderEntryAdjustAction

PromotionOrderEntryAdjustAction. Action to create a fixed price adjustment to a specific quantity of products. The adjustment is applied against the unit price of the OrderEntry. For this reason if the OrderEntry quantity is different from the number to adjust we need to evenly distribute the discount so that the cart is correctly calculated. The only other way to deal with this would be to split the OrderEntry into two, one with the already used items and one with the discounted items, but this would mean invalidating the promotion context as it wraps all of the OrderEntry objects Applying this action creates an order entry discount value for the first order entry with sufficient quantity of products. Undoing this action removes the order entry discount value created. If there is no single order entry with at least GeneratedPromotionOrderEntryAdjustAction.getOrderEntryQuantity(de.hybris.platform.jalo.SessionContext) quantity of product GeneratedPromotionOrderEntryAdjustAction.getOrderEntryProduct(de.hybris.platform.jalo.SessionContext) then this action will fail to apply. This can happen if the product quantity is split across multiple order entries.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	PromotionOrderEntryAdjustAction.OrderEntryAndDiscountValue

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.GeneratedPromotionOrderEntryAdjustAction

AMOUNT, DEFAULT_INITIAL_ATTRIBUTES, ORDERENTRYNUMBER, ORDERENTRYPRODUCT, ORDERENTRYQUANTITY

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

GUID, MARKEDAPPLIED, PROMOTIONRESULT, PROMOTIONRESULTHANDLER

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, 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 and Description
PromotionOrderEntryAdjustAction()

Method Summary

Modifier and Type	Method and Description
boolean	apply(SessionContext ctx) Apply the action to the order.
protected void	deepCloneAttributes(SessionContext ctx, Map values) Called to deep clone attributes of this instance The values map contains all the attributes defined on this instance.
protected AbstractOrderEntry	findOrderEntry(AbstractOrder order, SessionContext ctx, Integer orderEntryNumber)
protected static DiscountValue	findOrderEntryDiscountValue(SessionContext ctx, AbstractOrderEntry orderEntry, String discountValueCode)
protected static PromotionOrderEntryAdjustAction.OrderEntryAndDiscountValue	findOrderEntryDiscountValue(SessionContext ctx, AbstractOrder order, String discountValueCode)
double	getValue(SessionContext ctx) Get the total value of this action.
boolean	isAppliedToOrder(SessionContext ctx) Test if this action is applied to the order.
boolean	undo(SessionContext ctx) Unapply the action from the order.

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

getAmount, getAmount, getAmountAsPrimitive, getAmountAsPrimitive, getDefaultAttributeModes, getOrderEntryNumber, getOrderEntryNumber, getOrderEntryNumberAsPrimitive, getOrderEntryNumberAsPrimitive, getOrderEntryProduct, getOrderEntryProduct, getOrderEntryQuantity, getOrderEntryQuantity, getOrderEntryQuantityAsPrimitive, getOrderEntryQuantityAsPrimitive, setAmount, setAmount, setAmount, setAmount, setOrderEntryNumber, setOrderEntryNumber, setOrderEntryNumber, setOrderEntryNumber, setOrderEntryProduct, setOrderEntryProduct, setOrderEntryQuantity, setOrderEntryQuantity, setOrderEntryQuantity, setOrderEntryQuantity

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

apply, deepClone, getGuid, insertFirstGlobalDiscountValue, insertFirstOrderEntryDiscountValue, isAppliedToOrder, undo

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

createItem, getGuid, getPromotionResult, getPromotionResult, isMarkedApplied, isMarkedApplied, isMarkedAppliedAsPrimitive, isMarkedAppliedAsPrimitive, setGuid, setGuid, setMarkedApplied, setMarkedApplied, setMarkedApplied, setMarkedApplied, setPromotionResult, setPromotionResult

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

getInitialProperties, getNonInitialAttributes

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, readResolve, refreshRemote, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, remove, 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, toString, useTA, writeReplace

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

getImplementation, setTenant

Methods inherited from class java.lang.Object

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

Constructor Detail

PromotionOrderEntryAdjustAction

public PromotionOrderEntryAdjustAction()

Method Detail

apply

public boolean apply(SessionContext ctx)

Description copied from class: AbstractPromotionAction

Apply the action to the order. Do not call AbstractOrder.recalculate() to update the totals as this disposes of all applied discounts and the promotions engine is unable to intercept the recalculate call to reinstate these.

Specified by:

apply in class AbstractPromotionAction

Parameters:

ctx - The hybris context

Returns:

true if discounts have been applied and calculateTotals needs to be called, false otherwise.

findOrderEntry

protected AbstractOrderEntry findOrderEntry(AbstractOrder order,
                                            SessionContext ctx,
                                            Integer orderEntryNumber)

undo

public boolean undo(SessionContext ctx)

Description copied from class: AbstractPromotionAction

Unapply the action from the order.

Specified by:

undo in class AbstractPromotionAction

Parameters:

ctx - The hybris context

Returns:

true if discounts have been removed and calculateTotals needs to be called, false otherwise.

isAppliedToOrder

public boolean isAppliedToOrder(SessionContext ctx)

Description copied from class: AbstractPromotionAction

Test if this action is applied to the order.

Specified by:

isAppliedToOrder in class AbstractPromotionAction

Parameters:

ctx - The hybris context

Returns:

true if the action is applied, false otherwise.

getValue

public double getValue(SessionContext ctx)

Description copied from class: AbstractPromotionAction

Get the total value of this action. For actions providing a discount this should be a positive value.

Specified by:

getValue in class AbstractPromotionAction

Parameters:

ctx - The hybris context

Returns:

The double value that is the value of this action

deepCloneAttributes

protected void deepCloneAttributes(SessionContext ctx,
                                   Map values)

Called to deep clone attributes of this instance The values map contains all the attributes defined on this instance. The map will be used to initialize a new instance of the Action that is a clone of this instance. This method can remove, replace or add to the Map of attributes.

Overrides:

deepCloneAttributes in class AbstractPromotionAction

Parameters:

ctx - The hybris context

values - The map to write into

findOrderEntryDiscountValue

protected static PromotionOrderEntryAdjustAction.OrderEntryAndDiscountValue findOrderEntryDiscountValue(SessionContext ctx,
                                                                                                        AbstractOrder order,
                                                                                                        String discountValueCode)

findOrderEntryDiscountValue

protected static DiscountValue findOrderEntryDiscountValue(SessionContext ctx,
                                                           AbstractOrderEntry orderEntry,
                                                           String discountValueCode)