org.broadleafcommerce.cms.structure.service

Class AbstractStructuredContentServiceExtensionHandler

java.lang.Object

org.broadleafcommerce.common.extension.AbstractExtensionHandler

org.broadleafcommerce.cms.structure.service.AbstractStructuredContentServiceExtensionHandler

All Implemented Interfaces:

StructuredContentServiceExtensionHandler, ExtensionHandler

public class AbstractStructuredContentServiceExtensionHandler
extends AbstractExtensionHandler
implements StructuredContentServiceExtensionHandler

Extension handler for the StructuredContentService

Author:

bpolster

Field Summary

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

enabled, priority

Constructor Summary

Constructors

Constructor and Description
AbstractStructuredContentServiceExtensionHandler()

Method Summary

Modifier and Type	Method and Description
ExtensionResultStatusType	modifyStructuredContentDtoList(List<StructuredContentDTO> structuredContentList, ExtensionResultHolder resultHolder) Allows an extension handler to modify the list of structured content items.
ExtensionResultStatusType	populateAdditionalStructuredContentFields(StructuredContent sc, StructuredContentDTO dto, boolean secure) Further modifies the fields when parsing a StructuredContent into a StructuredContentDTO.

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

AbstractStructuredContentServiceExtensionHandler

public AbstractStructuredContentServiceExtensionHandler()

Method Detail

populateAdditionalStructuredContentFields

public ExtensionResultStatusType populateAdditionalStructuredContentFields(StructuredContent sc,
                                                                           StructuredContentDTO dto,
                                                                           boolean secure)

Description copied from interface: StructuredContentServiceExtensionHandler

Further modifies the fields when parsing a StructuredContent into a StructuredContentDTO. This method will be invoked at the end of StructuredContentServiceImpl.buildFieldValues(StructuredContent, StructuredContentDTO, boolean). Note that even though this method should return an ExtensionResultStatusType, modifications should be made to the StructuredContentDTO by using information from the StructuredContent.

Specified by:

populateAdditionalStructuredContentFields in interface StructuredContentServiceExtensionHandler

Parameters:

sc - the StructuredContent that should further be wrapped into the dto

dto - the DTO that has already been mostly populated by Broadleaf. At this stage, this parameter will have all of the properties from the default StructuredContentDTO already parsed

secure - whether or not the request is secure

Returns:

the result of executing this extension handler

See Also:

StructuredContentServiceImpl#buildFieldValues(StructuredContent, StructuredContentDTO, boolean)}, StructuredContentServiceImpl#buildStructuredContentDTO(StructuredContent, boolean)}

modifyStructuredContentDtoList

public ExtensionResultStatusType modifyStructuredContentDtoList(List<StructuredContentDTO> structuredContentList,
                                                                ExtensionResultHolder resultHolder)

Description copied from interface: StructuredContentServiceExtensionHandler

Allows an extension handler to modify the list of structured content items. For example to alter the order of the passed in list. The ExtensionResultHolder if non null should contain a replacement list to use.

Specified by:

modifyStructuredContentDtoList in interface StructuredContentServiceExtensionHandler

Returns: