Class OfferAuditDetail
java.lang.Object
com.broadleafcommerce.promotion.offer.domain.OfferAuditDetail
- All Implemented Interfaces:
com.broadleafcommerce.data.tracking.core.ContextStateAware
,Serializable
public class OfferAuditDetail
extends Object
implements Serializable, com.broadleafcommerce.data.tracking.core.ContextStateAware
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:
- Marie Standeven (marieStandeven)
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
The tracking ID of the campaign this audit is for.com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState
A subset ofTracking
information to expose the context state for this object.The date and time when the relatedoffer code
was applied.getId()
The context ID of the offer audit detail.The ID of the offer audit summary that this audit is for.The ID of the offer code that this audit information is for.The ID of the offer this audit is for.The id of the transaction upon which the related offer was used.The type of the transaction upon which the related offer was used.getUser()
The identifying info of the user that used the offer code.int
hashCode()
void
setCampaignTrackingId
(String campaignTrackingId) The tracking ID of the campaign this audit is for.void
setContextState
(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState) A subset ofTracking
information to expose the context state for this object.void
setDateApplied
(Instant dateApplied) The date and time when the relatedoffer code
was applied.void
The context ID of the offer audit detail.void
setOfferAuditSummaryId
(String offerAuditSummaryId) The ID of the offer audit summary that this audit is for.void
setOfferCodeId
(String offerCodeId) The ID of the offer code that this audit information is for.void
setOfferId
(String offerId) The ID of the offer this audit is for.void
setTransactionReferenceId
(String transactionReferenceId) The id of the transaction upon which the related offer was used.void
setTransactionReferenceType
(String transactionReferenceType) The type of the transaction upon which the related offer was used.void
setUser
(UserTarget user) The identifying info of the user that used the offer code.toString()
-
Constructor Details
-
OfferAuditDetail
public OfferAuditDetail()
-
-
Method Details
-
getId
The context ID of the offer audit detail.- Returns:
- the context ID of the offer audit detail
-
getOfferAuditSummaryId
The ID of the offer audit summary that this audit is for.- Returns:
- The ID of the offer audit summary that this audit is for.
-
getOfferCodeId
The ID of the offer code that this audit information is for.- Returns:
- The ID of the offer code that this audit information is for.
-
getOfferId
The ID of the offer this audit is for.- Returns:
- the ID of the offer this audit is for
-
getCampaignTrackingId
The tracking ID of the campaign this audit is for.- Returns:
- the tracking ID of the campaign this audit is for
-
getUser
The identifying info of the user that used the offer code.- Returns:
- The identifying info of the user that used the offer code.
-
getTransactionReferenceType
The type of the transaction upon which the related offer was used. For example, "ORDER".- Returns:
- The type of the transaction upon which the related offer was used.
-
getTransactionReferenceId
The id of the transaction upon which the related offer was used. Used to check against anOffer.getMaxUsesPerOrder()
.- Returns:
- The id of the transaction upon which the related offer was used.
-
getDateApplied
The date and time when the relatedoffer code
was applied.- Returns:
- the date and time when the related
offer code
was applied
-
getContextState
public com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()A subset ofTracking
information to expose the context state for this object.- Specified by:
getContextState
in interfacecom.broadleafcommerce.data.tracking.core.ContextStateAware
- Returns:
- a subset of
Tracking
information to expose the context state for this object
-
setId
The context ID of the offer audit detail.- Parameters:
id
- the context ID of the offer audit detail
-
setOfferAuditSummaryId
The ID of the offer audit summary that this audit is for.- Parameters:
offerAuditSummaryId
- The ID of the offer audit summary that this audit is for.
-
setOfferCodeId
The ID of the offer code that this audit information is for.- Parameters:
offerCodeId
- The ID of the offer code that this audit information is for.
-
setOfferId
The ID of the offer this audit is for.- Parameters:
offerId
- the ID of the offer this audit is for
-
setCampaignTrackingId
The tracking ID of the campaign this audit is for.- Parameters:
campaignTrackingId
- the tracking ID of the campaign this audit is for
-
setUser
The identifying info of the user that used the offer code.- Parameters:
user
- The identifying info of the user that used the offer code.
-
setTransactionReferenceType
The type of the transaction upon which the related offer was used. For example, "ORDER".- Parameters:
transactionReferenceType
- The type of the transaction upon which the related offer was used.
-
setTransactionReferenceId
The id of the transaction upon which the related offer was used. Used to check against anOffer.getMaxUsesPerOrder()
.- Parameters:
transactionReferenceId
- The id of the transaction upon which the related offer was used.
-
setDateApplied
The date and time when the relatedoffer code
was applied.- Parameters:
dateApplied
- the date and time when the relatedoffer code
was applied
-
setContextState
public void setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState) A subset ofTracking
information to expose the context state for this object.- Specified by:
setContextState
in interfacecom.broadleafcommerce.data.tracking.core.ContextStateAware
- Parameters:
contextState
- a subset ofTracking
information to expose the context state for this object
-
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
-