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 TypeMethodDescriptiongetComponentById(String componentId, String categoryCode, String productCode, String catalogCode) Returns theAbstractCMSComponentDataobject by component id restricted by categoryCode or productCode or catalogCode.getComponentsByIds(Collection<String> componentIds, String categoryCode, String productCode, String catalogCode, SearchPageData searchPageData) Returns the list of foundAbstractCMSComponentDatainSearchPageData.
-
Method Details
-
getComponentById
AbstractCMSComponentData getComponentById(String componentId, String categoryCode, String productCode, String catalogCode) throws CMSItemNotFoundException Returns theAbstractCMSComponentDataobject by component id restricted by categoryCode or productCode or catalogCode.- Parameters:
componentId- the component idcategoryCode- the optional category codeproductCode- the optional product codecatalogCode- the optional catalog code- Returns:
- the
AbstractCMSComponentDataobject - 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 foundAbstractCMSComponentDatainSearchPageData. WhencomponentIdsis empty, this method search for all components instead. The result is restricted by categoryCode or productCode or catalogCode.- Parameters:
componentIds- the list of component idcategoryCode- the optional category codeproductCode- the optional product codecatalogCode- the optional catalog codesearchPageData- the searchPageData contains requested pagination and sorting information- Returns:
- the list of found
AbstractCMSComponentDatainSearchPageData. If nothing is found the empty list is returned.
-