de.hybris.platform.voucher

Interface VoucherService

All Known Implementing Classes:

CouponVoucherService, DefaultVoucherService

public interface VoucherService

The service for vouchers.

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)
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)

Method Detail

afterOrderCreation

void afterOrderCreation(OrderModel order,
                        CartModel cart)

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

Parameters:

order - the newly created order

cart - the cart which this order has been created from

getAllVouchers

java.util.Collection<VoucherModel> getAllVouchers()

Returns:

a Collection with all found Vouchers

getAppliedVoucherCodes

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

Searches for all applied vouchers for the specific cart

Parameters:

cart - cart for which the vouchers are applied

Returns:

all applied voucher codes

getAppliedVoucherCodes

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

getAppliedVouchers

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

Given the order get a list of applied vouchers

Parameters:

order - the given order

Returns:

a Collection with all applied Vouchers for this order

getVoucher

VoucherModel getVoucher(java.lang.String voucherCode)

Get a voucher for a given voucher code

Parameters:

voucherCode - the code

Returns:

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

getPromotionVouchers

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

given the voucher code get a collection of related promotion vouchers

Parameters:

voucherCode - the code

Returns:

a Collection of PromotionVouchers

getSerialVouchers

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

given the voucher code get a collection of related serial vouchers

Parameters:

voucherCode - the code

Returns:

a Collection of SerialVouchers

redeemVoucher

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

For the given CartModel the given Voucher will be redeem.

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

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

createVoucherInvalidation

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

Creates VoucherInvalidation after the voucher is redeemed for the order

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

releaseVoucher

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

Releases the voucher for the cart

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

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

Throws:

ConsistencyCheckException

reserveVoucher

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

save

void save(VoucherModel voucher)

delete

void delete(VoucherModel voucher)