Package com.broadleafcommerce.billing.job.module

Class TaxCalculationProcessorHandler<P extends TaxCalculationHandlerRequests>

java.lang.Object

com.broadleafcommerce.billing.job.module.TaxCalculationProcessorHandler<P>

public class TaxCalculationProcessorHandler<P extends TaxCalculationHandlerRequests>
extends Object

Receives requests to calculate tax and delegates to the TaxService to find and call tax providers. Then, reacts to tax calculation results by adding details to the request DTO and creating a TaxProcessingResult. If calculation was unsuccessful, creates a TaxProcessingResult for the thrown exception.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final class	TaxCalculationProcessorHandler.TaxProcessingResults

Field Summary

Fields

Modifier and Type	Field	Description
protected BillingEventPricingService<BillingEventDTO,BillingEvent,BillingEventAdjustment,BillingEventItemWithTaxDetails,BillingEventPaymentWithTransaction>	billingEventPricingService
protected BillingJobMessageSender	sender
protected TaxService<BillingEventItem,BillingTaxDetail,BillingProcessingRequestWithBillingEventDTO>	taxService
protected com.broadleafcommerce.common.extension.TypeFactory	typeFactory

Constructor Summary

Constructors

Constructor	Description
TaxCalculationProcessorHandler()

Method Summary

Modifier and Type	Method	Description
protected BillingProcessingRequestWithBillingEventDTO	calculateTaxForBillingEventItems(BillingProcessingRequestWithBillingEventDTO billingProcessingRequestWithBillingEventDTO, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected Map<BillingEventItem,List<BillingTaxDetail>>	callTaxCalculationProcess(BillingProcessingRequestWithBillingEventDTO billingProcessingRequestWithBillingEventDTO, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	This method is solely responsible for calling the TaxService to calculate taxes.
protected int	getGatewayErrorCount(BillingProcessingRequest billingProcessingRequest)
protected TaxProcessingResult	handleTaxCalculationException(Exception exception, BillingProcessingRequestWithBillingEventDTO billingProcessingRequestWithBillingEventDTO)
protected TaxProcessingResult	handleTaxCalculationFailure(BillingProcessingRequestWithBillingEventDTO billingProcessingRequestWithBillingEventDTO)	Deprecated. Current implementation does not use TaxProcessingResultEnum.FAILURE states
protected TaxProcessingResult	handleTaxSuccess(BillingProcessingRequestWithBillingEventDTO billingProcessingRequestWithBillingEventDTO)
protected void	logPostTaxProcessingData(BillingEventDTO billingEventDTO)
protected void	logPreTaxProcessingData(BillingEventDTO billingEventDTO)
protected boolean	mapDoesNotContainTaxDetails(Map<BillingEventItem,List<BillingTaxDetail>> itemsWithTaxDetailsMap)	Determines whether the tax calculation was successful.
void	process(P taxCalculationHandlerRequests)	Deprecated. Use process(TaxCalculationHandlerRequests, ContextInfo) instead
void	process(P taxCalculationHandlerRequests, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected boolean	taxCalculationWasSuccessful(BillingProcessingRequestWithBillingEventDTO billingProcessingRequestWithBillingEventDTO)
protected void	updateRequestDTOWithTaxResultsMap(Map<BillingEventItem,List<BillingTaxDetail>> itemsWithTaxDetailsMap, BillingProcessingRequestWithBillingEventDTO billingProcessingRequestWithBillingEventDTO)	Handles updating the given DTO with results of the tax calculation stored on the map.

Methods inherited from class java.lang.Object

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

Field Details

billingEventPricingService

@Autowired
protected BillingEventPricingService<BillingEventDTO,BillingEvent,BillingEventAdjustment,BillingEventItemWithTaxDetails,BillingEventPaymentWithTransaction> billingEventPricingService

sender

@Autowired
protected BillingJobMessageSender sender

taxService

@Autowired
protected TaxService<BillingEventItem,BillingTaxDetail,BillingProcessingRequestWithBillingEventDTO> taxService

typeFactory

@Autowired
protected com.broadleafcommerce.common.extension.TypeFactory typeFactory

Constructor Details

TaxCalculationProcessorHandler

public TaxCalculationProcessorHandler()

Method Details

process

@Deprecated(since="1.0.0")
public void process(P taxCalculationHandlerRequests)

Deprecated.

Use process(TaxCalculationHandlerRequests, ContextInfo) instead

process

public void process(P taxCalculationHandlerRequests,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

logPreTaxProcessingData

protected void logPreTaxProcessingData(BillingEventDTO billingEventDTO)

logPostTaxProcessingData

protected void logPostTaxProcessingData(BillingEventDTO billingEventDTO)

calculateTaxForBillingEventItems

protected BillingProcessingRequestWithBillingEventDTO calculateTaxForBillingEventItems(BillingProcessingRequestWithBillingEventDTO billingProcessingRequestWithBillingEventDTO,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

callTaxCalculationProcess

protected Map<BillingEventItem,List<BillingTaxDetail>> callTaxCalculationProcess(BillingProcessingRequestWithBillingEventDTO billingProcessingRequestWithBillingEventDTO,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

This method is solely responsible for calling the TaxService to calculate taxes. The return value from the service is returned unchanged.

updateRequestDTOWithTaxResultsMap

protected void updateRequestDTOWithTaxResultsMap(Map<BillingEventItem,List<BillingTaxDetail>> itemsWithTaxDetailsMap,
 BillingProcessingRequestWithBillingEventDTO billingProcessingRequestWithBillingEventDTO)

Handles updating the given DTO with results of the tax calculation stored on the map. Aside from the BillingTaxDetail, it also features updated tax totals on items.

mapDoesNotContainTaxDetails

protected boolean mapDoesNotContainTaxDetails(Map<BillingEventItem,List<BillingTaxDetail>> itemsWithTaxDetailsMap)

Determines whether the tax calculation was successful. If the given map is empty or does not contain any tax details, it must not have been.

Parameters:

itemsWithTaxDetailsMap - map of items with their tax details after tax calculation

Returns:

whether this map contains tax details, and by extension, had its taxes calculated successfully

taxCalculationWasSuccessful

protected boolean taxCalculationWasSuccessful(BillingProcessingRequestWithBillingEventDTO billingProcessingRequestWithBillingEventDTO)

handleTaxSuccess

protected TaxProcessingResult handleTaxSuccess(BillingProcessingRequestWithBillingEventDTO billingProcessingRequestWithBillingEventDTO)

handleTaxCalculationFailure

@Deprecated(since="1.0.0")
protected TaxProcessingResult handleTaxCalculationFailure(BillingProcessingRequestWithBillingEventDTO billingProcessingRequestWithBillingEventDTO)

Deprecated.

Current implementation does not use TaxProcessingResultEnum.FAILURE states

handleTaxCalculationException

protected TaxProcessingResult handleTaxCalculationException(Exception exception,
 BillingProcessingRequestWithBillingEventDTO billingProcessingRequestWithBillingEventDTO)

getGatewayErrorCount

protected int getGatewayErrorCount(BillingProcessingRequest billingProcessingRequest)