Voucher (Broadleaf Order Common 1.4.0-GA API)

java.lang.Object
- com.broadleafcommerce.order.common.domain.Voucher

All Implemented Interfaces:

Serializable
```
public class Voucher
extends Object
implements 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:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Voucher()

Constructors
Constructor and Description
`Voucher()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`String`	`getErrorMessage()` The error message from voucher code generation for this voucher.
`String`	`getGeneratedCampaignCode()` The generated campaign code for this voucher.
`String`	`getOfferId()` The `OfferRef.getId()` of the voucher offer.
`String`	`getVoucherCampaignId()` The id of the voucher campaign, which will be used for voucher code generation later on.
`int`	`hashCode()`
`boolean`	`isGenerationSuccessful()` Indicates whether the post-checkout voucher code generation was successful.
`boolean`	`isValidationSuccessful()` Indicates whether the post-checkout voucher validation was successful.
`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)` The `OfferRef.getId()` 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.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Voucher
```
public Voucher()
```
- Method Detail
  - getOfferId
```
public String getOfferId()
```
    The OfferRef.getId() of the voucher offer.
  - getVoucherCampaignId
```
public String getVoucherCampaignId()
```
    The id of the voucher campaign, which will be used for voucher code generation later on.
  - getGeneratedCampaignCode
```
public String getGeneratedCampaignCode()
```
    The generated campaign code 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
```
public String getErrorMessage()
```
    The error message from voucher code generation for this voucher.
  - setOfferId
```
public void setOfferId(String offerId)
```
    The OfferRef.getId() of the voucher offer.
  - setVoucherCampaignId
```
public void setVoucherCampaignId(String voucherCampaignId)
```
    The id of the voucher campaign, which will be used for voucher code generation later on.
  - setGeneratedCampaignCode
```
public void setGeneratedCampaignCode(String generatedCampaignCode)
```
    The generated campaign code 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
```
public void setErrorMessage(String errorMessage)
```
    The error message from voucher code generation for this voucher.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - canEqual
```
protected boolean canEqual(Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Voucher

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Voucher

Method Detail

getOfferId

getVoucherCampaignId

getGeneratedCampaignCode

isValidationSuccessful

isGenerationSuccessful

getErrorMessage

setOfferId

setVoucherCampaignId

setGeneratedCampaignCode

setValidationSuccessful

setGenerationSuccessful

setErrorMessage

equals

canEqual

hashCode

toString