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 and Description
AbstractContentProcessorExtensionHandler()

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 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 Detail

AbstractContentProcessorExtensionHandler

public AbstractContentProcessorExtensionHandler()

Method Detail

addAdditionalFieldsToModel

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

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

Parameters:

arguments - - the Thymeleaf Processor arguments

element - - the Thymeleaf Processor element

Returns:

- ExtensionResultStatusType

addExtensionFieldDeepLink

public org.broadleafcommerce.common.extension.ExtensionResultStatusType addExtensionFieldDeepLink(List<org.broadleafcommerce.common.web.deeplink.DeepLink> links,
                                                                                         org.thymeleaf.Arguments arguments,
                                                                                         org.thymeleaf.dom.Element element)

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