de.hybris.platform.cmsfacades.rendering.impl

Class DefaultComponentRenderingService

java.lang.Object

de.hybris.platform.cmsfacades.rendering.impl.DefaultComponentRenderingService

All Implemented Interfaces:

ComponentRenderingService

public class DefaultComponentRenderingService
extends java.lang.Object
implements ComponentRenderingService

Default implementation of ComponentRenderingService.

Constructor Summary

Constructors

Constructor and Description
DefaultComponentRenderingService()

Method Summary

Modifier and Type	Method and Description
protected CMSComponentService	getCmsComponentService()
protected CMSDataFactory	getCmsDataFactory()
AbstractCMSComponentData	getComponentById(java.lang.String componentId, java.lang.String categoryCode, java.lang.String productCode, java.lang.String catalogCode) Returns the AbstractCMSComponentData object by component id restricted by categoryCode or productCode or catalogCode.
protected java.util.Optional<AbstractCMSComponentData>	getComponentData(AbstractCMSComponentModel componentModel, RestrictionData restrictionData) Returns the AbstractCMSComponentData dto based on AbstractCMSComponentModel and RestrictionData.
protected Converter<AbstractCMSComponentModel,AbstractCMSComponentData>	getComponentRenderingConverter()
SearchPageData<AbstractCMSComponentData>	getComponentsByIds(java.util.Collection<java.lang.String> componentIds, java.lang.String categoryCode, java.lang.String productCode, java.lang.String catalogCode, SearchPageData searchPageData) Returns the list of found AbstractCMSComponentData in SearchPageData.
protected SearchPageData<AbstractCMSComponentData>	getComponentsData(SearchPageData<AbstractCMSComponentModel> componentsSearchData, RestrictionData restrictionData) Returns the list of found AbstractCMSComponentData in SearchPageData based on RestrictionData object.
protected FacadeValidationService	getFacadeValidationService()
protected Validator	getRenderingComponentValidator()
protected RenderingVisibilityService	getRenderingVisibilityService()
protected RestrictionAwareService	getRestrictionAwareService()
void	setCmsComponentService(CMSComponentService cmsComponentService)
void	setCmsDataFactory(CMSDataFactory cmsDataFactory)
void	setComponentRenderingConverter(Converter<AbstractCMSComponentModel,AbstractCMSComponentData> componentRenderingConverter)
void	setFacadeValidationService(FacadeValidationService facadeValidationService)
void	setRenderingComponentValidator(Validator renderingComponentValidator)
void	setRenderingVisibilityService(RenderingVisibilityService renderingVisibilityService)
void	setRestrictionAwareService(RestrictionAwareService restrictionAwareService)
protected void	validateParameters(java.lang.String categoryCode, java.lang.String productCode, java.lang.String catalogCode)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultComponentRenderingService

public DefaultComponentRenderingService()

Method Detail

getComponentById

public AbstractCMSComponentData getComponentById(java.lang.String componentId,
                                                 java.lang.String categoryCode,
                                                 java.lang.String productCode,
                                                 java.lang.String catalogCode)
                                          throws CMSItemNotFoundException

Description copied from interface: ComponentRenderingService

Returns the AbstractCMSComponentData object by component id restricted by categoryCode or productCode or catalogCode.

Specified by:

getComponentById in interface ComponentRenderingService

Parameters:

componentId - the component id

categoryCode - the optional category code

productCode - the optional product code

catalogCode - the optional catalog code

Returns:

the AbstractCMSComponentData object

Throws:

CMSItemNotFoundException - if the component is restricted or not visible.

getComponentsByIds

public SearchPageData<AbstractCMSComponentData> getComponentsByIds(java.util.Collection<java.lang.String> componentIds,
                                                                   java.lang.String categoryCode,
                                                                   java.lang.String productCode,
                                                                   java.lang.String catalogCode,
                                                                   SearchPageData searchPageData)

Description copied from interface: ComponentRenderingService

Returns the list of found AbstractCMSComponentData in SearchPageData. The result is restricted by categoryCode or productCode or catalogCode.

Specified by:

getComponentsByIds in interface ComponentRenderingService

Parameters:

componentIds - the list of component id

categoryCode - the optional category code

productCode - the optional product code

catalogCode - the optional catalog code

searchPageData - the searchPageData contains requested pagination and sorting information

Returns:

the list of found AbstractCMSComponentData in SearchPageData. If nothing is found the empty list is returned.

validateParameters

protected void validateParameters(java.lang.String categoryCode,
                                  java.lang.String productCode,
                                  java.lang.String catalogCode)

getComponentsData

protected SearchPageData<AbstractCMSComponentData> getComponentsData(SearchPageData<AbstractCMSComponentModel> componentsSearchData,
                                                                     RestrictionData restrictionData)

Returns the list of found AbstractCMSComponentData in SearchPageData based on RestrictionData object. If nothing is found then the empty list is returned.

Parameters:

componentsSearchData -

restrictionData -

Returns:

the list of found AbstractCMSComponentData in SearchPageData.

getComponentData

protected java.util.Optional<AbstractCMSComponentData> getComponentData(AbstractCMSComponentModel componentModel,
                                                                        RestrictionData restrictionData)

Returns the AbstractCMSComponentData dto based on AbstractCMSComponentModel and RestrictionData. When the component is not visible based on the restriction, an empty Optional is returned.

Parameters:

componentModel - the AbstractCMSComponentModel object.

restrictionData - the RestrictionData object determining whether the component is visible or not.

Returns:

the Optional of AbstractCMSComponentData object; return Optional#empty() when the component is not visible

getCmsDataFactory

protected CMSDataFactory getCmsDataFactory()

setCmsDataFactory

public void setCmsDataFactory(CMSDataFactory cmsDataFactory)

getCmsComponentService

protected CMSComponentService getCmsComponentService()

setCmsComponentService

public void setCmsComponentService(CMSComponentService cmsComponentService)

getComponentRenderingConverter

protected Converter<AbstractCMSComponentModel,AbstractCMSComponentData> getComponentRenderingConverter()

setComponentRenderingConverter

public void setComponentRenderingConverter(Converter<AbstractCMSComponentModel,AbstractCMSComponentData> componentRenderingConverter)

getRestrictionAwareService

protected RestrictionAwareService getRestrictionAwareService()

setRestrictionAwareService

public void setRestrictionAwareService(RestrictionAwareService restrictionAwareService)

getFacadeValidationService

protected FacadeValidationService getFacadeValidationService()

setFacadeValidationService

public void setFacadeValidationService(FacadeValidationService facadeValidationService)

getRenderingComponentValidator

protected Validator getRenderingComponentValidator()

setRenderingComponentValidator

public void setRenderingComponentValidator(Validator renderingComponentValidator)

getRenderingVisibilityService

protected RenderingVisibilityService getRenderingVisibilityService()

setRenderingVisibilityService

public void setRenderingVisibilityService(RenderingVisibilityService renderingVisibilityService)