Package de.hybris.platform.cmsfacades.rendering

Interface ComponentRenderingService

All Known Implementing Classes:

DefaultComponentRenderingService

public interface ComponentRenderingService

Interface responsible for retrieving components for rendering purposes.

Method Summary

Modifier and Type	Method	Description
SearchPageData<AbstractCMSComponentData>	getAllComponents(String categoryCode, String productCode, String catalogCode, SearchPageData searchPageData)	Returns the list of all AbstractCMSComponentData found in SearchPageData.
AbstractCMSComponentData	getComponentById(String componentId, String categoryCode, String productCode, String catalogCode)	Returns the AbstractCMSComponentData object by component id restricted by categoryCode or productCode or catalogCode.
SearchPageData<AbstractCMSComponentData>	getComponentsByIds(Collection<String> componentIds, String categoryCode, String productCode, String catalogCode, SearchPageData searchPageData)	Returns the list of found AbstractCMSComponentData in SearchPageData.

Method Details

getComponentById

AbstractCMSComponentData getComponentById(String componentId,
 String categoryCode,
 String productCode,
 String catalogCode)
                                   throws CMSItemNotFoundException

Returns the AbstractCMSComponentData object by component id restricted by categoryCode or productCode or catalogCode. The result of the method is retrieved from the cache if the RenderingCacheService is enabled.

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

SearchPageData<AbstractCMSComponentData> getComponentsByIds(Collection<String> componentIds,
 String categoryCode,
 String productCode,
 String catalogCode,
 SearchPageData searchPageData)

Returns the list of found AbstractCMSComponentData in SearchPageData. The result is restricted by categoryCode or productCode or catalogCode. The result of the method is retrieved from the cache if the RenderingCacheService is enabled.

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.

getAllComponents

SearchPageData<AbstractCMSComponentData> getAllComponents(String categoryCode,
 String productCode,
 String catalogCode,
 SearchPageData searchPageData)

Returns the list of all AbstractCMSComponentData found in SearchPageData. The result is restricted by categoryCode or productCode or catalogCode. The result of the method is retrieved from the cache if the RenderingCacheService is enabled.

Parameters:

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.