Interface ContentProcessorExtensionHandler

All Superinterfaces:
org.broadleafcommerce.common.extension.ExtensionHandler
All Known Implementing Classes:
AbstractContentProcessorExtensionHandler

public interface ContentProcessorExtensionHandler extends org.broadleafcommerce.common.extension.ExtensionHandler
Extension handler for the ContentProcessor
Author:
Elbert Bautista (elbertbautista)
  • Method Summary

    Modifier and Type
    Method
    Description
    org.broadleafcommerce.common.extension.ExtensionResultStatusType
    addAdditionalFieldsToModel(String tagName, Map<String,String> tagAttributes, Map<String,Object> newModelVars, org.broadleafcommerce.presentation.model.BroadleafTemplateContext context)
    This method will add any additional attributes to the model that the extension needs
    org.broadleafcommerce.common.extension.ExtensionResultStatusType
    addExtensionFieldDeepLink(List<org.broadleafcommerce.common.web.deeplink.DeepLink> links, String tagName, Map<String,String> tagAttributes, org.broadleafcommerce.presentation.model.BroadleafTemplateContext context)
    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
    org.broadleafcommerce.common.extension.ExtensionResultStatusType
    postProcessDeepLinks(List<org.broadleafcommerce.common.web.deeplink.DeepLink> links)
    Provides a hook point to allow extension handlers to modify the generated deep links.

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

    getPriority, isEnabled
  • Method Details

    • addAdditionalFieldsToModel

      org.broadleafcommerce.common.extension.ExtensionResultStatusType addAdditionalFieldsToModel(String tagName, Map<String,String> tagAttributes, Map<String,Object> newModelVars, org.broadleafcommerce.presentation.model.BroadleafTemplateContext context)
      This method will add any additional attributes to the model that the extension needs
      Returns:
      - ExtensionResultStatusType
    • addExtensionFieldDeepLink

      org.broadleafcommerce.common.extension.ExtensionResultStatusType addExtensionFieldDeepLink(List<org.broadleafcommerce.common.web.deeplink.DeepLink> links, String tagName, Map<String,String> tagAttributes, org.broadleafcommerce.presentation.model.BroadleafTemplateContext context)
      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
      Parameters:
      links -
      tagName -
      tagAttributes -
      context -
      Returns:
      ExtensionResultStatusType
    • postProcessDeepLinks

      org.broadleafcommerce.common.extension.ExtensionResultStatusType postProcessDeepLinks(List<org.broadleafcommerce.common.web.deeplink.DeepLink> links)
      Provides a hook point to allow extension handlers to modify the generated deep links.
      Parameters:
      links -
      Returns:
      ExtensionResultStatusType