org.broadleafcommerce.core.web.breadcrumbs

Class AbstractBreadcrumbServiceExtensionHandler

java.lang.Object

org.broadleafcommerce.core.web.breadcrumbs.AbstractBreadcrumbServiceExtensionHandler

All Implemented Interfaces:

BreadcrumbServiceExtensionHandler, ExtensionHandler

Direct Known Subclasses:

CategoryBreadcrumbServiceExtensionHandler, HomePageBreadcrumbServiceExtensionHandler, ProductBreadcrumbServiceExtensionHandler, SimpleSearchBreadcrumbServiceExtensionHandler

public abstract class AbstractBreadcrumbServiceExtensionHandler
extends Object
implements ExtensionHandler, BreadcrumbServiceExtensionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	enabled
protected Integer	priority

Constructor Summary

Constructors

Constructor and Description
AbstractBreadcrumbServiceExtensionHandler()

Method Summary

Methods

Modifier and Type	Method and Description
String	buildLink(String url, Map<String,String[]> params)
abstract int	getDefaultPriority() Implementations must provide a priority for this extension handler as the order determines the breadcrumb order.
int	getPriority() Determines the priority of this extension handler.
boolean	isEnabled() If false, the ExtensionManager should skip this Handler.
ExtensionResultStatusType	modifyBreadcrumbList(String url, Map<String,String[]> params, ExtensionResultHolder<List<BreadcrumbDTO>> holder)
void	setEnabled(boolean enabled)
void	setPriority(Integer priority)

Methods inherited from class java.lang.Object

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

Field Detail

priority

protected Integer priority

enabled

protected boolean enabled

Constructor Detail

AbstractBreadcrumbServiceExtensionHandler

public AbstractBreadcrumbServiceExtensionHandler()

Method Detail

modifyBreadcrumbList

public ExtensionResultStatusType modifyBreadcrumbList(String url,
                                             Map<String,String[]> params,
                                             ExtensionResultHolder<List<BreadcrumbDTO>> holder)

Specified by:

modifyBreadcrumbList in interface BreadcrumbServiceExtensionHandler

getPriority

public int getPriority()

Description copied from interface: ExtensionHandler

Determines the priority of this extension handler.

Specified by:

getPriority in interface ExtensionHandler

Returns:

setPriority

public void setPriority(Integer priority)

buildLink

public String buildLink(String url,
               Map<String,String[]> params)

isEnabled

public boolean isEnabled()

Description copied from interface: ExtensionHandler

If false, the ExtensionManager should skip this Handler.

Specified by:

isEnabled in interface ExtensionHandler

Returns:

setEnabled

public void setEnabled(boolean enabled)

getDefaultPriority

public abstract int getDefaultPriority()

Implementations must provide a priority for this extension handler as the order determines the breadcrumb order.

Returns: