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 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. 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.

      • getAllComponents

        SearchPageData<AbstractCMSComponentData> getAllComponents​(java.lang.String categoryCode,
                                                          java.lang.String productCode,
                                                          java.lang.String catalogCode,
                                                          SearchPageData searchPageData)
        Returns the list of all AbstractCMSComponentData found in SearchPageData. The result is restricted by categoryCode or productCode or catalogCode.
        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.