org.broadleafcommerce.cms.structure.service

Interface StructuredContentServiceExtensionHandler

All Superinterfaces:

org.broadleafcommerce.common.extension.ExtensionHandler

All Known Implementing Classes:

AbstractStructuredContentServiceExtensionHandler

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

Extension handler for the StructuredContentService

Author:

Phillip Verheyden (phillipuniverse)

Method Summary

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

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

getPriority, isEnabled

Method Detail

populateAdditionalStructuredContentFields

org.broadleafcommerce.common.extension.ExtensionResultStatusType populateAdditionalStructuredContentFields(StructuredContent sc,
                                                                                                           org.broadleafcommerce.common.structure.dto.StructuredContentDTO dto,
                                                                                                           boolean secure)

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.

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

org.broadleafcommerce.common.extension.ExtensionResultStatusType modifyStructuredContentDtoList(List<org.broadleafcommerce.common.structure.dto.StructuredContentDTO> structuredContentList,
                                                                                                org.broadleafcommerce.common.extension.ExtensionResultHolder resultHolder)

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.

Parameters:

structuredContentList -

resultHolder -

Returns: