Package org.broadleafcommerce.core.offer.dao

Interface OfferCodeDaoExtensionHandler

All Superinterfaces:

org.broadleafcommerce.common.extension.ExtensionHandler

All Known Implementing Classes:

DefaultOfferCodeDaoExtensionHandler

public interface OfferCodeDaoExtensionHandler
extends org.broadleafcommerce.common.extension.ExtensionHandler

Method Summary

Modifier and Type	Method	Description
org.broadleafcommerce.common.extension.ExtensionResultStatusType	createReadOfferCodeByCodeQuery(jakarta.persistence.EntityManager em, org.broadleafcommerce.common.extension.ExtensionResultHolder<jakarta.persistence.Query> resultHolder, String code, boolean cacheable, String cacheRegion)	This allows for an alternative, or non-default query to be created / used to find an offer code by a code string.

Methods inherited from interface org.broadleafcommerce.common.extension.ExtensionHandler

getPriority, isEnabled

Method Details

createReadOfferCodeByCodeQuery

org.broadleafcommerce.common.extension.ExtensionResultStatusType createReadOfferCodeByCodeQuery(jakarta.persistence.EntityManager em,
 org.broadleafcommerce.common.extension.ExtensionResultHolder<jakarta.persistence.Query> resultHolder,
 String code,
 boolean cacheable,
 String cacheRegion)

This allows for an alternative, or non-default query to be created / used to find an offer code by a code string. An implementor may wish to use a different named query, or add a filter. Implementors MUST return one of: ExtensionResultStatusType.HANDLED, ExtensionResultStatusType.HANDLED_STOP, or ExtensionResultStatusType.NOT_HANDLED.

ExtensionResultStatusType.HANDLED or ExtensionResultStatusType.HANDLED_STOP is returned, the resultHolder must be set with a valid instance of jakarta.persistence.Query. The cacheable and cacheRegion properties are hints and may be ignored by the implementor.

Parameters:

em -

resultHolder -

code -

cacheable -

cacheRegion -

Returns: