OfferCodeImpl (BroadleafCommerce 6.0.3-SNAPSHOT API)

java.lang.Object
- org.broadleafcommerce.core.offer.domain.OfferCodeImpl

All Implemented Interfaces:

Serializable, MultiTenantCloneable<OfferCode>, Status, OfferCode
```
@Entity
public class OfferCodeImpl
extends Object
implements OfferCode
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected ArchiveStatus`	`archiveStatus`
`protected Offer`	`deproxiedOffer`
`protected String`	`emailAddress`
`protected Long`	`id`
`protected Integer`	`maxUses`
`protected Offer`	`offer`
`protected String`	`offerCode`
`protected Date`	`offerCodeEndDate`
`protected Date`	`offerCodeStartDate`
`protected List<Order>`	`orders`
`protected Offer`	`sbClonedOffer`
`static long`	`serialVersionUID`
`protected int`	`uses` Deprecated.

Constructor Summary

Constructors
Constructor and Description

OfferCodeImpl()

Constructors
Constructor and Description
`OfferCodeImpl()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`<G extends OfferCode> CreateResponse<G>`	`createOrRetrieveCopyInstance(MultiTenantCopyContext context)` Clone this entity for the purpose of multiple tenancy.
`boolean`	`equals(Object o)`
`Character`	`getArchived()`
`String`	`getEmailAddress()`
`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.
`int`	`hashCode()`
`boolean`	`isActive()`
`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`	`setArchived(Character archived)`
`void`	`setEmailAddress(String emailAddress)`
`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.

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

- Field Detail
  - serialVersionUID
```
public static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - id
```
protected Long id
```
  - offer
```
protected Offer offer
```
  - offerCode
```
protected String offerCode
```
  - offerCodeStartDate
```
protected Date offerCodeStartDate
```
  - offerCodeEndDate
```
protected Date offerCodeEndDate
```
  - maxUses
```
protected Integer maxUses
```
  - uses
```
@Deprecated
protected int uses
```
    Deprecated.
  - emailAddress
```
protected String emailAddress
```
  - archiveStatus
```
protected ArchiveStatus archiveStatus
```
  - orders
```
protected List<Order> orders
```
  - sbClonedOffer
```
protected Offer sbClonedOffer
```
  - deproxiedOffer
```
protected Offer deproxiedOffer
```
- Constructor Detail
  - OfferCodeImpl
```
public OfferCodeImpl()
```
- Method Detail
  - getId
```
public Long getId()
```
    Specified by:
    
    getId in interface OfferCode
  - setId
```
public void setId(Long id)
```
    Specified by:
    
    setId in interface OfferCode
  - getOffer
```
public Offer getOffer()
```
    Specified by:
    
    getOffer in interface OfferCode
  - setOffer
```
public void setOffer(Offer offer)
```
    Specified by:
    
    setOffer in interface OfferCode
  - getOfferCode
```
public String getOfferCode()
```
    Specified by:
    
    getOfferCode in interface OfferCode
  - setOfferCode
```
public void setOfferCode(String offerCode)
```
    Specified by:
    
    setOfferCode in interface OfferCode
  - getMaxUses
```
public int getMaxUses()
```
    Description copied from interface: OfferCode
    
    Returns the maximum number of times that this code can be used regardless of Order or Customer 0 indicates unlimited usage.
    
    Specified by:
    
    getMaxUses in interface OfferCode
    
    Returns:
  - setMaxUses
```
public void setMaxUses(int maxUses)
```
    Description copied from interface: OfferCode
    
    Sets the maximum number of times that this code can be used regardless of Order or Customer 0 indicates unlimited usage.
    
    Specified by:
    
    setMaxUses in interface OfferCode
  - isUnlimitedUse
```
public boolean isUnlimitedUse()
```
    Description copied from interface: OfferCode
    
    Indicates that this is an unlimited-use code. By default this is true if OfferCode.getMaxUses() == 0
    
    Specified by:
    
    isUnlimitedUse in interface OfferCode
  - isLimitedUse
