Package com.broadleafcommerce.orderoperation.service.provider

Interface CampaignProvider

All Known Implementing Classes:

ExternalCampaignProvider

public interface CampaignProvider

Provider for interfacing with Campaigns.

Author:

Sunny Yu

Method Summary

Modifier and Type	Method	Description
CodeGenerationResult	generateCodesForVouchers(VoucherCodeGenerationRequest voucherCodeGenerationRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Generates CampaignCodes for voucher offers based on the given VoucherCodeGenerationRequest.

Method Detail

generateCodesForVouchers

CodeGenerationResult generateCodesForVouchers(VoucherCodeGenerationRequest voucherCodeGenerationRequest,
                                              @Nullable
                                              com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Generates CampaignCodes for voucher offers based on the given VoucherCodeGenerationRequest.

This method will generate and return the CampaignCodes in the same request, therefore it's meant for small batch of code generation only.

Parameters:

voucherCodeGenerationRequest - the VoucherCodeGenerationRequest to generate the voucher CampaignCodes with

contextInfo - context information surrounding sandboxing and multitenant state

Returns:

the CodeGenerationResult containing the generated voucher CampaignCodes based on the given VoucherCodeGenerationRequest