Package de.hybris.platform.cmsfacades.items

Interface ComponentItemFacade

All Known Implementing Classes:

DefaultComponentItemFacade

public interface ComponentItemFacade

Component facade interface which deals with methods related to component operations.

Method Summary

Modifier and Type	Method	Description
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.
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.

Method Detail

getComponentById

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

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

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(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. When componentIds is empty, this method search for all components instead. The result is restricted by categoryCode or productCode or catalogCode.

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.