OfferCode (BroadleafCommerce Framework 4.0.22-GA API)

All Superinterfaces:

MultiTenantCloneable<OfferCode>, Serializable, Status

All Known Implementing Classes:

OfferCodeImpl
```
public interface OfferCode
extends Status, Serializable, MultiTenantCloneable<OfferCode>
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`Date`	`getEndDate()`
`Long`	`getId()`
`int`	`getMaxUses()` Returns the maximum number of times that this code can be used regardless of Order or Customer 0 indicates unlimited usage.
`Offer`	`getOffer()`
`String`	`getOfferCode()`
`List<Order>`	`getOrders()`
`Date`	`getStartDate()`
`int`	`getUses()` Deprecated. replaced by the `OfferAudit` table
`boolean`	`isLimitedUse()` Indicates that this code has a limit on how many times it can be used.
`boolean`	`isUnlimitedUse()` Indicates that this is an unlimited-use code.
`void`	`setEndDate(Date endDate)`
`void`	`setId(Long id)`
`void`	`setMaxUses(int maxUses)` Sets the maximum number of times that this code can be used regardless of Order or Customer 0 indicates unlimited usage.
`void`	`setOffer(Offer offer)`
`void`	`setOfferCode(String offerCode)`
`void`	`setOrders(List<Order> orders)`
`void`	`setStartDate(Date startDate)`
`void`	`setUses(int uses)` Deprecated. replaced by the `OfferAudit` table

Methods inherited from interface org.broadleafcommerce.common.persistence.Status
getArchived, isActive, setArchived

Methods inherited from interface org.broadleafcommerce.common.copy.MultiTenantCloneable
createOrRetrieveCopyInstance

- Method Detail
  - getId
```
Long getId()
```
  - setId
```
void setId(Long id)
```
  - getOffer
```
Offer getOffer()
```
  - setOffer
```
void setOffer(Offer offer)
```
  - getOfferCode
```
String getOfferCode()
```
  - setOfferCode
```
void setOfferCode(String offerCode)
```
  - getStartDate
```
Date getStartDate()
```
  - setStartDate
```
void setStartDate(Date startDate)
```
  - getEndDate
```
Date getEndDate()
```
  - setEndDate
```
void setEndDate(Date endDate)
```
  - getMaxUses
```
int getMaxUses()
```
    Returns the maximum number of times that this code can be used regardless of Order or Customer 0 indicates unlimited usage.
    
    Returns:
  - setMaxUses
```
void setMaxUses(int maxUses)
```
    Sets the maximum number of times that this code can be used regardless of Order or Customer 0 indicates unlimited usage.
    
    Parameters:
    
    maxUses -
  - isUnlimitedUse
```
boolean isUnlimitedUse()
```
    Indicates that this is an unlimited-use code. By default this is true if getMaxUses() == 0
  - isLimitedUse
```
boolean isLimitedUse()
```
    Indicates that this code has a limit on how many times it can be used. By default this is true if getMaxUses() > 0
  - getUses
```
@Deprecated
int getUses()
```
    Deprecated. replaced by the OfferAudit table
  - setUses
```
@Deprecated
void setUses(int uses)
```
    Deprecated. replaced by the OfferAudit table
  - getOrders
```
List<Order> getOrders()
```
  - setOrders
```
void setOrders(List<Order> orders)
```

Interface OfferCode

Method Summary

Methods inherited from interface org.broadleafcommerce.common.persistence.Status

Methods inherited from interface org.broadleafcommerce.common.copy.MultiTenantCloneable

Method Detail

getId

setId

getOffer

setOffer

getOfferCode

setOfferCode

getStartDate

setStartDate

getEndDate

setEndDate

getMaxUses

setMaxUses

isUnlimitedUse

isLimitedUse

getUses

setUses

getOrders

setOrders