Package org.broadleafcommerce.cms.web.processor

Class AbstractContentProcessorExtensionHandler

java.lang.Object
org.broadleafcommerce.common.extension.AbstractExtensionHandler
org.broadleafcommerce.cms.web.processor.AbstractContentProcessorExtensionHandler
All Implemented Interfaces:
ContentProcessorExtensionHandler, org.broadleafcommerce.common.extension.ExtensionHandler
public abstract class AbstractContentProcessorExtensionHandler extends org.broadleafcommerce.common.extension.AbstractExtensionHandler implements ContentProcessorExtensionHandler
Abstract implementation of ContentProcessorExtensionHandler
Author:
Andre Azzolini (apazzolini)

  • Field Summary

    Fields inherited from class org.broadleafcommerce.common.extension.AbstractExtensionHandler

    enabled, priority

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractContentProcessorExtensionHandler()
     

  • 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 class org.broadleafcommerce.common.extension.AbstractExtensionHandler

    getPriority, isEnabled, setEnabled, setPriority

    Methods inherited from class java.lang.Object

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

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

    getPriority, isEnabled

  • Constructor Details

    • AbstractContentProcessorExtensionHandler

      public AbstractContentProcessorExtensionHandler()

  • Method Details

    • addAdditionalFieldsToModel

      public org.broadleafcommerce.common.extension.ExtensionResultStatusType addAdditionalFieldsToModel(String tagName, Map<String,String> tagAttributes, Map<String,Object> newModelVars, org.broadleafcommerce.presentation.model.BroadleafTemplateContext context)
      Description copied from interface: ContentProcessorExtensionHandler
      This method will add any additional attributes to the model that the extension needs
      Specified by:
      addAdditionalFieldsToModel in interface ContentProcessorExtensionHandler
      Returns:
      - ExtensionResultStatusType

    • addExtensionFieldDeepLink

      public 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)
      Description copied from interface: ContentProcessorExtensionHandler
      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
      Specified by:
      addExtensionFieldDeepLink in interface ContentProcessorExtensionHandler
      Returns:
      ExtensionResultStatusType

    • postProcessDeepLinks

      public org.broadleafcommerce.common.extension.ExtensionResultStatusType postProcessDeepLinks(List<org.broadleafcommerce.common.web.deeplink.DeepLink> links)
      Description copied from interface: ContentProcessorExtensionHandler
      Provides a hook point to allow extension handlers to modify the generated deep links.
      Specified by:
      postProcessDeepLinks in interface ContentProcessorExtensionHandler
      Returns:
      ExtensionResultStatusType