```
public boolean isLimitedUse()
```
    Description copied from interface: OfferCode
    
    Indicates that this code has a limit on how many times it can be used. By default this is true if OfferCode.getMaxUses() > 0
    
    Specified by:
    
    isLimitedUse in interface OfferCode
  - getUses
```
@Deprecated
public int getUses()
```
    Deprecated.
    
    Specified by:
    
    getUses in interface OfferCode
  - setUses
```
@Deprecated
public void setUses(int uses)
```
    Deprecated.
    
    Specified by:
    
    setUses in interface OfferCode
  - getEmailAddress
```
public String getEmailAddress()
```
    Specified by:
    
    getEmailAddress in interface OfferCode
  - setEmailAddress
```
public void setEmailAddress(String emailAddress)
```
    Specified by:
    
    setEmailAddress in interface OfferCode
  - getStartDate
```
public Date getStartDate()
```
    Specified by:
    
    getStartDate in interface OfferCode
  - setStartDate
```
public void setStartDate(Date startDate)
```
    Specified by:
    
    setStartDate in interface OfferCode
  - getEndDate
```
public Date getEndDate()
```
    Specified by:
    
    getEndDate in interface OfferCode
  - setEndDate
```
public void setEndDate(Date endDate)
```
    Specified by:
    
    setEndDate in interface OfferCode
  - getOrders
```
public List<Order> getOrders()
```
    Specified by:
    
    getOrders in interface OfferCode
  - setOrders
```
public void setOrders(List<Order> orders)
```
    Specified by:
    
    setOrders in interface OfferCode
  - getArchived
```
public Character getArchived()
```
    Specified by:
    
    getArchived in interface Status
  - setArchived
```
public void setArchived(Character archived)
```
    Specified by:
    
    setArchived in interface Status
  - isActive
```
public boolean isActive()
```
    Specified by:
    
    isActive in interface Status
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - createOrRetrieveCopyInstance
```
public <G extends OfferCode> CreateResponse<G> createOrRetrieveCopyInstance(MultiTenantCopyContext context)
                                                                     throws CloneNotSupportedException
```
    Description copied from interface: MultiTenantCloneable
    
    Clone this entity for the purpose of multiple tenancy. Note, extending classes should follow this pattern:
    public CreateResponse<MyClass> createOrRetrieveCopyInstance(MultiTenantCopyContext context) throws CloneNotSupportedException { CreateResponse<MyClass> createResponse = super.createOrRetrieveCopyInstance(context); if (createResponse.isAlreadyPopulated()) { return createResponse; } MyClass myClone = createResponse.getClone(); //copy extended field values on myClone here return createResponse; }
    Support should also be added for @Embeddable classes that contribute fields (collections or basic) to a cloneable entity:
    public CreateResponse<G extends MyClass> createOrRetrieveCopyInstance(MultiTenantCopyContext context) throws CloneNotSupportedException { CreateResponse createResponse = context.createOrRetrieveCopyInstance(this); MyClass myClone = createResponse.getClone(); //copy extended field values on myClone here return createResponse; }
    
    Specified by:
    
    createOrRetrieveCopyInstance in interface MultiTenantCloneable<OfferCode>
    
    Parameters:
    
    context - a context object providing persistence and library functionality for copying entities
    
    Returns:
    
    the resulting copy container, possibly already persisted
    
    Throws:
    
    CloneNotSupportedException - if there's a problem detected with the cloning configuration

Class OfferCodeImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

id

offer

offerCode

offerCodeStartDate

offerCodeEndDate

maxUses

uses

emailAddress

archiveStatus

orders

sbClonedOffer

deproxiedOffer

Constructor Detail

OfferCodeImpl

Method Detail

getId

setId

getOffer

setOffer

getOfferCode

setOfferCode

getMaxUses

setMaxUses

isUnlimitedUse

isLimitedUse

getUses

setUses

getEmailAddress

setEmailAddress

getStartDate

setStartDate

getEndDate

setEndDate

getOrders

setOrders

getArchived

setArchived

isActive

hashCode

equals

createOrRetrieveCopyInstance