| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
CategoryCustomPersistenceHandlerExtensionHandler.manageParentCategoryForAdd(PersistencePackage persistencePackage,
Category category)
Perform any special handling for the parent category during a category add
|
ExtensionResultStatusType |
ProductCustomPersistenceHandlerExtensionHandler.manageParentCategoryForAdd(PersistencePackage persistencePackage,
Product product)
Perform any special handling for the parent category of a product during a product add
|
ExtensionResultStatusType |
CategoryCustomPersistenceHandlerExtensionHandler.manageParentCategoryForUpdate(PersistencePackage persistencePackage,
Category category)
Perform any special handling for the parent category during a category update
|
ExtensionResultStatusType |
ProductCustomPersistenceHandlerExtensionHandler.manageParentCategoryForUpdate(PersistencePackage persistencePackage,
Product product)
Perform any special handling for the parent category of a product during a product update
|
ExtensionResultStatusType |
ProductCustomPersistenceHandlerExtensionHandler.manageRemove(PersistencePackage persistencePackage,
Product product)
Perform any special handling for the remove
|
ExtensionResultStatusType |
AdminCatalogServiceExtensionHandler.persistSkuPermutation(Product product,
List<List<ProductOptionValue>> permutationsToGenerate,
ExtensionResultHolder<Integer> erh)
Customize the persistence of generated sku permutations based on product options.
|
ExtensionResultStatusType |
DefaultAdminCatalogExtensionHandler.persistSkuPermutation(Product product,
List<List<ProductOptionValue>> permutationsToGenerate,
ExtensionResultHolder<Integer> erh)
|
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
SkuCustomPersistenceHandlerExtensionHandler.skuUpdated(Sku updated)
Hook for the before and after save state of the sku
|
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
CategoryParentCategoryFieldPersistenceProviderExtensionHandler.manageParentCategory(Property property,
Category category)
Perform any special handling for the parent category of a category
|
ExtensionResultStatusType |
ProductParentCategoryFieldPersistenceProviderExtensionHandler.manageParentCategory(Property property,
Product product)
Perform any special handling for the parent category of a product
|
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
AdminProductTranslationExtensionHandler.applyTransformation(TranslationForm form)
If we are trying to translate a field on Product that starts with "defaultSku.", we really want to associate the
translation with Sku, its associated id, and the property name without "defaultSku."
|
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
StaticAssetServiceExtensionHandler.fileExists(String fileName,
ExtensionResultHolder holder) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
AbstractPageServiceExtensionHandler.getFieldDefinition(ExtensionResultHolder<FieldDefinition> erh,
Page page,
String fieldKey) |
ExtensionResultStatusType |
PageServiceExtensionHandler.getFieldDefinition(ExtensionResultHolder<FieldDefinition> erh,
Page page,
String fieldKey)
If this method returns something other than
NOT_HANDLED, the result variable
in the ExtensionResultHolder will hold the associated FieldDefinition for the given Page
and field key. |
ExtensionResultStatusType |
AbstractPageServiceExtensionHandler.overridePageDto(ExtensionResultHolder<PageDTO> erh,
PageDTO pageDto,
Page page) |
ExtensionResultStatusType |
PageServiceExtensionHandler.overridePageDto(ExtensionResultHolder<PageDTO> erh,
PageDTO pageDto,
Page page)
This method provides the opportunity to modify the page fields associated with the pageDto
ExtensionResultHolder. |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
StructuredContentServiceExtensionHandler.modifyStructuredContentDtoList(List<StructuredContentDTO> structuredContentList,
ExtensionResultHolder resultHolder)
Allows an extension handler to modify the list of structured content items.
|
ExtensionResultStatusType |
AbstractStructuredContentServiceExtensionHandler.modifyStructuredContentDtoList(List<StructuredContentDTO> structuredContentList,
ExtensionResultHolder resultHolder) |
ExtensionResultStatusType |
StructuredContentServiceExtensionHandler.populateAdditionalStructuredContentFields(StructuredContent sc,
StructuredContentDTO dto,
boolean secure)
Further modifies the fields when parsing a
StructuredContent into a StructuredContentDTO. |
ExtensionResultStatusType |
AbstractStructuredContentServiceExtensionHandler.populateAdditionalStructuredContentFields(StructuredContent sc,
StructuredContentDTO dto,
boolean secure) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
AbstractContentProcessorExtensionHandler.addAdditionalFieldsToModel(org.thymeleaf.Arguments arguments,
org.thymeleaf.dom.Element element) |
ExtensionResultStatusType |
ContentProcessorExtensionHandler.addAdditionalFieldsToModel(org.thymeleaf.Arguments arguments,
org.thymeleaf.dom.Element element)
This method will add any additional attributes to the model that the extension needs
|
ExtensionResultStatusType |
AbstractContentProcessorExtensionHandler.addExtensionFieldDeepLink(List<DeepLink> links,
org.thymeleaf.Arguments arguments,
org.thymeleaf.dom.Element element) |
ExtensionResultStatusType |
ContentProcessorExtensionHandler.addExtensionFieldDeepLink(List<DeepLink> links,
org.thymeleaf.Arguments arguments,
org.thymeleaf.dom.Element element)
Provides a hook point for an extension of content processor to optionally add in deep links
for a content item based on its extension fields
|
ExtensionResultStatusType |
AbstractContentProcessorExtensionHandler.postProcessDeepLinks(List<DeepLink> links) |
ExtensionResultStatusType |
ContentProcessorExtensionHandler.postProcessDeepLinks(List<DeepLink> links)
Provides a hook point to allow extension handlers to modify the generated deep links.
|
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
BreadcrumbServiceExtensionHandler.modifyBreadcrumbList(String url,
Map<String,String[]> queryParams,
ExtensionResultHolder<List<BreadcrumbDTO>> holder) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
AbstractSystemPropertyServiceExtensionHandler.resolveProperty(String propertyName,
ExtensionResultHolder resultHolder) |
ExtensionResultStatusType |
SystemPropertyServiceExtensionHandler.resolveProperty(String propertyName,
ExtensionResultHolder resultHolder)
Provides an opportunity for modules to resolve a system property.
|
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
MultiTenantCopierExtensionHandler.prepareForSave(MultiTenantCopyContext context,
Object from,
Object to) |
ExtensionResultStatusType |
AbstractMultiTenantCopierExtensionHandler.prepareForSave(MultiTenantCopyContext context,
Object from,
Object to) |
ExtensionResultStatusType |
MultiTenantCopierExtensionHandler.transformCopy(MultiTenantCopyContext context,
Object from,
Object to) |
ExtensionResultStatusType |
AbstractMultiTenantCopierExtensionHandler.transformCopy(MultiTenantCopyContext context,
Object from,
Object to) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
AbstractEntityInformationServiceExtensionHandler.getBaseProfileIdForSite(Site site,
ExtensionResultHolder<Long> erh) |
ExtensionResultStatusType |
EntityInformationServiceExtensionHandler.getBaseProfileIdForSite(Site site,
ExtensionResultHolder<Long> erh)
Handler implementations will populate the
ExtensionResultHolder with a valid
base profile id if one exists for the site |
ExtensionResultStatusType |
AbstractEntityInformationServiceExtensionHandler.getOkayToUseSiteDiscriminator(Object o,
ExtensionResultHolder<Boolean> erh) |
ExtensionResultStatusType |
EntityInformationServiceExtensionHandler.getOkayToUseSiteDiscriminator(Object o,
ExtensionResultHolder<Boolean> erh)
Handler implementations will set the value of
ExtensionResultHolder to true if the
passed in object supports site discriminator usage. |
ExtensionResultStatusType |
AbstractEntityInformationServiceExtensionHandler.updateEntityInformationDto(EntityInformationDto dto,
Object entityInstance) |
ExtensionResultStatusType |
EntityInformationServiceExtensionHandler.updateEntityInformationDto(EntityInformationDto dto,
Object entityInstance)
Handler implementations will override or populate the values on the passed in dto.
|
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
SparselyPopulatedQueryExtensionHandler.breakdown(Class<?> type,
ResultType resultType)
Perform any breakdown operations.
|
ExtensionResultStatusType |
QueryExtensionHandler.breakdown(Class<?> type,
String[] config)
Perform any breakdown operations.
|
ExtensionResultStatusType |
SparselyPopulatedQueryExtensionHandler.buildStatus(Class<?> type,
List queryResults,
ExtensionResultHolder<List<StandardCacheItem>> response)
Convert the list of query results into a list that denotes not only the query results, but also whether or not each member
represents a deleted/archived item, or an active/normal item.
|
ExtensionResultStatusType |
SparselyPopulatedQueryExtensionHandler.getCacheKey(Object testObject,
String qualifier,
ResultType resultType,
ExtensionResultHolder<String> response)
Build the cache key to be used for either the STANDARD or TEMPLATE style cache, driven by the resultType.
|
ExtensionResultStatusType |
SparselyPopulatedQueryExtensionHandler.getCacheKey(String qualifier,
ResultType resultType,
ExtensionResultHolder<String> response)
Build the cache key to be used for either the STANDARD or TEMPLATE style cache, driven by the resultType.
|
ExtensionResultStatusType |
SparselyPopulatedQueryExtensionHandler.getResultType(Object testObject,
ExtensionResultHolder<ResultType> response)
By examining the multitenant information related to a test object, return whether the object is related to a standard
site, or a template profile or catalog, if applicable.
|
ExtensionResultStatusType |
SparselyPopulatedQueryExtensionHandler.isValidState(ExtensionResultHolder<Boolean> response)
Determine if the current thread is in a valid state for sparse cache handling
|
ExtensionResultStatusType |
SparselyPopulatedQueryExtensionHandler.refineOrder(Class<?> type,
ResultType resultType,
javax.persistence.criteria.CriteriaBuilder builder,
javax.persistence.criteria.CriteriaQuery criteria,
javax.persistence.criteria.Root root,
List<javax.persistence.criteria.Order> sorts)
Add sorting to the fetch query
|
ExtensionResultStatusType |
QueryExtensionHandler.refineOrder(Class<?> type,
String[] config,
javax.persistence.criteria.CriteriaBuilder builder,
javax.persistence.criteria.CriteriaQuery criteria,
javax.persistence.criteria.Root root,
List<javax.persistence.criteria.Order> sorts)
Add sorting to the fetch query
|
ExtensionResultStatusType |
SparselyPopulatedQueryExtensionHandler.refineResults(Class<?> type,
ResultType resultType,
List queryResults,
ExtensionResultHolder<List> response)
Filter the results from the database in Java
|
ExtensionResultStatusType |
QueryExtensionHandler.refineResults(Class<?> type,
String[] config,
List queryResults,
ExtensionResultHolder<List> response)
Filter the results from the database in Java
|
ExtensionResultStatusType |
SparselyPopulatedQueryExtensionHandler.refineRetrieve(Class<?> type,
ResultType resultType,
javax.persistence.criteria.CriteriaBuilder builder,
javax.persistence.criteria.CriteriaQuery criteria,
javax.persistence.criteria.Root root,
List<javax.persistence.criteria.Predicate> restrictions)
Add additional restrictions to the fetch query
|
ExtensionResultStatusType |
QueryExtensionHandler.refineRetrieve(Class<?> type,
String[] config,
javax.persistence.criteria.CriteriaBuilder builder,
javax.persistence.criteria.CriteriaQuery criteria,
javax.persistence.criteria.Root root,
List<javax.persistence.criteria.Predicate> restrictions)
Add additional restrictions to the fetch query
|
ExtensionResultStatusType |
SparselyPopulatedQueryExtensionHandler.setup(Class<?> type,
ResultType resultType)
Perform any setup operations.
|
ExtensionResultStatusType |
QueryExtensionHandler.setup(Class<?> type,
String[] config)
Perform any setup operations.
|
static ExtensionResultStatusType |
ExtensionResultStatusType.valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static ExtensionResultStatusType[] |
ExtensionResultStatusType.values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
ExtensionManager.shouldContinue(ExtensionResultStatusType result,
ExtensionHandler handler,
Method method,
Object[] args)
Utility method that is useful for determining whether or not an ExtensionManager implementation
should continue after processing a ExtensionHandler call.
|
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
BroadleafStaticAssetExtensionHandler.modifyDuplicateAssetURL(StringBuilder urlBuilder)
Provide an extension point to modify the url for a StaticAsset in the case
where multiple assets have the same url.
|
ExtensionResultStatusType |
BroadleafFileServiceExtensionHandler.processPathForSite(String prefix,
String resourceName,
ExtensionResultHolder<String> holder) |
ExtensionResultStatusType |
BroadleafStaticAssetExtensionHandler.removeShareOptionsForMTStandardSite(org.springframework.ui.Model model,
Site currentSite) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
TranslationDaoExtensionHandler.overrideRequestedId(ExtensionResultHolder erh,
javax.persistence.EntityManager em,
Class<?> clazz,
Long entityId)
If there is a different id that should be used for a translation lookup instead of the given entityId,
the handler should place the result in the
ExtensionResultHolder argument. |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
SiteServiceExtensionHandler.contributeNonPersitentSiteProperties(Site from,
Site to)
Invoked via
SiteServiceImpl.getNonPersistentSite(Site) after the initial framework clone. |
ExtensionResultStatusType |
AbstractSiteServiceExtensionHandler.contributeNonPersitentSiteProperties(Site from,
Site to) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
AbstractTemplateOverrideExtensionHandler.getOverrideTemplate(ExtensionResultHolder<String> erh,
Object object) |
ExtensionResultStatusType |
TemplateOverrideExtensionHandler.getOverrideTemplate(ExtensionResultHolder<String> erh,
Object object) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
BroadleafMergeResourceExtensionHandler.resolveMessageSource(String code,
Locale locale,
ExtensionResultHolder<String> result) |
ExtensionResultStatusType |
AbstractBroadleafMergeResourceExtensionHandler.resolveMessageSource(String code,
Locale locale,
ExtensionResultHolder<String> result) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
BroadleafThymeleafViewResolverExtensionHandler.appendCacheKey(ExtensionResultHolder<String> erh,
String originalViewName,
boolean isAjaxRequest)
Allows an extension handler to alter the cache key for the view.
|
ExtensionResultStatusType |
AbstractBroadleafThymeleafResolverExtensionHandler.appendCacheKey(ExtensionResultHolder<String> erh,
String originalViewName,
boolean isAjaxRequest) |
ExtensionResultStatusType |
BroadleafThymeleafViewResolverExtensionHandler.overrideView(ExtensionResultHolder<String> erh,
String originalViewName,
boolean isAjaxRequest)
Allows an extension handler to override the view name.
|
ExtensionResultStatusType |
AbstractBroadleafThymeleafResolverExtensionHandler.overrideView(ExtensionResultHolder<String> erh,
String originalViewName,
boolean isAjaxRequest) |
ExtensionResultStatusType |
BroadleafThymeleafViewResolverExtensionHandler.provideTemplateWrapper(ExtensionResultHolder<String> erh,
String originalViewName,
boolean isAjaxRequest)
Allows an extension handler to provide a wrapper for the template.
|
ExtensionResultStatusType |
AbstractBroadleafThymeleafResolverExtensionHandler.provideTemplateWrapper(ExtensionResultHolder<String> erh,
String originalViewName,
boolean isAjaxRequest) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
PaymentGatewayFieldExtensionHandler.mapFieldName(String fieldNameKey,
Map<String,String> fieldNameMap) |
ExtensionResultStatusType |
AbstractPaymentGatewayFieldExtensionHandler.mapFieldName(String fieldNameKey,
Map<String,String> fieldNameMap) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
TRCreditCardExtensionHandler.createTransparentRedirectForm(Map<String,Map<String,String>> formParameters,
PaymentRequestDTO requestDTO,
Map<String,String> configurationSettings)
The implementing modules should take into consideration the passed in configuration settings map
and call their implementing TransparentRedirectService to generate either an Authorize
or Authorize and Capture Form.
|
ExtensionResultStatusType |
AbstractTRCreditCardExtensionHandler.createTransparentRedirectForm(Map<String,Map<String,String>> formParameters,
PaymentRequestDTO requestDTO,
Map<String,String> configurationSettings) |
ExtensionResultStatusType |
AbstractCreditCardTypesExtensionHandler.populateCreditCardMap(Map<String,String> creditCardTypes) |
ExtensionResultStatusType |
CreditCardTypesExtensionHandler.populateCreditCardMap(Map<String,String> creditCardTypes)
The registered Extension Handler will populate any specific Payment Gateway
codes required for Credit Card Types.
|
ExtensionResultStatusType |
TRCreditCardExtensionHandler.setFormActionKey(StringBuilder key) |
ExtensionResultStatusType |
AbstractTRCreditCardExtensionHandler.setFormActionKey(StringBuilder key) |
ExtensionResultStatusType |
TRCreditCardExtensionHandler.setFormHiddenParamsKey(StringBuilder key) |
ExtensionResultStatusType |
AbstractTRCreditCardExtensionHandler.setFormHiddenParamsKey(StringBuilder key) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
ResourceRequestExtensionHandler.getModifiedResource(String path,
ExtensionResultHolder erh)
Populates the RESOURCE_ATTR field in the ExtensionResultHolder map with an instance of
Resource if the value of the modified resource. |
ExtensionResultStatusType |
AbstractResourceRequestExtensionHandler.getModifiedResource(String path,
ExtensionResultHolder erh) |
ExtensionResultStatusType |
ResourceRequestExtensionHandler.getOverrideResource(String path,
ExtensionResultHolder erh)
Populates the RESOURCE_ATTR field in the ExtensionResultHolder map with an instance of
Resource if there is an override resource available for the current path. |
ExtensionResultStatusType |
AbstractResourceRequestExtensionHandler.getOverrideResource(String path,
ExtensionResultHolder erh) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
BroadleafCommonAddressValidatorExtensionHandler.validate(BroadleafFormType formType,
Address address,
org.springframework.validation.Errors errors) |
ExtensionResultStatusType |
AbstractCommonAddressValidatorExtensionHandler.validate(BroadleafFormType formType,
Address address,
org.springframework.validation.Errors errors) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
CategoryDaoExtensionHandler.findCategoryByURI(String uri,
ExtensionResultHolder resultHolder) |
ExtensionResultStatusType |
ProductDaoExtensionHandler.findProductByURI(String uri,
ExtensionResultHolder resultHolder) |
ExtensionResultStatusType |
SkuDaoExtensionHandler.findSkuByURI(String uri,
ExtensionResultHolder resultHolder) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
CatalogServiceExtensionHandler.findCategoryByURI(String uri,
ExtensionResultHolder resultHolder) |
ExtensionResultStatusType |
CatalogServiceExtensionHandler.findProductByURI(String uri,
ExtensionResultHolder resultHolder) |
ExtensionResultStatusType |
CatalogServiceExtensionHandler.findSkuByURI(String uri,
ExtensionResultHolder resultHolder) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
AbstractInventoryServiceExtensionHandler.decrementInventory(Map<Sku,Integer> skuQuantities,
Map<String,Object> context) |
ExtensionResultStatusType |
InventoryServiceExtensionHandler.decrementInventory(Map<Sku,Integer> skuQuantities,
Map<String,Object> context)
Usually invoked within the
DecrementInventoryActivity to decrement inventory for the Skus that are in
skuQuantities |
ExtensionResultStatusType |
AbstractInventoryServiceExtensionHandler.incrementInventory(Map<Sku,Integer> skuQuantities,
Map<String,Object> context) |
ExtensionResultStatusType |
InventoryServiceExtensionHandler.incrementInventory(Map<Sku,Integer> skuQuantities,
Map<String,Object> context) |
ExtensionResultStatusType |
AbstractInventoryServiceExtensionHandler.retrieveQuantitiesAvailable(Collection<Sku> skus,
Map<String,Object> context,
ExtensionResultHolder<Map<Sku,Integer>> result) |
ExtensionResultStatusType |
InventoryServiceExtensionHandler.retrieveQuantitiesAvailable(Collection<Sku> skus,
Map<String,Object> context,
ExtensionResultHolder<Map<Sku,Integer>> result)
Usually invoked within the
CheckAvailabilityActivity to retrieve the quantity that is available for the given
skus. |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
OfferCodeDaoExtensionHandler.createReadOfferCodeByCodeQuery(javax.persistence.EntityManager em,
ExtensionResultHolder<javax.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.
|
ExtensionResultStatusType |
DefaultOfferCodeDaoExtensionHandler.createReadOfferCodeByCodeQuery(javax.persistence.EntityManager em,
ExtensionResultHolder<javax.persistence.Query> resultHolder,
String code,
boolean cacheable,
String cacheRegion) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
AbstractOfferServiceExtensionHandler.applyAdditionalFilters(List<Offer> offers) |
ExtensionResultStatusType |
OfferServiceExtensionHandler.applyAdditionalFilters(List<Offer> offers) |
ExtensionResultStatusType |
AbstractOfferServiceExtensionHandler.applyItemOffer(PromotableOrder order,
PromotableCandidateItemOffer itemOffer,
Map<String,Object> contextMap) |
ExtensionResultStatusType |
OfferServiceExtensionHandler.applyItemOffer(PromotableOrder order,
PromotableCandidateItemOffer itemOffer,
Map<String,Object> contextMap)
Modules may need to extend the applyItemOffer logic
For example, a subscription module might creates future payment adjustments.
|
ExtensionResultStatusType |
AbstractOfferServiceExtensionHandler.buildOfferCodeListForCustomer(Customer customer,
List<OfferCode> offerCodes) |
ExtensionResultStatusType |
OfferServiceExtensionHandler.buildOfferCodeListForCustomer(Customer customer,
List<OfferCode> offerCodes)
Allows module extension to add additional offer codes to the list, given the customer
|
ExtensionResultStatusType |
AbstractOfferServiceExtensionHandler.calculatePotentialSavings(PromotableCandidateItemOffer itemOffer,
PromotableOrderItem item,
int quantity,
Map<String,Object> contextMap) |
ExtensionResultStatusType |
OfferServiceExtensionHandler.calculatePotentialSavings(PromotableCandidateItemOffer itemOffer,
PromotableOrderItem item,
int quantity,
Map<String,Object> contextMap)
Modules may extend the calculatePotentialSavings method.
|
ExtensionResultStatusType |
AbstractOfferServiceExtensionHandler.chooseSaleOrRetailAdjustments(PromotableOrder order) |
ExtensionResultStatusType |
OfferServiceExtensionHandler.chooseSaleOrRetailAdjustments(PromotableOrder order)
Allows a module to finalize adjustments.
|
ExtensionResultStatusType |
AbstractOfferServiceExtensionHandler.createOrderItemPriceDetailAdjustment(ExtensionResultHolder<?> resultHolder,
OrderItemPriceDetail itemDetail) |
ExtensionResultStatusType |
OfferServiceExtensionHandler.createOrderItemPriceDetailAdjustment(ExtensionResultHolder<?> resultHolder,
OrderItemPriceDetail itemDetail)
Allows module extensions to add a create a new instance of OrderItemPriceDetailAdjustment.
|
ExtensionResultStatusType |
AbstractOfferServiceExtensionHandler.resetPriceDetails(PromotableOrderItem item) |
ExtensionResultStatusType |
OfferServiceExtensionHandler.resetPriceDetails(PromotableOrderItem item)
Modules may need to clear additional offer details when resetPriceDetails is called.
|
ExtensionResultStatusType |
AbstractOfferServiceExtensionHandler.synchronizeAdjustmentsAndPrices(PromotableOrder order) |
ExtensionResultStatusType |
OfferServiceExtensionHandler.synchronizeAdjustmentsAndPrices(PromotableOrder order)
Allows a module to amend the data that synchronizes the
PromotableOrder with the Order |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
AbstractOrderDaoExtensionHandler.applyAdditionalOrderLookupFilter(Customer customer,
String name,
List<Order> orders) |
ExtensionResultStatusType |
OrderDaoExtensionHandler.applyAdditionalOrderLookupFilter(Customer customer,
String name,
List<Order> orders) |
ExtensionResultStatusType |
AbstractOrderDaoExtensionHandler.attachAdditionalDataToNewCart(Customer customer,
Order cart) |
ExtensionResultStatusType |
OrderDaoExtensionHandler.attachAdditionalDataToNewCart(Customer customer,
Order cart) |
ExtensionResultStatusType |
AbstractOrderDaoExtensionHandler.processPostSaveNewCart(Customer customer,
Order cart) |
ExtensionResultStatusType |
OrderDaoExtensionHandler.processPostSaveNewCart(Customer customer,
Order cart) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
I18nSolrSearchServiceExtensionHandler.addPropertyValues(Product product,
Field field,
FieldType fieldType,
Map<String,Object> values,
String propertyName,
List<Locale> locales) |
ExtensionResultStatusType |
AbstractSolrSearchServiceExtensionHandler.addPropertyValues(Product product,
Field field,
FieldType fieldType,
Map<String,Object> values,
String propertyName,
List<Locale> locales) |
ExtensionResultStatusType |
SolrSearchServiceExtensionHandler.addPropertyValues(Product product,
Field field,
FieldType fieldType,
Map<String,Object> values,
String propertyName,
List<Locale> locales)
Given the input field, populates the values array with the fields needed for the
passed in field.
|
protected ExtensionResultStatusType |
I18nSolrSearchServiceExtensionHandler.addPropertyValues(Product product,
Sku sku,
boolean useSku,
Field field,
FieldType fieldType,
Map<String,Object> values,
String propertyName,
List<Locale> locales) |
ExtensionResultStatusType |
I18nSolrSearchServiceExtensionHandler.addPropertyValues(Sku sku,
Field field,
FieldType fieldType,
Map<String,Object> values,
String propertyName,
List<Locale> locales) |
ExtensionResultStatusType |
AbstractSolrSearchServiceExtensionHandler.addPropertyValues(Sku sku,
Field field,
FieldType fieldType,
Map<String,Object> values,
String propertyName,
List<Locale> locales) |
ExtensionResultStatusType |
SolrSearchServiceExtensionHandler.addPropertyValues(Sku sku,
Field field,
FieldType fieldType,
Map<String,Object> values,
String propertyName,
List<Locale> locales)
Given the input field, populates the values array with the fields needed for the
passed in field.
|
ExtensionResultStatusType |
AbstractSolrSearchServiceExtensionHandler.attachAdditionalBasicFields(Product product,
org.apache.solr.common.SolrInputDocument document,
SolrHelperService shs) |
ExtensionResultStatusType |
SolrSearchServiceExtensionHandler.attachAdditionalBasicFields(Product product,
org.apache.solr.common.SolrInputDocument document,
SolrHelperService shs)
Allows the extension additional fields to the document that are not configured via the DB.
|
ExtensionResultStatusType |
AbstractSolrSearchServiceExtensionHandler.attachAdditionalBasicFields(Sku sku,
org.apache.solr.common.SolrInputDocument document,
SolrHelperService shs) |
ExtensionResultStatusType |
SolrSearchServiceExtensionHandler.attachAdditionalBasicFields(Sku sku,
org.apache.solr.common.SolrInputDocument document,
SolrHelperService shs)
Allows the extension additional fields to the document that are not configured via the DB.
|
ExtensionResultStatusType |
I18nSolrSearchServiceExtensionHandler.buildPrefixListForSearchableFacet(Field field,
List<String> prefixList) |
ExtensionResultStatusType |
AbstractSolrSearchServiceExtensionHandler.buildPrefixListForSearchableFacet(Field field,
List<String> prefixList) |
ExtensionResultStatusType |
SolrSearchServiceExtensionHandler.buildPrefixListForSearchableFacet(Field field,
List<String> prefixList)
Returns a prefix if required for the passed in facet.
|
ExtensionResultStatusType |
I18nSolrSearchServiceExtensionHandler.buildPrefixListForSearchableField(Field field,
FieldType searchableFieldType,
List<String> prefixList) |
ExtensionResultStatusType |
AbstractSolrSearchServiceExtensionHandler.buildPrefixListForSearchableField(Field field,
FieldType searchableFieldType,
List<String> prefixList) |
ExtensionResultStatusType |
SolrSearchServiceExtensionHandler.buildPrefixListForSearchableField(Field field,
FieldType searchableFieldType,
List<String> prefixList)
Returns a prefix if required for the passed in searchable field.
|
ExtensionResultStatusType |
AbstractSolrSearchServiceExtensionHandler.endBatchEvent() |
ExtensionResultStatusType |
SolrSearchServiceExtensionHandler.endBatchEvent()
Perform actions to end a batch event, such as closing any Contexts that have been previously created.
|
ExtensionResultStatusType |
AbstractSolrSearchServiceExtensionHandler.filterSearchFacetRanges(SearchFacetDTO dto,
List<SearchFacetRange> ranges) |
ExtensionResultStatusType |
SolrSearchServiceExtensionHandler.filterSearchFacetRanges(SearchFacetDTO dto,
List<SearchFacetRange> ranges)
Builds the search facet ranges for the provided dto.
|
ExtensionResultStatusType |
AbstractSolrSearchServiceExtensionHandler.getCategoryId(Category category,
Long[] returnContainer) |
ExtensionResultStatusType |
SolrSearchServiceExtensionHandler.getCategoryId(Category category,
Long[] returnContainer)
In certain scenarios, the requested category id might not be the one that should be used in Solr.
|
ExtensionResultStatusType |
AbstractSolrSearchServiceExtensionHandler.getCategoryId(Long category,
Long[] returnContainer) |
ExtensionResultStatusType |
SolrSearchServiceExtensionHandler.getCategoryId(Long category,
Long[] returnContainer)
In certain scenarios, the requested category id might not be the one that should be used in Solr.
|
protected ExtensionResultStatusType |
I18nSolrSearchServiceExtensionHandler.getLocalePrefix(Field field,
List<String> prefixList)
If the field is translatable, take the current locale and add that as a prefix.
|
ExtensionResultStatusType |
AbstractSolrSearchServiceExtensionHandler.getProductId(Product product,
Long[] returnContainer) |
ExtensionResultStatusType |
SolrSearchServiceExtensionHandler.getProductId(Product product,
Long[] returnContainer)
In certain scenarios, the requested product id might not be the one that should be used in Solr.
|
ExtensionResultStatusType |
AbstractSolrSearchServiceExtensionHandler.getSkuId(Sku sku,
Long[] returnContainer) |
ExtensionResultStatusType |
SolrSearchServiceExtensionHandler.getSkuId(Sku sku,
Long[] returnContainer)
In certain scenarios, the requested sku id might not be the one that should be used in Solr.
|
ExtensionResultStatusType |
AbstractSolrSearchServiceExtensionHandler.getSolrDocumentId(org.apache.solr.common.SolrInputDocument document,
Product product,
String[] returnContainer) |
ExtensionResultStatusType |
SolrSearchServiceExtensionHandler.getSolrDocumentId(org.apache.solr.common.SolrInputDocument document,
Product product,
String[] returnContainer)
In certain scenarios, we may want to produce a different Solr document id than the default.
|
ExtensionResultStatusType |
AbstractSolrSearchServiceExtensionHandler.getSolrDocumentId(org.apache.solr.common.SolrInputDocument document,
Sku product,
String[] returnContainer) |
ExtensionResultStatusType |
SolrSearchServiceExtensionHandler.getSolrDocumentId(org.apache.solr.common.SolrInputDocument document,
Sku sku,
String[] returnContainer)
In certain scenarios, we may want to produce a different Solr document id than the default.
|
ExtensionResultStatusType |
AbstractSolrSearchServiceExtensionHandler.modifyBuiltDocuments(Collection<org.apache.solr.common.SolrInputDocument> documents,
List<Product> products,
List<Field> fields,
List<Locale> locales) |
ExtensionResultStatusType |
SolrSearchServiceExtensionHandler.modifyBuiltDocuments(Collection<org.apache.solr.common.SolrInputDocument> documents,
List<Product> products,
List<Field> fields,
List<Locale> locales) |
ExtensionResultStatusType |
AbstractSolrSearchServiceExtensionHandler.modifySolrQuery(org.apache.solr.client.solrj.SolrQuery query,
String qualifiedSolrQuery,
List<SearchFacetDTO> facets,
SearchCriteria searchCriteria,
String defaultSort) |
ExtensionResultStatusType |
SolrSearchServiceExtensionHandler.modifySolrQuery(org.apache.solr.client.solrj.SolrQuery query,
String qualifiedSolrQuery,
List<SearchFacetDTO> facets,
SearchCriteria searchCriteria,
String defaultSort)
Provides an extension point to modify the SolrQuery.
|
ExtensionResultStatusType |
AbstractSolrSearchServiceExtensionHandler.startBatchEvent(List<Product> products) |
ExtensionResultStatusType |
SolrSearchServiceExtensionHandler.startBatchEvent(List<Product> products)
Perform actions at the start of a batch to improve performance of Solr search for the list of batch products.
|
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
BroadleafCheckoutControllerExtensionHandler.addAdditionalModelVariables(org.springframework.ui.Model model)
Allow other modules to add properties to the checkout controller model
|
ExtensionResultStatusType |
AbstractCheckoutControllerExtensionHandler.addAdditionalModelVariables(org.springframework.ui.Model model) |
ExtensionResultStatusType |
BroadleafCheckoutControllerExtensionHandler.performAdditionalShippingAction()
Allow other modules to execute additional logic in shipping methods
|
ExtensionResultStatusType |
AbstractCheckoutControllerExtensionHandler.performAdditionalShippingAction() |
ExtensionResultStatusType |
AbstractConfirmationControllerExtensionHandler.processAdditionalConfirmationActions(Order order) |
ExtensionResultStatusType |
ConfirmationControllerExtensionHandler.processAdditionalConfirmationActions(Order order) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
CartStateRequestProcessorExtensionHandler.lookupOrCreateCart(org.springframework.web.context.request.WebRequest request,
Customer customer,
ExtensionResultHolder<Order> resultHolder)
Throws an exception if cart is invalid.
|
ExtensionResultStatusType |
AbstractCartStateRequestProcessorExtensionHandler.lookupOrCreateCart(org.springframework.web.context.request.WebRequest request,
Customer customer,
ExtensionResultHolder<Order> resultHolder)
Allows an extension to return a cart skipping the out of box processing that
normally performs this function.
|
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
AuthSuccessHandlerExtensionHandler.preMergeCartExecution(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
org.springframework.security.core.Authentication authentication)
Perform any necessary tasks before the merge cart processor executes.
|
ExtensionResultStatusType |
AbstractAuthSuccessHandlerExtensionHandler.preMergeCartExecution(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
org.springframework.security.core.Authentication authentication) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
CategoriesProcessorExtensionHandler.findAllPossibleChildCategories(String parentCategory,
String maxResults,
ExtensionResultHolder<List<Category>> resultHolder) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
UncacheableDataProcessorExtensionHandler.modifyProductListForInventoryCheck(org.thymeleaf.Arguments arguments,
Set<Product> products,
Set<Sku> skus) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
AbstractDatabaseResourceResolverExtensionHandler.resolveResource(ExtensionResultHolder erh,
org.thymeleaf.TemplateProcessingParameters params,
String resourceName) |
ExtensionResultStatusType |
DatabaseResourceResolverExtensionHandler.resolveResource(ExtensionResultHolder erh,
org.thymeleaf.TemplateProcessingParameters params,
String resourceName)
If this method returns any of the handled conditions in
ExtensionResultStatusType,
the value keyed by DatabaseResourceResolverExtensionHandler.IS_KEY in the
ExtensionResultHolder's context map will be an InputStream of the resolved resource's
contents. |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
AbstractUpdateCartServiceExtensionHandler.updateAndValidateCart(Order cart,
ExtensionResultHolder resultHolder)
Throws an exception if cart is invalid.
|
ExtensionResultStatusType |
i18nUpdateCartServiceExtensionHandler.updateAndValidateCart(Order cart,
ExtensionResultHolder resultHolder)
If the locale of the cart does not match the current locale, then this extension handler will
attempt to translate the order items.
|
ExtensionResultStatusType |
UpdateCartServiceExtensionHandler.updateAndValidateCart(Order cart,
ExtensionResultHolder resultHolder)
Throws an exception if cart is invalid.
|
ExtensionResultStatusType |
CacheKeyResolverExtensionHandler.updateCacheKey(StringBuilder stringBuilder,
boolean hasProducts)
The passed in StringBuilder represents the current state of the cache key prior
to running any extension handlers.
|
ExtensionResultStatusType |
AbstractCacheKeyResolverExtensionHandler.updateCacheKey(StringBuilder stringBuilder,
boolean hasProducts) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
AdminExternalLoginExtensionHandler.performAdditionalAuthenticationTasks(AdminUser adminUser,
BroadleafExternalAuthenticationUserDetails details)
This can be used to associate, for example, Site to the adminUser, or to validate that the Site that the adminUser
has access to is the current site.
|
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
ArchiveStatusPersistenceEventHandlerExtensionHandler.isArchivable(Class<?> entity,
AtomicBoolean isArchivable) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
AbstractBasicPersistenceModuleExtensionHandler.rebalanceForAdd(BasicPersistenceModule basicPersistenceModule,
PersistencePackage persistencePackage,
Serializable instance,
Map<String,FieldMetadata> mergedProperties,
ExtensionResultHolder<Serializable> resultHolder) |
ExtensionResultStatusType |
DefaultBasicPersistenceModuleExtensionHandler.rebalanceForAdd(BasicPersistenceModule basicPersistenceModule,
PersistencePackage persistencePackage,
Serializable instance,
Map<String,FieldMetadata> mergedProperties,
ExtensionResultHolder<Serializable> resultHolder) |
ExtensionResultStatusType |
BasicPersistenceModuleExtensionHandler.rebalanceForAdd(BasicPersistenceModule basicPersistenceModule,
PersistencePackage persistencePackage,
Serializable instance,
Map<String,FieldMetadata> mergedProperties,
ExtensionResultHolder<Serializable> resultHolder)
Handle additions of new members to a basic collection when the items are sortable
|
ExtensionResultStatusType |
AbstractBasicPersistenceModuleExtensionHandler.rebalanceForUpdate(BasicPersistenceModule basicPersistenceModule,
PersistencePackage persistencePackage,
Serializable instance,
Map<String,FieldMetadata> mergedProperties,
Object primaryKey,
ExtensionResultHolder<Serializable> resultHolder) |
ExtensionResultStatusType |
DefaultBasicPersistenceModuleExtensionHandler.rebalanceForUpdate(BasicPersistenceModule basicPersistenceModule,
PersistencePackage persistencePackage,
Serializable instance,
Map<String,FieldMetadata> mergedProperties,
Object primaryKey,
ExtensionResultHolder<Serializable> resultHolder) |
ExtensionResultStatusType |
BasicPersistenceModuleExtensionHandler.rebalanceForUpdate(BasicPersistenceModule basicPersistenceModule,
PersistencePackage persistencePackage,
Serializable instance,
Map<String,FieldMetadata> mergedProperties,
Object primaryKey,
ExtensionResultHolder<Serializable> resultHolder)
Handle reorder change requests from the admin for sortable basic collections
|
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
AdminAbstractControllerExtensionHandler.addAdditionalMainActions(String sectionClassName,
List<EntityFormAction> actions)
Invoked every time
AdminBasicEntityController#viewEntityList() is invoked to allow additional
main form actions to be contributed. |
ExtensionResultStatusType |
AbstractAdminAbstractControllerExtensionHandler.addAdditionalMainActions(String sectionClassName,
List<EntityFormAction> actions) |
ExtensionResultStatusType |
AdminAbstractListGridExtensionHandler.addAdditionalRowAction(ListGrid listGrid)
This can be used to add
ListGridActions to the ListGrid |
ExtensionResultStatusType |
AbstractAdminTranslationControllerExtensionHandler.applyTransformation(TranslationForm form) |
ExtensionResultStatusType |
AdminTranslationControllerExtensionHandler.applyTransformation(TranslationForm form)
Applies any necessary transformations to the given form.
|
ExtensionResultStatusType |
AdminAbstractControllerExtensionHandler.modifyDynamicForm(EntityForm form,
String parentEntityId)
Invoked whenever
AdminAbstractController.getBlankDynamicFieldTemplateForm(org.broadleafcommerce.openadmin.web.form.entity.DynamicEntityFormInfo) or
AdminAbstractController.getDynamicFieldTemplateForm(org.broadleafcommerce.openadmin.web.form.entity.DynamicEntityFormInfo, java.lang.String, org.broadleafcommerce.openadmin.web.form.entity.EntityForm) is invoked. |
ExtensionResultStatusType |
AbstractAdminAbstractControllerExtensionHandler.modifyDynamicForm(EntityForm form,
String parentEntityId) |
ExtensionResultStatusType |
AdminAbstractControllerExtensionHandler.modifyMainActions(ClassMetadata cmd,
List<EntityFormAction> mainActions)
Extension point to override the actions that are added by default when viewing a ceiling entity for a particular
section (for instance, a list of Products in the 'Product' section).
|
ExtensionResultStatusType |
AbstractAdminAbstractControllerExtensionHandler.modifyMainActions(ClassMetadata cmd,
List<EntityFormAction> mainActions) |
ExtensionResultStatusType |
AdminAbstractControllerExtensionHandler.overrideClassNameForSection(ExtensionResultHolder erh,
String sectionKey,
AdminSection section)
Invoked whenever
AdminAbstractController.getClassNameForSection(String) is invoked. |
ExtensionResultStatusType |
AbstractAdminAbstractControllerExtensionHandler.overrideClassNameForSection(ExtensionResultHolder erh,
String sectionKey,
AdminSection section) |
ExtensionResultStatusType |
AdminAbstractControllerExtensionHandler.setAdditionalModelAttributes(org.springframework.ui.Model model,
String sectionKey)
Invoked every time
AdminAbstractController.setModelAttributes(Model, String) is invoked. |
ExtensionResultStatusType |
AbstractAdminAbstractControllerExtensionHandler.setAdditionalModelAttributes(org.springframework.ui.Model model,
String sectionKey) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
AdminRequestProcessorExtensionHandler.retrieveCatalogs(Site currentSite,
ExtensionResultHolder<Set<Catalog>> result) |
ExtensionResultStatusType |
AdminRequestProcessorExtensionHandler.retrieveProfiles(Site currentSite,
ExtensionResultHolder<Set<Site>> result) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
AbstractRuleBuilderFieldServiceExtensionHandler.addFields(List<FieldData> fields,
String name) |
ExtensionResultStatusType |
RuleBuilderFieldServiceExtensionHandler.addFields(List<FieldData> fields,
String name) |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
AbstractFormBuilderExtensionHandler.addAdditionalFormActions(EntityForm entityForm) |
ExtensionResultStatusType |
FormBuilderExtensionHandler.addAdditionalFormActions(EntityForm entityForm)
Provides a hook to add additional actions to all entity forms.
|
ExtensionResultStatusType |
ListGridErrorMessageExtensionHandler.determineErrorMessageForEntity(Entity entity,
ListGridRecord lgr)
Allows the extension handler to determine a custom error message or error message key for the entity.
|
ExtensionResultStatusType |
AbstractFormBuilderExtensionHandler.modifyDetailEntityForm(EntityForm ef) |
ExtensionResultStatusType |
FormBuilderExtensionHandler.modifyDetailEntityForm(EntityForm ef)
Invoked whenever a detailed
EntityForm is built, after the initial list grids have been created on
the given EntityForm. |
ExtensionResultStatusType |
AbstractFormBuilderExtensionHandler.modifyListGridRecord(String className,
ListGridRecord record,
Entity entity) |
ExtensionResultStatusType |
FormBuilderExtensionHandler.modifyListGridRecord(String className,
ListGridRecord record,
Entity entity)
Provides a hook to modify the ListGridRecord for the given Entity while building the list grid record.
|
ExtensionResultStatusType |
AbstractFormBuilderExtensionHandler.modifyPopulatedEntityForm(EntityForm ef,
Entity entity) |
ExtensionResultStatusType |
FormBuilderExtensionHandler.modifyPopulatedEntityForm(EntityForm ef,
Entity entity)
Modifies an
EntityForm after it has been populated with an Entity. |
ExtensionResultStatusType |
AbstractFormBuilderExtensionHandler.modifyUnpopulatedEntityForm(EntityForm ef) |
ExtensionResultStatusType |
FormBuilderExtensionHandler.modifyUnpopulatedEntityForm(EntityForm ef)
Modifies an
EntityForm before it is populated with an Entity. |
| Modifier and Type | Method and Description |
|---|---|
ExtensionResultStatusType |
DefaultCustomerMergeExtensionHandler.merge(ExtensionResultHolder<Customer> customerHolder,
org.springframework.web.context.request.WebRequest request,
Customer anonymousCustomer) |
ExtensionResultStatusType |
CustomerMergeExtensionHandler.merge(ExtensionResultHolder<Customer> customerHolder,
org.springframework.web.context.request.WebRequest request,
Customer anonymousCustomer)
This allows multiple extensions to modify or copy attributes from the anonymous customer, to the
customer.
|
Copyright © 2015. All rights reserved.