Package de.hybris.platform.cmsfacades.types

Interface ComponentTypeFacade

  • All Known Implementing Classes:
    DefaultComponentTypeFacade
    public interface ComponentTypeFacade
    Facade for getting CMS component type information about available types and their attributes.

    • Method Detail

      • getAllComponentTypes

        @Deprecated(since="1905",
            forRemoval=true)
java.util.List<ComponentTypeData> getAllComponentTypes()
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 1905, please use getAllCmsItemTypes(List, boolean)
        Find all cms component types. This does not include abstract component types nor action component types.
        Returns:
        list of component types; never null

      • getAllComponentTypes

        @Deprecated(since="1905",
            forRemoval=true)
java.util.List<ComponentTypeData> getAllComponentTypes​(java.lang.String category)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 1905, please use getAllCmsItemTypes(List, boolean)
        Find all component types by category. This does not include abstract component types nor action component types.
        Parameters:
        category - - the category of the component type to retrieve
        Returns:
        list of types; never null

      • getComponentTypeByCodeAndMode

        @Deprecated(since="1905",
            forRemoval=true)
ComponentTypeData getComponentTypeByCodeAndMode​(java.lang.String code,
                                                java.lang.String mode)
                                         throws ComponentTypeNotFoundException
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 1905, please use getCmsItemTypeByCodeAndMode(String, String, boolean)
        Get a single component type structure for a given structure type mode.
        Parameters:
        code - - the type code of the component type to retrieve
        mode - - the mode of the structure type
        Returns:
        the component type structure or null when the code and mode provided do not match any existing types
        Throws:
        ComponentTypeNotFoundException - when the code provided does not match any existing types

      • getAllCmsItemTypes

        java.util.List<ComponentTypeData> getAllCmsItemTypes​(java.util.List<StructureTypeCategory> categories,
                                                     boolean readOnly)
        Find all cms item types by category. This does not include abstract component types nor action component types.
        Parameters:
        categories - - the list of categories for the cms item type to retrieve
        readOnly - - make all attributes read only (editable=false)
        Returns:
        list of types; never null. Empty result is returned if the list of categories is empty.

      • getCmsItemTypeByCodeAndMode

        ComponentTypeData getCmsItemTypeByCodeAndMode​(java.lang.String code,
                                              java.lang.String mode,
                                              boolean readOnly)
                                       throws ComponentTypeNotFoundException
        Get a single cms item type structure.
        Parameters:
        code - - the type code of the cms item type to retrieve
        mode - - the optional mode of the structure type, can be null.
        Returns:
        the cms item type structure or null when the code and mode provided do not match any existing types
        Throws:
        ComponentTypeNotFoundException - when the code provided does not match any existing types