org.broadleafcommerce.core.offer.service

Interface OfferAuditService

All Known Implementing Classes:

OfferAuditServiceImpl

public interface OfferAuditService

Service for managing OfferAudits. An OfferAudit is used to track usage of an offer and offer code for a particular Order and Customer. This provides easy and fast tracking of verifying max uses on particular Offers.

Author:

Phillip Verheyden (phillipuniverse)

Method Summary

Methods

Modifier and Type	Method and Description
Long	countOfferCodeUses(Long offerCodeId) Counts how many times the given offer code has been used in the system
Long	countUsesByCustomer(Long customerId, Long offerId) Counts how many times the an offer has been used by a customer
OfferAudit	create() Creates a new offer audit
void	delete(OfferAudit offerAudit)
OfferAudit	readAuditById(Long offerAuditId)
List<OfferAudit>	readOfferAuditsByOrderId(Long orderId) Read all audits by order id
OfferAudit	save(OfferAudit offerAudit) Persists an audit record to the database

Method Detail

readAuditById

OfferAudit readAuditById(Long offerAuditId)

save

OfferAudit save(OfferAudit offerAudit)

Persists an audit record to the database

delete

void delete(OfferAudit offerAudit)

create

OfferAudit create()

Creates a new offer audit

countUsesByCustomer

Long countUsesByCustomer(Long customerId,
                       Long offerId)

Counts how many times the an offer has been used by a customer

Parameters:

customerId -

offerId -

Returns:

countOfferCodeUses

Long countOfferCodeUses(Long offerCodeId)

Counts how many times the given offer code has been used in the system

Parameters:

offerCodeId -

Returns:

readOfferAuditsByOrderId

List<OfferAudit> readOfferAuditsByOrderId(Long orderId)

Read all audits by order id

Parameters:

orderId -

Returns: