Interface ComponentTypeFacade

All Known Implementing Classes:
DefaultComponentTypeFacade

public interface ComponentTypeFacade
Facade for getting CMS component type information about available types and their attributes.
  • Method Details

    • getAllComponentTypes

      @Deprecated(since="1905", forRemoval=true) 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) List<ComponentTypeData> getAllComponentTypes(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
    • getComponentTypeByCode

      @Deprecated(since="1905", forRemoval=true) ComponentTypeData getComponentTypeByCode(String code) throws ComponentTypeNotFoundException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get a single cms component type.
      Parameters:
      code - - the type code of the component type to retrieve
      Returns:
      the cms component type
      Throws:
      ComponentTypeNotFoundException - when the code provided does not match any existing types
    • getComponentTypeByCodeAndMode

      @Deprecated(since="1905", forRemoval=true) ComponentTypeData getComponentTypeByCodeAndMode(String code, String mode) throws ComponentTypeNotFoundException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

      List<ComponentTypeData> getAllCmsItemTypes(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(String code, 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.
      readOnly - - define if read only node for attributes
      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
    • getAllComponentTypesForPage

      default SearchResult<ComponentTypeData> getAllComponentTypesForPage(CMSComponentTypesForPageSearchData searchData, PageableData pageableData) throws CMSItemNotFoundException
      A paged Search for ComponentTypes that are valid to be used in a given page. Optionally filter by name/type code.
      Parameters:
      searchData - - The page and filter data
      pageableData - - The paging information
      Returns:
      A SearchResult containing the paging information and the results
      Throws:
      CMSItemNotFoundException - When the expected page is not found.