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 Summary

Methods

Modifier and Type	Method and Description
Long	getCustomerId() The id of the associated customer.
Long	getId() System generated unique id for this audit record.
Long	getOfferCodeId() The offer code that was used to retrieve the offer.
Long	getOfferId() The associated offer id.
Long	getOrderId() The associated order id.
Date	getRedeemedDate() The date the offer was applied to the order.
void	setCustomerId(Long customerId) Sets the customer id.
void	setId(Long id) Sets the id.
void	setOfferCodeId(Long offerCodeId) Sets the offer code that was used to retrieve the offer.
void	setOfferId(Long offerId) Sets the associated offer id.
void	setOrderId(Long orderId) Sets the associated order id.
void	setRedeemedDate(Date redeemedDate) Sets the offer redeemed date.

Method Detail

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()
                    throws UnsupportedOperationException

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.

For any 3.0 version starting with 3.0.6-GA and above, this has the potential to throw an UnsupportedOperationException. This column did not exist until 3.0.6-GA. Rather than prevent a drop-in release of 3.0.6-GA, by making this database modification, OfferAuditWeaveImpl should instead be weaved into this class to obtain the column definition along with correct implementation of this method.

Throws:

UnsupportedOperationException

See Also:

OfferAuditWeaveImpl}

setOfferCodeId

void setOfferCodeId(Long offerCodeId)
                    throws UnsupportedOperationException

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.

For any 3.0 version starting with 3.0.6-GA and above, this has the potential to throw an UnsupportedOperationException. This column did not exist until 3.0.6-GA. Rather than prevent a drop-in release of 3.0.6-GA, by making this database modification, OfferAuditWeaveImpl should instead be weaved into this class to obtain the column definition along with correct implementation of this method.

Throws:

UnsupportedOperationException

See Also:

OfferAuditWeaveImpl}

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 -

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 -