Package org.broadleafcommerce.cms.page.service

Interface PageServiceExtensionHandler

All Superinterfaces:

org.broadleafcommerce.common.extension.ExtensionHandler

All Known Implementing Classes:

AbstractPageServiceExtensionHandler

public interface PageServiceExtensionHandler
extends org.broadleafcommerce.common.extension.ExtensionHandler

Extension handler for PageService

Author:

Andre Azzolini (apazzolini)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IS_KEY

Method Summary

Modifier and Type	Method	Description
org.broadleafcommerce.common.extension.ExtensionResultStatusType	getFieldDefinition(org.broadleafcommerce.common.extension.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.
org.broadleafcommerce.common.extension.ExtensionResultStatusType	overridePageDto(org.broadleafcommerce.common.extension.ExtensionResultHolder<org.broadleafcommerce.common.page.dto.PageDTO> erh, org.broadleafcommerce.common.page.dto.PageDTO pageDto, Page page)	This method provides the opportunity to modify the page fields associated with the pageDto ExtensionResultHolder.

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

getPriority, isEnabled

Field Details

IS_KEY

static final String IS_KEY

See Also:

• Constant Field Values

Method Details

getFieldDefinition

org.broadleafcommerce.common.extension.ExtensionResultStatusType getFieldDefinition(org.broadleafcommerce.common.extension.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.

Parameters:

erh -

page -

fieldKey -

Returns:

overridePageDto

org.broadleafcommerce.common.extension.ExtensionResultStatusType overridePageDto(org.broadleafcommerce.common.extension.ExtensionResultHolder<org.broadleafcommerce.common.page.dto.PageDTO> erh,
 org.broadleafcommerce.common.page.dto.PageDTO pageDto,
 Page page)

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

Parameters:

erh -

pageDto -

page -

Returns: