Class Voucher
java.lang.Object
com.broadleafcommerce.order.common.domain.Voucher
- All Implemented Interfaces:
Serializable
Represents a voucher for a Cart or an Order containing a voucher code to use for a future
purchase.
- Author:
- Sunny Yu
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
Map holding any additional attributes that do not match any defined properties.The code used (if any) that triggered the application of the offer for this voucher.The error message from voucher code generation for this voucher.The generated campaign code for this voucher.TheOfferRef
of the voucher offer.The id of the voucher campaign, which will be used for voucher code generation later on.int
hashCode()
boolean
Indicates whether the post-checkout voucher code generation was successful.boolean
Indicates whether the post-checkout voucher validation was successful.void
setAttributes
(Map<String, Object> attributes) Map holding any additional attributes that do not match any defined properties.void
setCodeUsed
(String codeUsed) The code used (if any) that triggered the application of the offer for this voucher.void
setErrorMessage
(String errorMessage) The error message from voucher code generation for this voucher.void
setGeneratedCampaignCode
(String generatedCampaignCode) The generated campaign code for this voucher.void
setGenerationSuccessful
(boolean generationSuccessful) Indicates whether the post-checkout voucher code generation was successful.void
setOfferId
(String offerId) void
setOfferRef
(OfferRef offerRef) TheOfferRef
of the voucher offer.void
setValidationSuccessful
(boolean validationSuccessful) Indicates whether the post-checkout voucher validation was successful.void
setVoucherCampaignId
(String voucherCampaignId) The id of the voucher campaign, which will be used for voucher code generation later on.toString()
-
Constructor Details
-
Voucher
public Voucher()
-
-
Method Details
-
getOfferId
-
setOfferId
-
getOfferRef
TheOfferRef
of the voucher offer. -
getVoucherCampaignId
The id of the voucher campaign, which will be used for voucher code generation later on. -
getGeneratedCampaignCode
The generated campaign code for this voucher. -
getCodeUsed
The code used (if any) that triggered the application of the offer for this voucher. -
isValidationSuccessful
public boolean isValidationSuccessful()Indicates whether the post-checkout voucher validation was successful. -
isGenerationSuccessful
public boolean isGenerationSuccessful()Indicates whether the post-checkout voucher code generation was successful. -
getErrorMessage
The error message from voucher code generation for this voucher. -
getAttributes
Map holding any additional attributes that do not match any defined properties. -
setOfferRef
TheOfferRef
of the voucher offer. -
setVoucherCampaignId
The id of the voucher campaign, which will be used for voucher code generation later on. -
setGeneratedCampaignCode
The generated campaign code for this voucher. -
setCodeUsed
The code used (if any) that triggered the application of the offer for this voucher. -
setValidationSuccessful
public void setValidationSuccessful(boolean validationSuccessful) Indicates whether the post-checkout voucher validation was successful. -
setGenerationSuccessful
public void setGenerationSuccessful(boolean generationSuccessful) Indicates whether the post-checkout voucher code generation was successful. -
setErrorMessage
The error message from voucher code generation for this voucher. -
setAttributes
Map holding any additional attributes that do not match any defined properties. -
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
-