Package de.hybris.platform.commercefacades.voucher

Interface VoucherFacade

All Known Implementing Classes:

DefaultCouponFacade, DefaultVoucherFacade

public interface VoucherFacade

Voucher facade interface. Manages applying vouchers to cart and releasing it.

Method Summary

Modifier and Type	Method	Description
void	applyVoucher(java.lang.String voucherCode)	Apply voucher to current session cart
boolean	checkVoucherCode(java.lang.String voucherCode)	Check if voucher code is valid
VoucherData	getVoucher(java.lang.String voucherCode)	Get voucher base on its code
java.util.List<VoucherData>	getVouchersForCart()	Get vouchers applied for current session cart
void	releaseVoucher(java.lang.String voucherCode)	Remove voucher from current session cart

Method Detail

checkVoucherCode

boolean checkVoucherCode(java.lang.String voucherCode)

Check if voucher code is valid

Parameters:

voucherCode - voucher code

Returns:

true when voucher code is valid, false when voucher code is invalid

getVoucher

VoucherData getVoucher(java.lang.String voucherCode)
                throws VoucherOperationException

Get voucher base on its code

Parameters:

voucherCode - voucher identifier

Returns:

the VoucherData

Throws:

VoucherOperationException - if no voucher with the specified code is found

java.lang.IllegalArgumentException - if parameter code is null or empty

applyVoucher

void applyVoucher(java.lang.String voucherCode)
           throws VoucherOperationException

Apply voucher to current session cart

Parameters:

voucherCode - voucher identifier

Throws:

VoucherOperationException - if voucher wasn't applied due to some problems

java.lang.IllegalArgumentException - if parameter code is null or empty

releaseVoucher

void releaseVoucher(java.lang.String voucherCode)
             throws VoucherOperationException

Remove voucher from current session cart

Parameters:

voucherCode - voucher identifier

Throws:

VoucherOperationException - if voucher wasn't released due to some problems

java.lang.IllegalArgumentException - if parameter code is null or empty

getVouchersForCart

java.util.List<VoucherData> getVouchersForCart()

Get vouchers applied for current session cart

Returns:

list of vouchers applied for current session cart