Package org.broadleafcommerce.core.offer.domain

Interface OfferAudit

All Superinterfaces:
Serializable
All Known Implementing Classes:
OfferAuditImpl
public interface OfferAudit extends Serializable
Captures when an offer was applied to a customer.

Utilized by the offer process to enforce max use by customer rules and as a high-level audit of what orders and customers have used an offer.

  • Method Details

    • getId

      Long getId()
      System generated unique id for this audit record.
      Returns:

    • setId

      void setId(Long id)
      Sets the id.
      Parameters:
      id -

    • getOfferId

      Long getOfferId()
      The associated offer id.
      Returns:

    • setOfferId

      void setOfferId(Long offerId)
      Sets the associated offer id.
      Parameters:
      offerId -

    • getOfferCodeId

      Long getOfferCodeId()

      The offer code that was used to retrieve the offer. This will be null if the offer was automatically applied and not obtained by an OfferCode.

    • setOfferCodeId

      void setOfferCodeId(Long offerCodeId)

      Sets the offer code that was used to retrieve the offer. This should be null if the offer was automatically applied and not obtained by an OfferCode.

    • getOrderId

      Long getOrderId()
      The associated order id.
      Returns:

    • setOrderId

      void setOrderId(Long orderId)
      Sets the associated order id.
      Parameters:
      orderId -

    • getCustomerId

      Long getCustomerId()
      The id of the associated customer.
      Returns:

    • setCustomerId

      void setCustomerId(Long customerId)
      Sets the customer id.
      Parameters:
      customerId -

    • getAccountId

      Long getAccountId()
      The id of the associated account.
      Returns:

    • setAccountId

      void setAccountId(Long customerId)
      Sets the associated account id.
      Parameters:
      customerId -

    • getRedeemedDate

      Date getRedeemedDate()
      The date the offer was applied to the order.
      Returns:

    • setRedeemedDate

      void setRedeemedDate(Date redeemedDate)
      Sets the offer redeemed date.
      Parameters:
      redeemedDate -