Package de.hybris.platform.voucher.jalo

Class VoucherManager

java.lang.Object

de.hybris.platform.jalo.Manager

de.hybris.platform.jalo.extension.Extension

de.hybris.platform.voucher.jalo.GeneratedVoucherManager

de.hybris.platform.voucher.jalo.VoucherManager

All Implemented Interfaces:

ItemLifecycleListener, java.io.Serializable

public class VoucherManager
extends GeneratedVoucherManager

The manager for voucher items.

See Also:

Serialized Form

Nested Class Summary

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

Extension.RestrictedLanguagesProvider, Extension.RightsProvider

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

Manager.GenericManagerSingletonCreator, Manager.ManagerSingletonCreator

Field Summary

Fields inherited from class de.hybris.platform.voucher.jalo.GeneratedVoucherManager

DEFAULT_INITIAL_ATTRIBUTES

Constructor Summary

Constructors

Constructor	Description
VoucherManager()

Method Summary

Modifier and Type	Method	Description
void	afterOrderCreation(Order order, Cart cart)	Transfers vouchers form cart to newly created order.
void	afterOrderCreation(SessionContext ctx, Order order, Cart cart)	Transfers vouchers form cart to newly created order.
void	createEssentialData(java.util.Map params, JspContext jspc)	Creates essential data for the voucher extension.
java.util.Collection	getAllVouchers()
java.util.Collection<java.lang.String>	getAppliedVoucherCodes(Cart item)
java.util.Collection<java.lang.String>	getAppliedVoucherCodes(Order order)
java.util.Collection<java.lang.String>	getAppliedVoucherCodes(SessionContext ctx, Cart item)
java.util.Collection<java.lang.String>	getAppliedVoucherCodes(SessionContext ctx, Order order)
java.util.Collection	getAppliedVouchers(AbstractOrder anOrder)
static VoucherManager	getInstance()
static VoucherManager	getInstance(JaloSession jaloSession)	Gets the Instance of the VoucherManager
java.util.Collection	getPromotionVouchers(java.lang.String voucherCode)
java.util.Collection	getSerialVouchers(java.lang.String aVoucherCode)
Voucher	getVoucher(java.lang.String voucherCode)
boolean	redeemVoucher(java.lang.String aVoucherCode, Cart aCart)	For the given Cart the given Voucher will be redeem.
VoucherInvalidation	redeemVoucher(java.lang.String aVoucherCode, Order anOrder)
void	releaseVoucher(java.lang.String aVoucherCode, Cart aCart)
void	releaseVoucher(java.lang.String aVoucherCode, Order anOrder)
VoucherInvalidation	reserveVoucher(java.lang.String aVoucherCode, Order anOrder)

Methods inherited from class de.hybris.platform.voucher.jalo.GeneratedVoucherManager

createDateRestriction, createDateRestriction, createNewCustomerRestriction, createNewCustomerRestriction, createOrderRestriction, createOrderRestriction, createProductCategoryRestriction, createProductCategoryRestriction, createProductQuantityRestriction, createProductQuantityRestriction, createProductRestriction, createProductRestriction, createPromotionVoucher, createPromotionVoucher, createRegularCustomerOrderQuantityRestriction, createRegularCustomerOrderQuantityRestriction, createRegularCustomerOrderTotalRestriction, createRegularCustomerOrderTotalRestriction, createRestriction, createRestriction, createSerialVoucher, createSerialVoucher, createUserRestriction, createUserRestriction, createVoucherInvalidation, createVoucherInvalidation, getDefaultAttributeModes, getName

Methods inherited from class de.hybris.platform.jalo.extension.Extension

checkBeforeItemRemoval, createProjectData, createSampleData, getCreatorDescription, getCreatorName, getCreatorParameterDefault, getCreatorParameterNames, getCreatorParameterPossibleValues, getRemote, isCreatorDisabled, notifyInitializationEnd, notifyInitializationStart, notifyItemRemoval, onFirstSessionCreation, writeReplace

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

afterItemCreation, beforeItemCreation, destroy, extractNonRequiredRemoteFromItem, extractRequiredRemoteFromItem, getAllValuesSessionContext, getAttribute, getAttributeMap, getFirstItemByAttribute, getFirstItemByAttribute, getRemoteManagerClass, getSession, getSingletonManagerInstance, getTenant, getTransientObject, getTransientObjectMap, init, setAttribute, setTenant, setTransientObject, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

VoucherManager

public VoucherManager()

Method Detail

createEssentialData

public void createEssentialData(java.util.Map params,
                                JspContext jspc)

Creates essential data for the voucher extension.

Overrides:

createEssentialData in class Extension

afterOrderCreation

public void afterOrderCreation(Order order,
                               Cart cart)

Transfers vouchers form cart to newly created order. Please make sure to call this always after OrderManager.createOrder(AbstractOrder).

Parameters:

order - the newly created order

cart - the cart which this order has been created from

afterOrderCreation

public void afterOrderCreation(SessionContext ctx,
                               Order order,
                               Cart cart)

Transfers vouchers form cart to newly created order. Please make sure to call this always after OrderManager.createOrder(AbstractOrder).

Parameters:

ctx - the session context

order - the newly created order

cart - the cart which this order has been created from

getAllVouchers

public java.util.Collection getAllVouchers()

Returns:

a Collection with all found Vouchers

getAppliedVoucherCodes

public java.util.Collection<java.lang.String> getAppliedVoucherCodes(Cart item)

getAppliedVoucherCodes

public java.util.Collection<java.lang.String> getAppliedVoucherCodes(Order order)

getAppliedVoucherCodes

public java.util.Collection<java.lang.String> getAppliedVoucherCodes(SessionContext ctx,
                                                                     Order order)

getAppliedVoucherCodes

public java.util.Collection<java.lang.String> getAppliedVoucherCodes(SessionContext ctx,
                                                                     Cart item)

getAppliedVouchers

public java.util.Collection getAppliedVouchers(AbstractOrder anOrder)

Parameters:

anOrder - the given order

Returns:

a Collection with all applied Vouchers for this order

getInstance

public static VoucherManager getInstance(JaloSession jaloSession)

Gets the Instance of the VoucherManager

Parameters:

jaloSession - the Jalo Session

Returns:

the Instance of the VoucherManager

getInstance

public static VoucherManager getInstance()

Returns:

instance of this manager

getVoucher

public Voucher getVoucher(java.lang.String voucherCode)

Parameters:

voucherCode - the code

Returns:

the first Voucher for the given code. This includes PromotionVoucher and SerialVoucher.

getPromotionVouchers

public java.util.Collection getPromotionVouchers(java.lang.String voucherCode)

Parameters:

voucherCode - the code

Returns:

a Collection of PromotionVouchers

getSerialVouchers

public java.util.Collection getSerialVouchers(java.lang.String aVoucherCode)

Parameters:

aVoucherCode - the code

Returns:

a Collection of SerialVouchers

redeemVoucher

public boolean redeemVoucher(java.lang.String aVoucherCode,
                             Cart aCart)
                      throws JaloPriceFactoryException

For the given Cart the given Voucher will be redeem.

WARNING!
If some methods for checking voucher availability are called before this method, all these methods have to be in one synchronize block! Suggested synchronization object is cart.

Parameters:

aVoucherCode - code of the Voucher

aCart - the cart

Returns:

true if the redemption was successful

Throws:

JaloPriceFactoryException

redeemVoucher

public VoucherInvalidation redeemVoucher(java.lang.String aVoucherCode,
                                         Order anOrder)

releaseVoucher

public void releaseVoucher(java.lang.String aVoucherCode,
                           Cart aCart)
                    throws JaloPriceFactoryException

Throws:

JaloPriceFactoryException

releaseVoucher

public void releaseVoucher(java.lang.String aVoucherCode,
                           Order anOrder)
                    throws ConsistencyCheckException

Throws:

ConsistencyCheckException

reserveVoucher

public VoucherInvalidation reserveVoucher(java.lang.String aVoucherCode,
                                          Order anOrder)