Package com.broadleafcommerce.cartoperation.domain

Class OfferAudit

java.lang.Object
com.broadleafcommerce.cartoperation.domain.OfferAudit
All Implemented Interfaces:
Serializable
public class OfferAudit extends Object implements Serializable

Captures audit relevant data when an offer was applied to an order.

Utilized by the offer engine to enforce max use and frequency rules and as a high-level audit of what orders and users have used an offer.

Author:
Chad Harchar (charchar)
See Also:

  • Constructor Details

    • OfferAudit

      public OfferAudit()

  • Method Details

    • getOfferId

      public String getOfferId()
      The associated offer's id.
      Returns:
      The associated offer's id.

    • getCampaignCode

      public String getCampaignCode()
      The campaign code string that this audit information is for.
      Returns:
      The campaign code string that this audit information is for.

    • getCampaignTrackingId

      public String getCampaignTrackingId()
      The tracking ID of the campaign this audit is for.
      Returns:
      the tracking ID of the campaign this audit is for

    • getUser

      public UserTarget getUser()
      The identifying info of the user that used the related offer.
      Returns:
      The identifying info of the user that used the related offer.

    • getOrderId

      public String getOrderId()
      The id of the cart upon which the related offer was used.
      Returns:
      The id of the cart upon which the related offer was used.

    • getSharedCode

      public String getSharedCode()
      The string of the offer code used to apply the related offer.
      Returns:
      The string of the offer code used to apply the related offer.

    • getDateApplied

      public Instant getDateApplied()
      The date and time when the related offer was applied.
      Returns:
      The date and time when the related offer was applied.

    • setOfferId

      public void setOfferId(String offerId)
      The associated offer's id.
      Parameters:
      offerID - The associated offer's id.

    • setCampaignCode

      public void setCampaignCode(String campaignCode)
      The campaign code string that this audit information is for.
      Parameters:
      campaignCode - The campaign code string that this audit information is for.

    • setCampaignTrackingId

      public void setCampaignTrackingId(String campaignTrackingId)
      The tracking ID of the campaign this audit is for.
      Parameters:
      campaignTrackingId - the tracking ID of the campaign this audit is for

    • setUser

      public void setUser(UserTarget user)
      The identifying info of the user that used the related offer.
      Parameters:
      user - The identifying info of the user that used the related offer.

    • setOrderId

      public void setOrderId(String orderId)
      The id of the cart upon which the related offer was used.
      Parameters:
      orderId - The id of the cart upon which the related offer was used.

    • setSharedCode

      public void setSharedCode(String sharedCode)
      The string of the offer code used to apply the related offer.
      Parameters:
      sharedCode - The string of the offer code used to apply the related offer.

    • setDateApplied

      public void setDateApplied(Instant dateApplied)
      The date and time when the related offer was applied.
      Parameters:
      dateApplied - The date and time when the related offer was applied.

    • 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