Package org.broadleafcommerce.cms.page.service

Class AbstractPageServiceExtensionHandler

java.lang.Object

org.broadleafcommerce.common.extension.AbstractExtensionHandler

org.broadleafcommerce.cms.page.service.AbstractPageServiceExtensionHandler

All Implemented Interfaces:

PageServiceExtensionHandler, ExtensionHandler

public abstract class AbstractPageServiceExtensionHandler
extends AbstractExtensionHandler
implements PageServiceExtensionHandler

Author:

Andre Azzolini (apazzolini)

Field Summary

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

enabled, priority

Fields inherited from interface org.broadleafcommerce.cms.page.service.PageServiceExtensionHandler

IS_KEY

Constructor Summary

Constructors

Constructor	Description
AbstractPageServiceExtensionHandler()

Method Summary

Modifier and Type	Method	Description
ExtensionResultStatusType	getFieldDefinition(ExtensionResultHolder<FieldDefinition> erh, Page page, String fieldKey)	If this method returns something other than ExtensionResultStatusType.NOT_HANDLED, the result variable in the ExtensionResultHolder will hold the associated FieldDefinition for the given Page and field key.
ExtensionResultStatusType	overridePageDto(ExtensionResultHolder<PageDTO> erh, PageDTO pageDto, Page page)	This method provides the opportunity to modify the page fields associated with the pageDto ExtensionResultHolder.

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

AbstractPageServiceExtensionHandler

public AbstractPageServiceExtensionHandler()

Method Details

getFieldDefinition

public ExtensionResultStatusType getFieldDefinition(ExtensionResultHolder<FieldDefinition> erh,
 Page page,
 String fieldKey)

Description copied from interface: PageServiceExtensionHandler

If this method returns something other than ExtensionResultStatusType.NOT_HANDLED, the result variable in the ExtensionResultHolder will hold the associated FieldDefinition for the given Page and field key.

Specified by:

getFieldDefinition in interface PageServiceExtensionHandler

Returns:

overridePageDto

public ExtensionResultStatusType overridePageDto(ExtensionResultHolder<PageDTO> erh,
 PageDTO pageDto,
 Page page)

Description copied from interface: PageServiceExtensionHandler

This method provides the opportunity to modify the page fields associated with the pageDto ExtensionResultHolder. Modifying classes should clone the DTO and adjust fields.

Specified by:

overridePageDto in interface PageServiceExtensionHandler

Returns: