de.hybris.platform.voucher.impl

Class DefaultVoucherService

java.lang.Object

de.hybris.platform.servicelayer.internal.service.AbstractService

de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

de.hybris.platform.voucher.impl.AbstractVoucherService

de.hybris.platform.voucher.impl.DefaultVoucherService

All Implemented Interfaces:

VoucherService, java.io.Serializable

Direct Known Subclasses:

CouponVoucherService

public class DefaultVoucherService
extends AbstractVoucherService
implements VoucherService

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

AbstractService.SerializableDTO

Field Summary

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

modelService, sessionService, txManager

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

tenant

Constructor Summary

Constructors

Constructor and Description
DefaultVoucherService()

Method Summary

Modifier and Type	Method and Description
void	afterOrderCreation(OrderModel order, CartModel cart) Transfers vouchers form cart to newly created order.
boolean	createVoucherInvalidation(java.lang.String voucherCode, OrderModel order) Creates VoucherInvalidation after the voucher is redeemed for the order
void	delete(VoucherModel voucher)
java.util.Collection<VoucherModel>	getAllVouchers()
java.util.Collection<java.lang.String>	getAppliedVoucherCodes(CartModel cart) Searches for all applied vouchers for the specific cart
java.util.Collection<java.lang.String>	getAppliedVoucherCodes(OrderModel order)
java.util.Collection<DiscountModel>	getAppliedVouchers(AbstractOrderModel order) Given the order get a list of applied vouchers
java.util.Collection<PromotionVoucherModel>	getPromotionVouchers(java.lang.String voucherCode) given the voucher code get a collection of related promotion vouchers
java.util.Collection<SerialVoucherModel>	getSerialVouchers(java.lang.String voucherCode) given the voucher code get a collection of related serial vouchers
VoucherModel	getVoucher(java.lang.String voucherCode) Get a voucher for a given voucher code
boolean	redeemVoucher(java.lang.String voucherCode, CartModel cart) For the given CartModel the given Voucher will be redeem.
VoucherInvalidationModel	redeemVoucher(java.lang.String voucherCode, OrderModel order)
protected void	refresh(AbstractOrderModel order)
void	releaseVoucher(java.lang.String voucherCode, CartModel cart) Releases the voucher for the cart
void	releaseVoucher(java.lang.String voucherCode, OrderModel order)
VoucherInvalidationModel	reserveVoucher(java.lang.String voucherCode, OrderModel order)
void	save(VoucherModel voucher)
protected void	saveIfModified(AbstractOrderModel order)

Methods inherited from class de.hybris.platform.voucher.impl.AbstractVoucherService

getAbstractOrder, getCart, getOrder, getProduct, getRestriction, getUser, getVoucher

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

getModelService, getSessionService, getTxManager, setModelService, setSessionService, setTxManager

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

afterPropertiesSet, getCurrentTenant, setBeanName, setCurrentTenant, writeReplace

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultVoucherService

public DefaultVoucherService()

Method Detail

afterOrderCreation

public void afterOrderCreation(OrderModel order,
                               CartModel cart)

Description copied from interface: VoucherService

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

Specified by:

afterOrderCreation in interface VoucherService

Parameters:

order - the newly created order

cart - the cart which this order has been created from

createVoucherInvalidation

public boolean createVoucherInvalidation(java.lang.String voucherCode,
                                         OrderModel order)

Description copied from interface: VoucherService

Creates VoucherInvalidation after the voucher is redeemed for the order

Specified by:

createVoucherInvalidation in interface VoucherService

Parameters:

voucherCode - voucher code to be redeemed

order - order for which the voucher will be redeemed

Returns:

true if the voucher has been redeemed for the given order

getAllVouchers

public java.util.Collection<VoucherModel> getAllVouchers()

Specified by:

getAllVouchers in interface VoucherService

Returns:

a Collection with all found Vouchers

getAppliedVoucherCodes

public java.util.Collection<java.lang.String> getAppliedVoucherCodes(CartModel cart)

Description copied from interface: VoucherService

Searches for all applied vouchers for the specific cart

Specified by:

getAppliedVoucherCodes in interface VoucherService

Parameters:

cart - cart for which the vouchers are applied

Returns:

all applied voucher codes

getAppliedVoucherCodes

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

Specified by:

getAppliedVoucherCodes in interface VoucherService

getAppliedVouchers

public java.util.Collection<DiscountModel> getAppliedVouchers(AbstractOrderModel order)

Description copied from interface: VoucherService

Given the order get a list of applied vouchers

Specified by:

getAppliedVouchers in interface VoucherService

Parameters:

order - the given order

Returns:

a Collection with all applied Vouchers for this order

getPromotionVouchers

public java.util.Collection<PromotionVoucherModel> getPromotionVouchers(java.lang.String voucherCode)

Description copied from interface: VoucherService

given the voucher code get a collection of related promotion vouchers

Specified by:

getPromotionVouchers in interface VoucherService

Parameters:

voucherCode - the code

Returns:

a Collection of PromotionVouchers

getSerialVouchers

public java.util.Collection<SerialVoucherModel> getSerialVouchers(java.lang.String voucherCode)

Description copied from interface: VoucherService

given the voucher code get a collection of related serial vouchers

Specified by:

getSerialVouchers in interface VoucherService

Parameters:

voucherCode - the code

Returns:

a Collection of SerialVouchers

getVoucher

public VoucherModel getVoucher(java.lang.String voucherCode)

Description copied from interface: VoucherService

Get a voucher for a given voucher code

Specified by:

getVoucher in interface VoucherService

Parameters:

voucherCode - the code

Returns:

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

redeemVoucher

public boolean redeemVoucher(java.lang.String voucherCode,
                             CartModel cart)
                      throws JaloPriceFactoryException

Description copied from interface: VoucherService

For the given CartModel the given Voucher will be redeem.

Specified by:

redeemVoucher in interface VoucherService

Parameters:

voucherCode - code of the Voucher

cart - the cart

Returns:

true if the redemption was successful

Throws:

JaloPriceFactoryException - in the case of exception on Jalo layer

redeemVoucher

public VoucherInvalidationModel redeemVoucher(java.lang.String voucherCode,
                                              OrderModel order)

Specified by:

redeemVoucher in interface VoucherService

releaseVoucher

public void releaseVoucher(java.lang.String voucherCode,
                           CartModel cart)
                    throws JaloPriceFactoryException

Description copied from interface: VoucherService

Releases the voucher for the cart

Specified by:

releaseVoucher in interface VoucherService

Parameters:

voucherCode - voucher code to be released

cart - cart for which the voucher will be released

Throws:

JaloPriceFactoryException - in the case of exception on jalo layer

releaseVoucher

public void releaseVoucher(java.lang.String voucherCode,
                           OrderModel order)
                    throws ConsistencyCheckException

Specified by:

releaseVoucher in interface VoucherService

Throws:

ConsistencyCheckException

reserveVoucher

public VoucherInvalidationModel reserveVoucher(java.lang.String voucherCode,
                                               OrderModel order)

Specified by:

reserveVoucher in interface VoucherService

delete

public void delete(VoucherModel voucher)

Specified by:

delete in interface VoucherService

save

public void save(VoucherModel voucher)

Specified by:

save in interface VoucherService

saveIfModified

protected void saveIfModified(AbstractOrderModel order)

refresh

protected void refresh(AbstractOrderModel order)