Package com.broadleafcommerce.promotion.offer.service.engine.candidate

Class DefaultOfferUserService

java.lang.Object

com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferUserService

All Implemented Interfaces:

OfferUserService

public class DefaultOfferUserService
extends Object
implements OfferUserService

Author:

Chad Harchar (charchar)

Field Summary

Fields

Modifier and Type	Field	Description
protected OfferAuditDetailService<? extends OfferAuditDetail>	auditService
protected CustomerFields	customerFields
protected com.broadleafcommerce.common.extension.TypeFactory	offerFactory

Constructor Summary

Constructors

Constructor	Description
DefaultOfferUserService(OfferAuditDetailService<? extends OfferAuditDetail> auditService, CustomerFields customerFields, com.broadleafcommerce.common.extension.TypeFactory offerFactory)

Method Summary

Modifier and Type	Method	Description
protected com.broadleafcommerce.promotion.offer.client.web.context.CodeUsabilityInfo	addCodeUsages(List<? extends Offer> offersForCode, com.broadleafcommerce.promotion.offer.client.web.context.CodeUsabilityInfo codeUsabilityInfo, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
Set<UserTarget>	buildUserTargetsForCustomerContext(com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext customerContext)	Build and return a list of UserTargets based on the information provided in the CustomerContext.
boolean	canUserUseOffer(Offer offer, com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext customerContext, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	For the provided customer information, check if there are no more usages for the provided offer available.
protected UserTarget	createUserTarget(String targetValue, String targetType)
protected UserTarget	createUserTargetForOtherUserType(String userId, CustomerFields customerFields, String maxUsesPerUserStrategy)
protected String	determineCodeUsability(String code, boolean canUse, boolean hasOffers)
com.broadleafcommerce.promotion.offer.client.web.context.CodeUsabilityInfo	getCodeUsabilityInfo(String code, List<? extends Offer> offersForCode, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Checks the provided SharedCode.getCode() SharedCode's code} against the provided Offers' SharedCodes to determine whether the code is usable.
protected com.broadleafcommerce.promotion.offer.client.web.context.CodeUsage	getCodeUses(Offer offer, SharedCode sharedCode, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
protected Long	getCountMaxUserUses(Offer offer, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, UserTarget userTarget)
protected String	getUserIdForOtherUserType(com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext customerContext, String maxUsesPerUserStrategy)
boolean	isAnyCodeUsable(Set<String> codes, Offer offer, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	For the provided codes, check if there is no more usage for the provided offer available.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

auditService

protected final OfferAuditDetailService<? extends OfferAuditDetail> auditService

customerFields

protected final CustomerFields customerFields

offerFactory

protected final com.broadleafcommerce.common.extension.TypeFactory offerFactory

Constructor Detail

DefaultOfferUserService

public DefaultOfferUserService(OfferAuditDetailService<? extends OfferAuditDetail> auditService,
                               CustomerFields customerFields,
                               com.broadleafcommerce.common.extension.TypeFactory offerFactory)

Method Detail

buildUserTargetsForCustomerContext

@NonNull
public Set<UserTarget> buildUserTargetsForCustomerContext(@Nullable
                                                          com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext customerContext)

Description copied from interface: OfferUserService

Build and return a list of UserTargets based on the information provided in the CustomerContext.

Specified by:

buildUserTargetsForCustomerContext in interface OfferUserService

Parameters:

customerContext - The CustomerContext with which to build UserTargets

Returns:

a set of UserTargets

isAnyCodeUsable

public boolean isAnyCodeUsable(@Nullable
                               Set<String> codes,
                               @NonNull
                               Offer offer,
                               @Nullable
                               com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: OfferUserService

For the provided codes, check if there is no more usage for the provided offer available.

Specified by:

isAnyCodeUsable in interface OfferUserService

Parameters:

codes - list of codes to check against the offer

offer - the offer that we are checking usage against

contextInfo - context information around sandbox and multitenant state

Returns:

whether this offer has met it's max code usage for the given order and context info

getCodeUsabilityInfo

@NonNull
public com.broadleafcommerce.promotion.offer.client.web.context.CodeUsabilityInfo getCodeUsabilityInfo(@NonNull
                                                                                                       String code,
                                                                                                       @NonNull
                                                                                                       List<? extends Offer> offersForCode,
                                                                                                       @Nullable
                                                                                                       com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Description copied from interface: OfferUserService

Checks the provided SharedCode.getCode() SharedCode's code} against the provided Offers' SharedCodes to determine whether the code is usable.

Specified by:

getCodeUsabilityInfo in interface OfferUserService

Parameters:

code - the code for which to check usability

offersForCode - the offers against which we are checking usability

context - context information around sandbox and multitenant state

Returns:

a CodeUsabilityInfo which contains a boolean to tell if the code can be used and a detailed structure informing on the code usage.

addCodeUsages

protected com.broadleafcommerce.promotion.offer.client.web.context.CodeUsabilityInfo addCodeUsages(List<? extends Offer> offersForCode,
                                                                                                   com.broadleafcommerce.promotion.offer.client.web.context.CodeUsabilityInfo codeUsabilityInfo,
                                                                                                   com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

getCodeUses

protected com.broadleafcommerce.promotion.offer.client.web.context.CodeUsage getCodeUses(Offer offer,
                                                                                         SharedCode sharedCode,
                                                                                         com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

determineCodeUsability

protected String determineCodeUsability(String code,
                                        boolean canUse,
                                        boolean hasOffers)

canUserUseOffer

public boolean canUserUseOffer(@NonNull
                               Offer offer,
                               @Nullable
                               com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext customerContext,
                               @Nullable
                               com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: OfferUserService

For the provided customer information, check if there are no more usages for the provided offer available.

Specified by:

canUserUseOffer in interface OfferUserService

Parameters:

offer - the offer that we are checking usage against

customerContext - context information for the customer

contextInfo - context information around sandbox and multitenant state

Returns:

whether this offer has met it's max user usage for the given order and context info

createUserTargetForOtherUserType

protected UserTarget createUserTargetForOtherUserType(String userId,
                                                      CustomerFields customerFields,
                                                      String maxUsesPerUserStrategy)

getUserIdForOtherUserType

protected String getUserIdForOtherUserType(com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext customerContext,
                                           String maxUsesPerUserStrategy)

getCountMaxUserUses

protected Long getCountMaxUserUses(Offer offer,
                                   com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
                                   UserTarget userTarget)

createUserTarget

protected UserTarget createUserTarget(String targetValue,
                                      String targetType)