org.broadleafcommerce.cms.web.processor

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

Methods

Modifier and Type	Method and Description
org.broadleafcommerce.common.extension.ExtensionResultStatusType	addAdditionalFieldsToModel(org.thymeleaf.Arguments arguments, org.thymeleaf.dom.Element element) 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, 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
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 Detail

addAdditionalFieldsToModel

org.broadleafcommerce.common.extension.ExtensionResultStatusType addAdditionalFieldsToModel(org.thymeleaf.Arguments arguments,
                                                                                          org.thymeleaf.dom.Element element)

This method will add any additional attributes to the model that the extension needs

Parameters:

arguments - - the Thymeleaf Processor arguments

element - - the Thymeleaf Processor element

Returns:

- ExtensionResultStatusType

addExtensionFieldDeepLink

org.broadleafcommerce.common.extension.ExtensionResultStatusType addExtensionFieldDeepLink(List<org.broadleafcommerce.common.web.deeplink.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

Parameters:

links -

arguments -

element -

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