org.broadleafcommerce.cms.structure.service
Interface StructuredContentServiceExtensionHandler

All Superinterfaces:

ExtensionHandler

public interface StructuredContentServiceExtensionHandler
extends ExtensionHandler

Extension handler for the StructuredContentService

Author:

Phillip Verheyden (phillipuniverse)

Method Summary

ExtensionResultStatusType

populateAdditionalStructuredContentFields(StructuredContent sc, 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

ExtensionResultStatusType populateAdditionalStructuredContentFields(StructuredContent sc,
                                                                    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)}